Class WebDeploySettingsExtensions

Used within WebDeployTasks.

Inheritance
System.Object
WebDeploySettingsExtensions
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Nuke.WebDeploy
Assembly: Nuke.WebDeploy.dll
Syntax
[PublicAPI]
public static class WebDeploySettingsExtensions

Methods

| Improve this Doc View Source

AddParameter(WebDeploySettings, String, String)

Adds a new key-value-pair Parameters.

Additional web deploy sync parameters.

Declaration
[Pure]
public static WebDeploySettings AddParameter(this WebDeploySettings toolSettings, string parameterKey, string parameterValue)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.String parameterKey
System.String parameterValue
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ClearParameters(WebDeploySettings)

Clears Parameters.

Additional web deploy sync parameters.

Declaration
[Pure]
public static WebDeploySettings ClearParameters(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

DisableEnableAppOfflineRule(WebDeploySettings)

Disables EnableAppOfflineRule.

Toggles enabling of the AppOfflineRule. If enabled, WebDeploy will create a file called App_Offline.htm before copying the content and remove it afterwards. This makes IIS suspend the site during the deployment process and frees locked files.

Declaration
[Pure]
public static WebDeploySettings DisableEnableAppOfflineRule(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

DisableEnableDoNotDeleteRule(WebDeploySettings)

Disables EnableDoNotDeleteRule.

Toggles enabling of the DoNotDelete rule

Declaration
[Pure]
public static WebDeploySettings DisableEnableDoNotDeleteRule(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

DisableShowWhatIf(WebDeploySettings)

Disables ShowWhatIf.

If enabled, no actual operations are performed. The output is still printed to the console to display what would have happened.

Declaration
[Pure]
public static WebDeploySettings DisableShowWhatIf(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

DisableWrapAppOffline(WebDeploySettings)

Disables WrapAppOffline.

Azure Web Apps in IIS are case sensitive and only accept all-lowercase app_offline.htm files. If this is toggled, an appropriately named file is created on the destination before deployment and deleted afterwards.

Declaration
[Pure]
public static WebDeploySettings DisableWrapAppOffline(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

EnableEnableAppOfflineRule(WebDeploySettings)

Enables EnableAppOfflineRule.

Toggles enabling of the AppOfflineRule. If enabled, WebDeploy will create a file called App_Offline.htm before copying the content and remove it afterwards. This makes IIS suspend the site during the deployment process and frees locked files.

Declaration
[Pure]
public static WebDeploySettings EnableEnableAppOfflineRule(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

EnableEnableDoNotDeleteRule(WebDeploySettings)

Enables EnableDoNotDeleteRule.

Toggles enabling of the DoNotDelete rule

Declaration
[Pure]
public static WebDeploySettings EnableEnableDoNotDeleteRule(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

EnableShowWhatIf(WebDeploySettings)

Enables ShowWhatIf.

If enabled, no actual operations are performed. The output is still printed to the console to display what would have happened.

Declaration
[Pure]
public static WebDeploySettings EnableShowWhatIf(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

EnableWrapAppOffline(WebDeploySettings)

Enables WrapAppOffline.

Azure Web Apps in IIS are case sensitive and only accept all-lowercase app_offline.htm files. If this is toggled, an appropriately named file is created on the destination before deployment and deleted afterwards.

Declaration
[Pure]
public static WebDeploySettings EnableWrapAppOffline(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

RemoveParameter(WebDeploySettings, String)

Removes a key-value-pair from Parameters.

Additional web deploy sync parameters.

Declaration
[Pure]
public static WebDeploySettings RemoveParameter(this WebDeploySettings toolSettings, string parameterKey)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.String parameterKey
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ResetAppOfflineHtmlTemplate(WebDeploySettings)

Resets AppOfflineHtmlTemplate.

A html string that is used for the content of the App_Offline.htm file. If not specified, a default message is shown.

Declaration
[Pure]
public static WebDeploySettings ResetAppOfflineHtmlTemplate(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ResetEnableAppOfflineRule(WebDeploySettings)

Resets EnableAppOfflineRule.

Toggles enabling of the AppOfflineRule. If enabled, WebDeploy will create a file called App_Offline.htm before copying the content and remove it afterwards. This makes IIS suspend the site during the deployment process and frees locked files.

Declaration
[Pure]
public static WebDeploySettings ResetEnableAppOfflineRule(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ResetEnableDoNotDeleteRule(WebDeploySettings)

Resets EnableDoNotDeleteRule.

Toggles enabling of the DoNotDelete rule

Declaration
[Pure]
public static WebDeploySettings ResetEnableDoNotDeleteRule(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ResetPassword(WebDeploySettings)

Resets Password.

The password used for the deployment via http basic authentication

Declaration
[Pure]
public static WebDeploySettings ResetPassword(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ResetPublishUrl(WebDeploySettings)

Resets PublishUrl.

The PublishUrl should include the site parameter, e.g.: https://appname.scm.azurewebsites.net:443/msdeploy.axd?site=appname

Declaration
[Pure]
public static WebDeploySettings ResetPublishUrl(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ResetRetryAttempts(WebDeploySettings)

Resets RetryAttempts.

Count of retry attempts to perform before giving up. This is useful when sites take a few moments to spin down and release locked files.

Declaration
[Pure]
public static WebDeploySettings ResetRetryAttempts(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ResetRetryInterval(WebDeploySettings)

Resets RetryInterval.

Delay in milliseconds between retry attempts.

Declaration
[Pure]
public static WebDeploySettings ResetRetryInterval(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ResetShowWhatIf(WebDeploySettings)

Resets ShowWhatIf.

If enabled, no actual operations are performed. The output is still printed to the console to display what would have happened.

Declaration
[Pure]
public static WebDeploySettings ResetShowWhatIf(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ResetSiteName(WebDeploySettings)

Resets SiteName.

The name of the site for web deploy.

Declaration
[Pure]
public static WebDeploySettings ResetSiteName(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ResetSourcePath(WebDeploySettings)

Resets SourcePath.

The source folder that should be synced to, e.g. the local publish folder.

Declaration
[Pure]
public static WebDeploySettings ResetSourcePath(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ResetUsername(WebDeploySettings)

Resets Username.

The username used for the deployment via http basic authentication

Declaration
[Pure]
public static WebDeploySettings ResetUsername(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ResetWrapAppOffline(WebDeploySettings)

Resets WrapAppOffline.

Azure Web Apps in IIS are case sensitive and only accept all-lowercase app_offline.htm files. If this is toggled, an appropriately named file is created on the destination before deployment and deleted afterwards.

Declaration
[Pure]
public static WebDeploySettings ResetWrapAppOffline(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetAppOfflineHtmlTemplate(WebDeploySettings, String)

Sets AppOfflineHtmlTemplate.

A html string that is used for the content of the App_Offline.htm file. If not specified, a default message is shown.

Declaration
[Pure]
public static WebDeploySettings SetAppOfflineHtmlTemplate(this WebDeploySettings toolSettings, string appOfflineHtmlTemplate)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.String appOfflineHtmlTemplate
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetEnableAppOfflineRule(WebDeploySettings, Nullable<Boolean>)

Sets EnableAppOfflineRule.

Toggles enabling of the AppOfflineRule. If enabled, WebDeploy will create a file called App_Offline.htm before copying the content and remove it afterwards. This makes IIS suspend the site during the deployment process and frees locked files.

Declaration
[Pure]
public static WebDeploySettings SetEnableAppOfflineRule(this WebDeploySettings toolSettings, bool? enableAppOfflineRule)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.Nullable<System.Boolean> enableAppOfflineRule
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetEnableDoNotDeleteRule(WebDeploySettings, Nullable<Boolean>)

Sets EnableDoNotDeleteRule.

Toggles enabling of the DoNotDelete rule

Declaration
[Pure]
public static WebDeploySettings SetEnableDoNotDeleteRule(this WebDeploySettings toolSettings, bool? enableDoNotDeleteRule)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.Nullable<System.Boolean> enableDoNotDeleteRule
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetParameter(WebDeploySettings, String, String)

Sets a key-value-pair in Parameters.

Additional web deploy sync parameters.

Declaration
[Pure]
public static WebDeploySettings SetParameter(this WebDeploySettings toolSettings, string parameterKey, string parameterValue)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.String parameterKey
System.String parameterValue
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetParameters(WebDeploySettings, IDictionary<String, String>)

Sets Parameters to a new dictionary.

Additional web deploy sync parameters.

Declaration
[Pure]
public static WebDeploySettings SetParameters(this WebDeploySettings toolSettings, IDictionary<string, string> parameters)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.Collections.Generic.IDictionary<System.String, System.String> parameters
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetPassword(WebDeploySettings, String)

Sets Password.

The password used for the deployment via http basic authentication

Declaration
[Pure]
public static WebDeploySettings SetPassword(this WebDeploySettings toolSettings, string password)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.String password
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetPublishUrl(WebDeploySettings, String)

Sets PublishUrl.

The PublishUrl should include the site parameter, e.g.: https://appname.scm.azurewebsites.net:443/msdeploy.axd?site=appname

Declaration
[Pure]
public static WebDeploySettings SetPublishUrl(this WebDeploySettings toolSettings, string publishUrl)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.String publishUrl
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetRetryAttempts(WebDeploySettings, Nullable<Int32>)

Sets RetryAttempts.

Count of retry attempts to perform before giving up. This is useful when sites take a few moments to spin down and release locked files.

Declaration
[Pure]
public static WebDeploySettings SetRetryAttempts(this WebDeploySettings toolSettings, int? retryAttempts)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.Nullable<System.Int32> retryAttempts
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetRetryInterval(WebDeploySettings, Nullable<Int32>)

Sets RetryInterval.

Delay in milliseconds between retry attempts.

Declaration
[Pure]
public static WebDeploySettings SetRetryInterval(this WebDeploySettings toolSettings, int? retryInterval)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.Nullable<System.Int32> retryInterval
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetShowWhatIf(WebDeploySettings, Nullable<Boolean>)

Sets ShowWhatIf.

If enabled, no actual operations are performed. The output is still printed to the console to display what would have happened.

Declaration
[Pure]
public static WebDeploySettings SetShowWhatIf(this WebDeploySettings toolSettings, bool? showWhatIf)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.Nullable<System.Boolean> showWhatIf
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetSiteName(WebDeploySettings, String)

Sets SiteName.

The name of the site for web deploy.

Declaration
[Pure]
public static WebDeploySettings SetSiteName(this WebDeploySettings toolSettings, string siteName)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.String siteName
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetSourcePath(WebDeploySettings, String)

Sets SourcePath.

The source folder that should be synced to, e.g. the local publish folder.

Declaration
[Pure]
public static WebDeploySettings SetSourcePath(this WebDeploySettings toolSettings, string sourcePath)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.String sourcePath
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetUsername(WebDeploySettings, String)

Sets Username.

The username used for the deployment via http basic authentication

Declaration
[Pure]
public static WebDeploySettings SetUsername(this WebDeploySettings toolSettings, string username)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.String username
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

SetWrapAppOffline(WebDeploySettings, Nullable<Boolean>)

Sets WrapAppOffline.

Azure Web Apps in IIS are case sensitive and only accept all-lowercase app_offline.htm files. If this is toggled, an appropriately named file is created on the destination before deployment and deleted afterwards.

Declaration
[Pure]
public static WebDeploySettings SetWrapAppOffline(this WebDeploySettings toolSettings, bool? wrapAppOffline)
Parameters
Type Name Description
WebDeploySettings toolSettings
System.Nullable<System.Boolean> wrapAppOffline
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ToggleEnableAppOfflineRule(WebDeploySettings)

Toggles EnableAppOfflineRule.

Toggles enabling of the AppOfflineRule. If enabled, WebDeploy will create a file called App_Offline.htm before copying the content and remove it afterwards. This makes IIS suspend the site during the deployment process and frees locked files.

Declaration
[Pure]
public static WebDeploySettings ToggleEnableAppOfflineRule(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ToggleEnableDoNotDeleteRule(WebDeploySettings)

Toggles EnableDoNotDeleteRule.

Toggles enabling of the DoNotDelete rule

Declaration
[Pure]
public static WebDeploySettings ToggleEnableDoNotDeleteRule(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ToggleShowWhatIf(WebDeploySettings)

Toggles ShowWhatIf.

If enabled, no actual operations are performed. The output is still printed to the console to display what would have happened.

Declaration
[Pure]
public static WebDeploySettings ToggleShowWhatIf(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings
| Improve this Doc View Source

ToggleWrapAppOffline(WebDeploySettings)

Toggles WrapAppOffline.

Azure Web Apps in IIS are case sensitive and only accept all-lowercase app_offline.htm files. If this is toggled, an appropriately named file is created on the destination before deployment and deleted afterwards.

Declaration
[Pure]
public static WebDeploySettings ToggleWrapAppOffline(this WebDeploySettings toolSettings)
Parameters
Type Name Description
WebDeploySettings toolSettings
Returns
Type Description
WebDeploySettings