Web Apps - List Slot Site Deployment Statuses Slot

Service:

App Service

API Version:

2023-01-01

Wyświetlanie listy stanów wdrożenia dla aplikacji (lub miejsca wdrożenia, jeśli określono).

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa aplikacji.
resourceGroupName	path	True	string	Nazwa grupy zasobów, do której należy zasób. Regex pattern: ^[-\w\._\(\)]+[^\.]$
slot	path	True	string	Nazwa miejsca wdrożenia. Jeśli miejsce nie zostanie określone, interfejs API uzyska stan wdrożenia dla miejsca produkcyjnego.
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 00000000-0000-0000-0000-0000-000000000000).
api-version	query	True	string	Wersja interfejsu API

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CsmDeploymentStatusCollection	OK
Other Status Codes	DefaultErrorResponse	App Service odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List Deployment Status Slot

Sample Request

HTTP

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

Java

/**
 * Samples for WebApps ListSlotSiteDeploymentStatusesSlot.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/ListSiteDeploymentStatusSlot.json
     */
    /**
     * Sample code: List Deployment Status Slot.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listDeploymentStatusSlot(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().listSlotSiteDeploymentStatusesSlot("rg", "testSite",
            "stage", 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 list_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.list_slot_site_deployment_statuses_slot(
        resource_group_name="rg",
        name="testSite",
        slot="stage",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/ListSiteDeploymentStatusSlot.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/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/ListSiteDeploymentStatusSlot.json
func ExampleWebAppsClient_NewListSlotSiteDeploymentStatusesSlotPager() {
	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)
	}
	pager := clientFactory.NewWebAppsClient().NewListSlotSiteDeploymentStatusesSlotPager("rg", "testSite", "stage", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.CsmDeploymentStatusCollection = armappservice.CsmDeploymentStatusCollection{
		// 	Value: []*armappservice.CsmDeploymentStatus{
		// 	},
		// }
	}
}

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");

/**
 * This sample demonstrates how to List deployment statuses for an app (or deployment slot, if specified).
 *
 * @summary List deployment statuses for an app (or deployment slot, if specified).
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/ListSiteDeploymentStatusSlot.json
 */
async function listDeploymentStatusSlot() {
  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 credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.webApps.listSlotSiteDeploymentStatusesSlot(
    resourceGroupName,
    name,
    slot
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [],
  "nextLink": null
}

Definicje

Nazwa	Opis
CsmDeploymentStatus	Ładunek odpowiedzi stanu wdrożenia.
CsmDeploymentStatusCollection	Zasób arm zbierania stanu wdrożenia.
DefaultErrorResponse	App Service odpowiedź na błąd.
DeploymentBuildStatus	Stan kompilacji wdrożenia.
Details
Error	Model błędu.
ErrorEntity	Treść odpowiedzi o błędzie zwróconej z interfejsu API.

CsmDeploymentStatus

Ładunek odpowiedzi stanu wdrożenia.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
name	string	Nazwa zasobu.
properties.deploymentId	string	Identyfikator operacji wdrożenia.
properties.errors	ErrorEntity[]	Lista błędów.
properties.failedInstancesLogs	string[]	Lista adresów URL wskazujących dzienniki dla wystąpień, których aprowizacja nie powiodła się.
properties.numberOfInstancesFailed	integer	Nie można zainicjować obsługi administracyjnej liczby wystąpień lokacji.
properties.numberOfInstancesInProgress	integer	Obecnie aprowizowana liczba wystąpień lokacji.
properties.numberOfInstancesSuccessful	integer	Liczba wystąpień lokacji pomyślnie zainicjowanych.
properties.status	DeploymentBuildStatus	Stan kompilacji wdrożenia.
type	string	Typ zasobu.

CsmDeploymentStatusCollection

Zasób arm zbierania stanu wdrożenia.

Nazwa	Typ	Opis
nextLink	string	Łącze do następnej strony zasobów.
value	CsmDeploymentStatus[]	Kolekcja zasobów.

DefaultErrorResponse

App Service odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Model błędu.

DeploymentBuildStatus

Stan kompilacji wdrożenia.

Nazwa	Typ	Opis
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

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

ErrorEntity

Treść odpowiedzi o błędzie zwróconej z interfejsu API.

Nazwa	Typ	Opis
code	string	Podstawowy kod błędu.
details	ErrorEntity[]	Szczegóły błędu.
extendedCode	string	Typ błędu.
innerErrors	ErrorEntity[]	Błędy wewnętrzne.
message	string	Wszelkie szczegóły błędu.
messageTemplate	string	Szablon wiadomości.
parameters	string[]	Parametry szablonu.
target	string	Element docelowy błędu.