WebSiteResource.RestartAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.AppService
Assembly:
Azure.ResourceManager.AppService.dll
Package:
Azure.ResourceManager.AppService v1.2.0
Package:
Azure.ResourceManager.AppService v1.3.0-beta.1
Source:
WebSiteResource.cs
Source:
WebSiteResource.cs

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart
  • Operation Id: WebApps_Restart
  • Default Api Version: 2023-12-01
  • Resource: WebSiteResource
public virtual System.Threading.Tasks.Task<Azure.Response> RestartAsync (bool? softRestart = default, bool? synchronous = default, System.Threading.CancellationToken cancellationToken = default);
abstract member RestartAsync : Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.RestartAsync : Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function RestartAsync (Optional softRestart As Nullable(Of Boolean) = Nothing, Optional synchronous As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

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).

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<Response>

Applies to