IAppServicePlansOperations.RestartWebAppsWithHttpMessagesAsync(String, String, Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken) Method

Definition

Restart all apps in an App Service plan.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> RestartWebAppsWithHttpMessagesAsync (string resourceGroupName, string name, bool? softRestart = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member RestartWebAppsWithHttpMessagesAsync : string * string * 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 RestartWebAppsWithHttpMessagesAsync (resourceGroupName As String, name As String, Optional softRestart 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
System.String

Name of the resource group to which the resource belongs.

name
System.String

Name of the App Service plan.

softRestart
System.Nullable<System.Boolean>

Specify <code>true</code> to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is <code>false</code>, which always restarts and reprovisions the apps

customHeaders
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>

The headers that will be added to request.

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<AzureOperationResponse>

Exceptions

Thrown when the operation returned an invalid status code

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Remarks

Description for Restart all apps in an App Service plan.

Applies to