Web Apps - Get Production Site Deployment Status

Service:: App Service

API Version:: 2025-05-01

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=2025-05-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 minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	CsmDeploymentStatus	Azure operation completed successfully.
202 Accepted	CsmDeploymentStatus	The request has been accepted for processing, but processing has not yet completed. Headers Retry-After: integer
Other Status Codes	DefaultErrorResponse	An unexpected error response.

Name

Type

Description

200 OK

CsmDeploymentStatus

Azure operation completed successfully.

202 Accepted

CsmDeploymentStatus

The request has been accepted for processing, but processing has not yet completed.

Headers

Retry-After: integer

Other Status Codes

DefaultErrorResponse

An unexpected 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=2025-05-01


/**
 * Samples for WebApps GetProductionSiteDeploymentStatus.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/GetSiteDeploymentStatus.json
     */
    /**
     * Sample code: Get Deployment Status.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void getDeploymentStatus(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getWebApps().getProductionSiteDeploymentStatus("rg", "testSite",
            "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v6"
)

// Generated from example definition: 2025-05-01/GetSiteDeploymentStatus.json
func ExampleWebAppsClient_BeginGetProductionSiteDeploymentStatus() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWebAppsClient().BeginGetProductionSiteDeploymentStatus(ctx, "rg", "testSite", "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armappservice.WebAppsClientGetProductionSiteDeploymentStatusResponse{
	// 	CsmDeploymentStatus: &armappservice.CsmDeploymentStatus{
	// 		Name: to.Ptr("eacfd68b-3bbd-4ad9-99c5-98614d89c8e5"),
	// 		Type: to.Ptr("Microsoft.Web/sites/deploymentStatus"),
	// 		ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/deploymentStatus/eacfd68b-3bbd-4ad9-99c5-98614d89c8e5"),
	// 		Properties: &armappservice.CsmDeploymentStatusProperties{
	// 			DeploymentID: to.Ptr("eacfd68b-3bbd-4ad9-99c5-98614d89c8e5"),
	// 			FailedInstancesLogs: []*string{
	// 			},
	// 			NumberOfInstancesFailed: to.Ptr[int32](0),
	// 			NumberOfInstancesInProgress: to.Ptr[int32](0),
	// 			NumberOfInstancesSuccessful: to.Ptr[int32](1),
	// 			Status: to.Ptr(armappservice.DeploymentBuildStatusRuntimeSuccessful),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

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

Status code:: 202

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

Definitions

Name	Description
createdByType	The type of identity that created the resource.
CsmDeploymentStatus	Deployment status response payload.
DefaultErrorResponse	App Service error response.
DefaultErrorResponseError	Error model.
DefaultErrorResponseErrorDetailsItem	Detailed errors.
DeploymentBuildStatus	Deployment build status.
ErrorEntity	Body of the error response returned from the API.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CsmDeploymentStatus

Object

Deployment status response payload.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Kind of resource.
name	string	The name of the resource
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 (int32)	Number of site instances failed to provision.
properties.numberOfInstancesInProgress	integer (int32)	Number of site instances currently being provisioned.
properties.numberOfInstancesSuccessful	integer (int32)	Number of site instances provisioned successfully.
properties.status	DeploymentBuildStatus	Deployment build status.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

DefaultErrorResponse

Object

App Service error response.

Name	Type	Description
error	DefaultErrorResponseError	Error model.

DefaultErrorResponseError

Object

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	DefaultErrorResponseErrorDetailsItem[]	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.

DefaultErrorResponseErrorDetailsItem

Object

Detailed errors.

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.

DeploymentBuildStatus

Enumeration

Deployment build status.

Value	Description
TimedOut
RuntimeFailed
BuildAborted
BuildFailed
BuildRequestReceived
BuildPending
BuildInProgress
BuildSuccessful
PostBuildRestartRequired
StartPolling
StartPollingWithRestart
RuntimeStarting
RuntimeSuccessful

ErrorEntity

Object

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.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Web Apps - Get Production Site Deployment Status

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get Deployment Status

Sample request

Sample response

Definitions

createdByType

CsmDeploymentStatus

DefaultErrorResponse

DefaultErrorResponseError

DefaultErrorResponseErrorDetailsItem

DeploymentBuildStatus

ErrorEntity

systemData