MsDeployProvider Class

Summary

Base class for a MSDeploy Provider Process specific source or destination information for an MsDeploy provider. Web Deploy Providers
graph BT Type-->Base0["Object"] Type-.->Interface0["IMsDeployProvider"] click Interface0 "/api/Cake.MsDeploy.Providers/IMsDeployProvider" Type-.->Interface1["IMsDeployArgument"] click Interface1 "/api/Cake.MsDeploy/IMsDeployArgument" Type["MsDeployProvider"] class Type type-node Derived0["CertStoreSettingsProvider"]-->Type click Derived0 "/api/Cake.MsDeploy.Providers.MsDeployProviders/CertStoreSettingsProvider" Derived1["DirPathProvider"]-->Type click Derived1 "/api/Cake.MsDeploy.Providers.MsDeployProviders/DirPathProvider" Derived2["RootWebConfig64Provider"]-->Type click Derived2 "/api/Cake.MsDeploy.Providers.MsDeployProviders/RootWebConfig64Provider" Derived3["RecycleAppProvider"]-->Type click Derived3 "/api/Cake.MsDeploy.Providers.MsDeployProviders/RecycleAppProvider" Derived4["MachineConfig32Provider"]-->Type click Derived4 "/api/Cake.MsDeploy.Providers.MsDeployProviders/MachineConfig32Provider" Derived5["WebServerProvider"]-->Type click Derived5 "/api/Cake.MsDeploy.Providers.MsDeployProviders/WebServerProvider" Derived6["IisAppProvider"]-->Type click Derived6 "/api/Cake.MsDeploy.Providers.MsDeployProviders/IisAppProvider" Derived7["ContentPathLibProvider"]-->Type click Derived7 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ContentPathLibProvider" Derived8["PackageProvider"]-->Type click Derived8 "/api/Cake.MsDeploy.Providers.MsDeployProviders/PackageProvider" Derived9["ManifestProvider"]-->Type click Derived9 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ManifestProvider" Derived10["ContentPathAspNetCoreProvider"]-->Type click Derived10 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ContentPathAspNetCoreProvider" Derived11["RegKeyProvider"]-->Type click Derived11 "/api/Cake.MsDeploy.Providers.MsDeployProviders/RegKeyProvider" Derived12["AppPoolEnable32BitProvider"]-->Type click Derived12 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppPoolEnable32BitProvider" Derived13["CertProvider"]-->Type click Derived13 "/api/Cake.MsDeploy.Providers.MsDeployProviders/CertProvider" Derived14["ArchiveDirProvider"]-->Type click Derived14 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ArchiveDirProvider" Derived15["AppPoolConfigProvider"]-->Type click Derived15 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppPoolConfigProvider" Derived16["RegValueProvider"]-->Type click Derived16 "/api/Cake.MsDeploy.Providers.MsDeployProviders/RegValueProvider" Derived17["MachineConfig64Provider"]-->Type click Derived17 "/api/Cake.MsDeploy.Providers.MsDeployProviders/MachineConfig64Provider" Derived18["ComObject32Provider"]-->Type click Derived18 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ComObject32Provider" Derived19["DbDacFxProvider"]-->Type click Derived19 "/api/Cake.MsDeploy.Providers.MsDeployProviders/DbDacFxProvider" Derived20["AppPoolNetFxProvider"]-->Type click Derived20 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppPoolNetFxProvider" Derived21["MetaKeyProvider"]-->Type click Derived21 "/api/Cake.MsDeploy.Providers.MsDeployProviders/MetaKeyProvider" Derived22["ContentPathProvider"]-->Type click Derived22 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ContentPathProvider" Derived23["CreateAppProvider"]-->Type click Derived23 "/api/Cake.MsDeploy.Providers.MsDeployProviders/CreateAppProvider" Derived24["SetAclProvider"]-->Type click Derived24 "/api/Cake.MsDeploy.Providers.MsDeployProviders/SetAclProvider" Derived25["BackupSettingsProvider"]-->Type click Derived25 "/api/Cake.MsDeploy.Providers.MsDeployProviders/BackupSettingsProvider" Derived26["GacInstallProvider"]-->Type click Derived26 "/api/Cake.MsDeploy.Providers.MsDeployProviders/GacInstallProvider" Derived27["AppHostSchemaProvider"]-->Type click Derived27 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppHostSchemaProvider" Derived28["UrlScanConfigProvider"]-->Type click Derived28 "/api/Cake.MsDeploy.Providers.MsDeployProviders/UrlScanConfigProvider" Derived29["RunCommandProvider"]-->Type click Derived29 "/api/Cake.MsDeploy.Providers.MsDeployProviders/RunCommandProvider" Derived30["FilePathProvider"]-->Type click Derived30 "/api/Cake.MsDeploy.Providers.MsDeployProviders/FilePathProvider" Derived31["WebServer60Provider"]-->Type click Derived31 "/api/Cake.MsDeploy.Providers.MsDeployProviders/WebServer60Provider" Derived32["RootWebConfig32Provider"]-->Type click Derived32 "/api/Cake.MsDeploy.Providers.MsDeployProviders/RootWebConfig32Provider" Derived33["BackupManagerProvider"]-->Type click Derived33 "/api/Cake.MsDeploy.Providers.MsDeployProviders/BackupManagerProvider" Derived34["DbFullSqlProvider"]-->Type click Derived34 "/api/Cake.MsDeploy.Providers.MsDeployProviders/DbFullSqlProvider" Derived35["AppHostConfigProvider"]-->Type click Derived35 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppHostConfigProvider" Derived36["AutoProvider"]-->Type click Derived36 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AutoProvider" Derived37["ComObject64Provider"]-->Type click Derived37 "/api/Cake.MsDeploy.Providers.MsDeployProviders/ComObject64Provider" Derived38["DbMySqlProvider"]-->Type click Derived38 "/api/Cake.MsDeploy.Providers.MsDeployProviders/DbMySqlProvider" Derived39["AppPoolPipelineProvider"]-->Type click Derived39 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppPoolPipelineProvider" Derived40["DbSqliteProvider"]-->Type click Derived40 "/api/Cake.MsDeploy.Providers.MsDeployProviders/DbSqliteProvider" Derived41["GacAssemblyProvider"]-->Type click Derived41 "/api/Cake.MsDeploy.Providers.MsDeployProviders/GacAssemblyProvider" Derived42["AppHostAuthOverrideProvider"]-->Type click Derived42 "/api/Cake.MsDeploy.Providers.MsDeployProviders/AppHostAuthOverrideProvider"

Syntax

public abstract class MsDeployProvider : IMsDeployProvider, IMsDeployArgument

Constructors

Name Summary
MsDeployProvider()

Properties

Name Value Summary
AppendQuotesToPath bool
Determines if the Path is surrounded in "quotes"
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
RequirePath bool
Determines if the Path argument is required for the MsDeployProvider
TempAgent Nullable<bool>
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.

Methods

Name Value Summary
AdditionalSettings(StringBuilder) void
Applies additional settings on a per provider basis
AppendCommandLineArgument(StringBuilder) void
Converts the object into its MSDeploy command line equivalent and Appends it to the stringbuilder
ToCommandLineArgument() string
Converts the MSDeploy Provider into its commmand line argument

Extension Methods

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