This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Kudu.Client.

Summary

Represents a client that talks to Kudu rest API.

Assembly: Cake.Kudu.Client.dll
Namespace: Cake.Kudu.Client

graph BT Type["IKuduClient"] class Type type-node

Syntax

public interface IKuduClient

Properties

Name	Value	Summary
Environment	ICakeEnvironment	Gets the Cake environment.
FileSystem	IFileSystem	Gets the Cake context.
HttpClient	HttpClient	Gets the underlying HttpClient used for remote API calls.
Log	ICakeLog	Gets the Cake log.
Settings	KuduClientSettings	Gets the Kudu client settings.

Extension Methods

Name	Value	Summary
Dump<IKuduClient>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
ExecuteCommand(string, string, ProcessArgumentBuilder)	IKuduCommandResult	Executes an arbitrary command line and return its output. From KuduClientCommandExtensions Requires the Cake.Kudu.Client addin
IsIn<IKuduClient>(IKuduClient[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<IKuduClient>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<IKuduClient>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
SettingsDelete(string)	void	Delete setting from appservice. From KuduClientSettingsExtensions Requires the Cake.Kudu.Client addin
SettingsGet()	IReadOnlyDictionary<string, string>	Get settings from appservice. From KuduClientSettingsExtensions Requires the Cake.Kudu.Client addin
SettingsSet(IReadOnlyDictionary<string, string>)	void	Set settings to appservice. From KuduClientSettingsExtensions Requires the Cake.Kudu.Client addin
ThrowIfNull<IKuduClient>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<IKuduClient>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin
VFSCreateDirectory(DirectoryPath)	void	Creates directory on remote path. From KuduClientVFSExtensions Requires the Cake.Kudu.Client addin
VFSDeleteDirectory(DirectoryPath)	void	Deletes remote directory. From KuduClientVFSExtensions Requires the Cake.Kudu.Client addin
VFSDeleteFile(FilePath)	void	Deletes remote file. From KuduClientVFSExtensions Requires the Cake.Kudu.Client addin
VFSDownloadFile(FilePath, FilePath)	void	Downloads remote file locally. From KuduClientVFSExtensions Requires the Cake.Kudu.Client addin
VFSDownloadStream(FilePath)	Stream	Downloads remote file to stream. From KuduClientVFSExtensions Requires the Cake.Kudu.Client addin
VFSDownloadString(FilePath, Encoding)	string	Downloads remote file as string. From KuduClientVFSExtensions Requires the Cake.Kudu.Client addin
VFSList(DirectoryPath)	IKuduVFS	Lists remote resources for a given path. From KuduClientVFSExtensions Requires the Cake.Kudu.Client addin
VFSUploadFile(FilePath, FilePath)	void	Uploads file to remote path. From KuduClientVFSExtensions Requires the Cake.Kudu.Client addin
VFSUploadStream(Stream, FilePath)	void	Uploads stream to remote path. From KuduClientVFSExtensions Requires the Cake.Kudu.Client addin
VFSUploadString(string, FilePath, Encoding)	void	Uploads stream to remote path. From KuduClientVFSExtensions Requires the Cake.Kudu.Client addin
ZipDeployDirectory(DirectoryPath)	void	Deploy local directory to KuduWebsite. From KuduClientZipExtensions Requires the Cake.Kudu.Client addin
ZipDeployFile(FilePath)	void	Deploys zip file to Kudu wesite. From KuduClientZipExtensions Requires the Cake.Kudu.Client addin
ZipDeployStream(Stream)	void	Deploys zip stream Kudu website. From KuduClientZipExtensions Requires the Cake.Kudu.Client addin
ZipDownloadFile(DirectoryPath, FilePath)	void	Downloads remote directory to local zip file. From KuduClientZipExtensions Requires the Cake.Kudu.Client addin
ZipDownloadStream(DirectoryPath)	Stream	Downloads remote directory as zip to stream. From KuduClientZipExtensions Requires the Cake.Kudu.Client addin
ZipRunFromDirectory(DirectoryPath, bool, string, string)	FilePath	Deploy local directory to KuduWebsite as read only Zip file system. From KuduClientZipExtensions Requires the Cake.Kudu.Client addin
ZipRunFromDirectory(DirectoryPath)	FilePath	Deploy local directory to KuduWebsite as read only Zip file system. From KuduClientZipExtensions Requires the Cake.Kudu.Client addin
ZipUploadDirectory(DirectoryPath, DirectoryPath)	void	Uploads zip stream and extracts to remote directory path. From KuduClientZipExtensions Requires the Cake.Kudu.Client addin
ZipUploadFile(FilePath, DirectoryPath)	void	Uploads zip file to expand into remote directory path. From KuduClientZipExtensions Requires the Cake.Kudu.Client addin
ZipUploadStream(Stream, DirectoryPath)	void	Uploads zip stream and extracts to remote directory path. From KuduClientZipExtensions Requires the Cake.Kudu.Client addin

IKuduClient Interface

Summary

Syntax

Properties

Extension Methods