IMsDeployProvider Interface

Summary

contract for an MsDeployProvider
graph BT Type-.->Interface0["IMsDeployArgument"] click Interface0 "/api/Cake.MsDeploy/IMsDeployArgument" Type["IMsDeployProvider"] class Type type-node Implementing0["RecycleAppProvider"]-.->Type click Implementing0 "/api/Cake.MsDeploy.Providers.MsDeployProviders/RecycleAppProvider" Implementing1["ContentPathProvider"]-.->Type click Implementing1 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ContentPathProvider" Implementing2["CreateAppProvider"]-.->Type click Implementing2 "/api/Cake.MsDeploy.Providers.MsDeployProviders/CreateAppProvider" Implementing3["MachineConfig32Provider"]-.->Type click Implementing3 "/api/Cake.MsDeploy.Providers.MsDeployProviders/MachineConfig32Provider" Implementing4["AppPoolConfigProvider"]-.->Type click Implementing4 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppPoolConfigProvider" Implementing5["ContentPathLibProvider"]-.->Type click Implementing5 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ContentPathLibProvider" Implementing6["CertStoreSettingsProvider"]-.->Type click Implementing6 "/api/Cake.MsDeploy.Providers.MsDeployProviders/CertStoreSettingsProvider" Implementing7["BackupSettingsProvider"]-.->Type click Implementing7 "/api/Cake.MsDeploy.Providers.MsDeployProviders/BackupSettingsProvider" Implementing8["AutoProvider"]-.->Type click Implementing8 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AutoProvider" Implementing9["ManifestProvider"]-.->Type click Implementing9 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ManifestProvider" Implementing10["AppHostSchemaProvider"]-.->Type click Implementing10 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppHostSchemaProvider" Implementing11["IisAppProvider"]-.->Type click Implementing11 "/api/Cake.MsDeploy.Providers.MsDeployProviders/IisAppProvider" Implementing12["MsDeployProvider"]-.->Type click Implementing12 "/api/Cake.MsDeploy.Providers/MsDeployProvider" Implementing13["UrlScanConfigProvider"]-.->Type click Implementing13 "/api/Cake.MsDeploy.Providers.MsDeployProviders/UrlScanConfigProvider" Implementing14["AppPoolNetFxProvider"]-.->Type click Implementing14 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppPoolNetFxProvider" Implementing15["ContentPathAspNetCoreProvider"]-.->Type click Implementing15 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ContentPathAspNetCoreProvider" Implementing16["AppPoolPipelineProvider"]-.->Type click Implementing16 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppPoolPipelineProvider" Implementing17["BackupManagerProvider"]-.->Type click Implementing17 "/api/Cake.MsDeploy.Providers.MsDeployProviders/BackupManagerProvider" Implementing18["DbSqliteProvider"]-.->Type click Implementing18 "/api/Cake.MsDeploy.Providers.MsDeployProviders/DbSqliteProvider" Implementing19["FilePathProvider"]-.->Type click Implementing19 "/api/Cake.MsDeploy.Providers.MsDeployProviders/FilePathProvider" Implementing20["MetaKeyProvider"]-.->Type click Implementing20 "/api/Cake.MsDeploy.Providers.MsDeployProviders/MetaKeyProvider" Implementing21["CertProvider"]-.->Type click Implementing21 "/api/Cake.MsDeploy.Providers.MsDeployProviders/CertProvider" Implementing22["DbMySqlProvider"]-.->Type click Implementing22 "/api/Cake.MsDeploy.Providers.MsDeployProviders/DbMySqlProvider" Implementing23["WebServerProvider"]-.->Type click Implementing23 "/api/Cake.MsDeploy.Providers.MsDeployProviders/WebServerProvider" Implementing24["PackageProvider"]-.->Type click Implementing24 "/api/Cake.MsDeploy.Providers.MsDeployProviders/PackageProvider" Implementing25["ArchiveDirProvider"]-.->Type click Implementing25 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ArchiveDirProvider" Implementing26["RootWebConfig32Provider"]-.->Type click Implementing26 "/api/Cake.MsDeploy.Providers.MsDeployProviders/RootWebConfig32Provider" Implementing27["RootWebConfig64Provider"]-.->Type click Implementing27 "/api/Cake.MsDeploy.Providers.MsDeployProviders/RootWebConfig64Provider" Implementing28["CommandProvider"]-.->Type click Implementing28 "/api/Cake.MsDeploy.Providers.MsDeployProviders/CommandProvider" Implementing29["DirPathProvider"]-.->Type click Implementing29 "/api/Cake.MsDeploy.Providers.MsDeployProviders/DirPathProvider" Implementing30["AppHostAuthOverrideProvider"]-.->Type click Implementing30 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppHostAuthOverrideProvider" Implementing31["ComObject64Provider"]-.->Type click Implementing31 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ComObject64Provider" Implementing32["DbFullSqlProvider"]-.->Type click Implementing32 "/api/Cake.MsDeploy.Providers.MsDeployProviders/DbFullSqlProvider" Implementing33["DbDacFxProvider"]-.->Type click Implementing33 "/api/Cake.MsDeploy.Providers.MsDeployProviders/DbDacFxProvider" Implementing34["SetAclProvider"]-.->Type click Implementing34 "/api/Cake.MsDeploy.Providers.MsDeployProviders/SetAclProvider" Implementing35["RunCommandProvider"]-.->Type click Implementing35 "/api/Cake.MsDeploy.Providers.MsDeployProviders/RunCommandProvider" Implementing36["RegKeyProvider"]-.->Type click Implementing36 "/api/Cake.MsDeploy.Providers.MsDeployProviders/RegKeyProvider" Implementing37["AppPoolEnable32BitProvider"]-.->Type click Implementing37 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppPoolEnable32BitProvider" Implementing38["ComObject32Provider"]-.->Type click Implementing38 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ComObject32Provider" Implementing39["RegValueProvider"]-.->Type click Implementing39 "/api/Cake.MsDeploy.Providers.MsDeployProviders/RegValueProvider" Implementing40["GacInstallProvider"]-.->Type click Implementing40 "/api/Cake.MsDeploy.Providers.MsDeployProviders/GacInstallProvider" Implementing41["GacAssemblyProvider"]-.->Type click Implementing41 "/api/Cake.MsDeploy.Providers.MsDeployProviders/GacAssemblyProvider" Implementing42["AppHostConfigProvider"]-.->Type click Implementing42 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppHostConfigProvider" Implementing43["WebServer60Provider"]-.->Type click Implementing43 "/api/Cake.MsDeploy.Providers.MsDeployProviders/WebServer60Provider" Implementing44["MachineConfig64Provider"]-.->Type click Implementing44 "/api/Cake.MsDeploy.Providers.MsDeployProviders/MachineConfig64Provider"

Syntax

public interface IMsDeployProvider : IMsDeployArgument

Properties

Name Value Summary
AuthenticationType Nullable<AuthenticationScheme>
Authentication scheme to use. NTLM is the default setting. If the wmsvc option is specified, then Basic is the default setting.
ComputerName string
Name of remote computer or proxy-URL
Direction Direction
Determines if the Provider is a source or destination
IncludeAcls Nullable<bool>
If true, include ACLs in the operation (applies to the file system, registry, and metabase).
Password string
Password of the user for remote connections (required if using Basic authentication).
Path string
Path of the provider type
PublishSettings string
File path to a publish settings file which contains remote connection information
TempAgent Nullable<bool>
Temporarily install the remote agent for the duration of a remote operation.
Type string
Name of the MSDeploy Provider
Username string
User name to authenticate for remote connections (required if using Basic authentication).
WebManagementService string
Name of remote computer or proxy-URL for the Web Management Service (WMSvc). Assumes that the service is listening on port 8172.

Extension Methods

Name Value Summary
Dump<IMsDeployProvider>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<IMsDeployProvider>(IMsDeployProvider[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<IMsDeployProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<IMsDeployProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<IMsDeployProvider>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<IMsDeployProvider>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin