Restart an Azure App Service

The Azure App Service actions let you manage your web apps directly from your workflows.

Restart an App Service

This action restarts an Azure App Service using the Web Apps - Restart - REST API.

Input	Type	Description
`clientId`	String	Required. An Azure Service Principal `clientID`. Must be passed as a secret. See how to register an Azure app.
`clientSecret`	String	Required. An Azure Service Principal `clientSecret`. Must be passed as a secret. See how to register an Azure app.
`tenantId`	String	Required. The Azure tenant identifier. Can be passed as a secret.
`subscriptionId`	String	Required. The Azure subscription identifier (for example, `"12345678-1234-1234-1234-123456789abc"`).
`resourceGroupName`	String	Required. The name of the resource group that contains the app service. For example, `"my-demo-rg"`.
`appServiceName`	String	Required. The name of the app. For example, `"my-web-app"`.
`softRestart`	Boolean	Optional. If `true`, performs a soft restart without recycling the app pool. Default: `false`. By default, the API always restarts and reprovisions the app. For more information, see Azure's Web Apps.
`synchronous`	Boolean	Optional. If `true`, waits for the restart operation to complete before returning. Default: `false`. For more information, see Azure's Web Apps.
`selectors`	List	Optional. A list of selectors used to extract specific values from the response. For example, `[{"name": "statusCode", "expression": ".response.status_code"}]`.

Output	Type	Description
`success`	Boolean	Indicates whether the action succeeded. Returns `true` or `false`.
`errorMessage`	String	Contains the failure reason as a message.
`response`	Object	The Azure API body response. For more information, see the Web Apps.
`asyncResponseUrl`	String	Optional for long running operation. The URL to poll for status.
`finalResponseUrl`	String	Optional for long running operation. The URL that returns the final result once the operation completes.
`retryAfterSeconds`	Integer	Optional for long running operation. The number of seconds to wait before polling the async URL.
`eTag`	String	Optional. Used for concurrency control when updating a resource to avoid overwriting someone else's changes.

name: restartAzureWebService
description: 'This workflow restarts an Azure App Service'
steps:
  - name: azure_appService_restart_1
    type: action
    action: azure.appService.restart
    version: 1
    inputs:
      clientId: ${{ :secrets:azure-client-id }}
      clientSecret: ${{ :secrets:azure-client-secret }}
      tenantId: ${{ :secrets:azure-client-tenant }}
      subscriptionId: "12345678-1234-1234-1234-123456789abc"
      resourceGroupName: "my-resource-group"
      appServiceName: "my-web-app"
      softRestart: true
      synchronous: true
    next: end

Restart an App Service .css-21sua1{background:none;border:none;width:0;padding:0;}

Restart an App Service