Web Apps - Get Slot Site Deployment Status Slot

Dienst:

App Service

API-Version:

2024-11-01

Ruft den Bereitstellungsstatus für eine App (oder bereitstellungsplatz, falls angegeben) ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
deploymentStatusId	path	True	string	GUID des Bereitstellungsvorgangs.
name	path	True	string	Name der App.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Name der Ressourcengruppe, zu der die Ressource gehört.
slot	path	True	string	Name des Bereitstellungsplatzes. Wenn kein Steckplatz angegeben ist, erhält die API den Bereitstellungsstatus für den Produktionsplatz.
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-Version

Antworten

Name	Typ	Beschreibung
200 OK	CsmDeploymentStatus	OKAY
202 Accepted	CsmDeploymentStatus	Der Vorgang wird ausgeführt.
Other Status Codes	DefaultErrorResponse	Fehlerantwort des App-Diensts.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get Deployment Status Slot

Beispielanforderung

HTTP

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=2024-11-01

Java

/**
 * Samples for WebApps GetSlotSiteDeploymentStatusSlot.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-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

Python

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/2024-11-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

Go

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-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

JavaScript

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

/**
 * 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/2024-11-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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetSiteDeploymentStatusSlot.json
// this example is just showing the usage of "WebApps_GetSlotSiteDeploymentStatusSlot" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WebSiteSlotResource created on azure
// for more information of creating WebSiteSlotResource, please refer to the document of WebSiteSlotResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
string name = "testSite";
string slot = "stage";
ResourceIdentifier webSiteSlotResourceId = WebSiteSlotResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, slot);
WebSiteSlotResource webSiteSlot = client.GetWebSiteSlotResource(webSiteSlotResourceId);

// invoke the operation
string deploymentStatusId = "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5";
ArmOperation<CsmDeploymentStatus> lro = await webSiteSlot.GetSlotSiteDeploymentStatusSlotAsync(WaitUntil.Completed, deploymentStatusId);
CsmDeploymentStatus result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

Beispiel für eine Antwort

Statuscode:

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
  }
}

Statuscode:

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
  }
}

Definitionen

Name	Beschreibung
CsmDeploymentStatus	Antwortnutzlast des Bereitstellungsstatus.
DefaultErrorResponse	Fehlerantwort des App-Diensts.
DeploymentBuildStatus	Bereitstellungsbuildstatus.
Details
Error	Fehlermodell.
ErrorEntity	Der Textkörper der von der API zurückgegebenen Fehlerantwort.

CsmDeploymentStatus

Objekt

Antwortnutzlast des Bereitstellungsstatus.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource.
name	string	Ressourcenname.
properties.deploymentId	string	Id des Bereitstellungsvorgangs.
properties.errors	ErrorEntity[]	Liste der Fehler.
properties.failedInstancesLogs	string[]	Liste der URLs, die auf Protokolle verweisen, für Instanzen, die nicht bereitgestellt werden konnten.
properties.numberOfInstancesFailed	integer (int32)	Die Anzahl der Websiteinstanzen konnte nicht bereitgestellt werden.
properties.numberOfInstancesInProgress	integer (int32)	Anzahl der derzeit bereitgestellten Websiteinstanzen.
properties.numberOfInstancesSuccessful	integer (int32)	Die Anzahl der Erfolgreich bereitgestellten Websiteinstanzen.
properties.status	DeploymentBuildStatus	Bereitstellungsbuildstatus.
type	string	Ressourcentyp.

DefaultErrorResponse

Objekt

Fehlerantwort des App-Diensts.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

DeploymentBuildStatus

Enumeration

Bereitstellungsbuildstatus.

Wert	Beschreibung
BuildAborted
BuildFailed
BuildInProgress
BuildPending
BuildRequestReceived
BuildSuccessful
PostBuildRestartRequired
RuntimeFailed
RuntimeStarting
RuntimeSuccessful
StartPolling
StartPollingWithRestart
TimedOut

Details

Objekt

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Error

Objekt

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen von Fehlern.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

ErrorEntity

Objekt

Der Textkörper der von der API zurückgegebenen Fehlerantwort.

Name	Typ	Beschreibung
code	string	Einfacher Fehlercode.
details	ErrorEntity[]	Fehlerdetails.
extendedCode	string	Typ des Fehlers.
innerErrors	ErrorEntity[]	Innere Fehler.
message	string	Alle Details des Fehlers.
messageTemplate	string	Nachrichtenvorlage.
parameters	string[]	Parameter für die Vorlage.
target	string	Das Fehlerziel.