Partilhar via


Web Apps - Get Production Site Deployment Status

Gets the deployment status for an app (or deployment slot, if specified).

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus/{deploymentStatusId}?api-version=2024-04-01

URI Parameters

Name In Required Type Description
deploymentStatusId
path True

string

GUID of the deployment operation.

name
path True

string

Name of the app.

resourceGroupName
path True

string

Name of the resource group to which the resource belongs.

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

api-version
query True

string

API Version

Responses

Name Type Description
200 OK

CsmDeploymentStatus

OK

202 Accepted

CsmDeploymentStatus

Operation is in progress.

Other Status Codes

DefaultErrorResponse

App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get Deployment Status

Sample request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/deploymentStatus/eacfd68b-3bbd-4ad9-99c5-98614d89c8e5?api-version=2024-04-01

Sample response

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/deploymentStatus/eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
  "name": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
  "type": "Microsoft.Web/sites/deploymentStatus",
  "properties": {
    "deploymentId": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
    "status": "RuntimeSuccessful",
    "numberOfInstancesInProgress": 0,
    "numberOfInstancesSuccessful": 1,
    "numberOfInstancesFailed": 0,
    "failedInstancesLogs": [],
    "errors": null
  }
}
{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/deploymentStatus/eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
  "name": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
  "type": "Microsoft.Web/sites/deploymentStatus",
  "properties": {
    "deploymentId": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
    "status": "RuntimeStarting",
    "numberOfInstancesInProgress": 1,
    "numberOfInstancesSuccessful": 0,
    "numberOfInstancesFailed": 0,
    "failedInstancesLogs": [],
    "errors": null
  }
}

Definitions

Name Description
CsmDeploymentStatus

Deployment status response payload.

DefaultErrorResponse

App Service error response.

DeploymentBuildStatus

Deployment build status.

Details
Error

Error model.

ErrorEntity

Body of the error response returned from the API.

CsmDeploymentStatus

Deployment status response payload.

Name Type Description
id

string

Resource Id.

kind

string

Kind of resource.

name

string

Resource Name.

properties.deploymentId

string

Deployment operation id.

properties.errors

ErrorEntity[]

List of errors.

properties.failedInstancesLogs

string[]

List of URLs pointing to logs for instances which failed to provision.

properties.numberOfInstancesFailed

integer

Number of site instances failed to provision.

properties.numberOfInstancesInProgress

integer

Number of site instances currently being provisioned.

properties.numberOfInstancesSuccessful

integer

Number of site instances provisioned successfully.

properties.status

DeploymentBuildStatus

Deployment build status.

type

string

Resource type.

DefaultErrorResponse

App Service error response.

Name Type Description
error

Error

Error model.

DeploymentBuildStatus

Deployment build status.

Name Type Description
BuildAborted

string

BuildFailed

string

BuildInProgress

string

BuildPending

string

BuildRequestReceived

string

BuildSuccessful

string

PostBuildRestartRequired

string

RuntimeFailed

string

RuntimeStarting

string

RuntimeSuccessful

string

StartPolling

string

StartPollingWithRestart

string

TimedOut

string

Details

Name Type Description
code

string

Standardized string to programmatically identify the error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

Error

Error model.

Name Type Description
code

string

Standardized string to programmatically identify the error.

details

Details[]

Detailed errors.

innererror

string

More information to debug error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

ErrorEntity

Body of the error response returned from the API.

Name Type Description
code

string

Basic error code.

details

ErrorEntity[]

Error Details.

extendedCode

string

Type of error.

innerErrors

ErrorEntity[]

Inner errors.

message

string

Any details of the error.

messageTemplate

string

Message template.

parameters

string[]

Parameters for the template.

target

string

The error target.