Web Apps - Get Slot Site Deployment Status Slot

Reference

Service:: App Service

API Version:: 2023-01-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}/slots/{slot}/deploymentStatus/{deploymentStatusId}?api-version=2023-01-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\._]+[^\.]$`
slot	path	True	string	Name of the deployment slot. If a slot is not specified, the API will get the deployment status for the production slot.
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 Slot

Sample Request

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


/**
 * Samples for WebApps GetSlotSiteDeploymentStatusSlot.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetSiteDeploymentStatusSlot.json
     */
    /**
     * Sample code: Get Deployment Status Slot.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getDeploymentStatusSlot(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getSlotSiteDeploymentStatusSlot("rg", "testSite",
            "stage", "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

from azure.identity import DefaultAzureCredential
from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python get_site_deployment_status_slot.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.web_apps.begin_get_slot_site_deployment_status_slot(
        resource_group_name="rg",
        name="testSite",
        slot="stage",
        deployment_status_id="eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
    ).result()
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetSiteDeploymentStatusSlot.json
if __name__ == "__main__":
    main()

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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/738ab25fe76324897f273645906d4a0415068a6c/specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetSiteDeploymentStatusSlot.json
func ExampleWebAppsClient_BeginGetSlotSiteDeploymentStatusSlot() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWebAppsClient().BeginGetSlotSiteDeploymentStatusSlot(ctx, "rg", "testSite", "stage", "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.CsmDeploymentStatus = armappservice.CsmDeploymentStatus{
	// 	Name: to.Ptr("eacfd68b-3bbd-4ad9-99c5-98614d89c8e5"),
	// 	Type: to.Ptr("Microsoft.Web/sites/slots/deploymentStatus"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/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

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the deployment status for an app (or deployment slot, if specified).
 *
 * @summary Gets the deployment status for an app (or deployment slot, if specified).
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetSiteDeploymentStatusSlot.json
 */
async function getDeploymentStatusSlot() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "rg";
  const name = "testSite";
  const slot = "stage";
  const deploymentStatusId = "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.beginGetSlotSiteDeploymentStatusSlotAndWait(
    resourceGroupName,
    name,
    slot,
    deploymentStatusId
  );
  console.log(result);
}

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

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

Status code:: 202

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/deploymentStatus/eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
  "name": "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5",
  "type": "Microsoft.Web/sites/slots/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.

Web Apps - Get Slot Site Deployment Status Slot

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get Deployment Status Slot

Sample Request

Sample Response

Definitions

CsmDeploymentStatus

DefaultErrorResponse

DeploymentBuildStatus

Details

Error

ErrorEntity

Additional resources