IWebAppsOperations.RestartSlotWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.WebSites

Assembly:

Microsoft.Azure.Management.Websites.dll

Package:

Microsoft.Azure.Management.WebSites vD:\a\_work\1\s\dotnet\nue-out\_pacmand4ad3\Microsoft.Azure.Management.Websites.4.0.0

Restarts an app (or deployment slot, if specified).

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> RestartSlotWithHttpMessagesAsync (string resourceGroupName, string name, string slot, bool? softRestart = default, bool? synchronous = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member RestartSlotWithHttpMessagesAsync : string * string * string * Nullable<bool> * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>

Public Function RestartSlotWithHttpMessagesAsync (resourceGroupName As String, name As String, slot As String, Optional softRestart As Nullable(Of Boolean) = Nothing, Optional synchronous As Nullable(Of Boolean) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName

String

Name of the resource group to which the resource belongs.

name

String

Name of the app.

slot

String

Name of the deployment slot. If a slot is not specified, the API will restart the production slot.

softRestart

Nullable<Boolean>

Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.

synchronous

Nullable<Boolean>

Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

DefaultErrorResponseException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null

Remarks

Description for Restarts an app (or deployment slot, if specified).