Web Apps - Get Production Site Deployment Status

Служба:

App Service

Версия API:

2024-11-01

Возвращает состояние развертывания для приложения (или слота развертывания, если указано).

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
deploymentStatusId	path	True	string	GUID операции развертывания.
name	path	True	string	Имя приложения.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Имя группы ресурсов, к которой принадлежит ресурс.
subscriptionId	path	True	string	Идентификатор вашей подписки Azure. Это строка с форматом GUID (например, 0000000000-0000-0000-0000-00000000000000000000000000000).
api-version	query	True	string	Версия API

Ответы

Имя	Тип	Описание
200 OK	CsmDeploymentStatus	ХОРОШО
202 Accepted	CsmDeploymentStatus	Выполняется операция.
Other Status Codes	DefaultErrorResponse	Ответ об ошибке службы приложений.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get Deployment Status

Образец запроса

HTTP

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

Java

/**
 * Samples for WebApps GetProductionSiteDeploymentStatus.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetSiteDeploymentStatus.json
     */
    /**
     * Sample code: Get Deployment Status.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getDeploymentStatus(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().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

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.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_production_site_deployment_status(
        resource_group_name="rg",
        name="testSite",
        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/GetSiteDeploymentStatus.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/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("<subscription-id>", 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.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

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/GetSiteDeploymentStatus.json
 */
async function getDeploymentStatus() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "rg";
  const name = "testSite";
  const deploymentStatusId = "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.beginGetProductionSiteDeploymentStatusAndWait(
    resourceGroupName,
    name,
    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/GetSiteDeploymentStatus.json
// this example is just showing the usage of "WebApps_GetProductionSiteDeploymentStatus" 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 WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
string name = "testSite";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// invoke the operation
string deploymentStatusId = "eacfd68b-3bbd-4ad9-99c5-98614d89c8e5";
ArmOperation<CsmDeploymentStatus> lro = await webSite.GetProductionSiteDeploymentStatusAsync(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

Пример ответа

Код состояния:

200

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

Код состояния:

202

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

Определения

Имя	Описание
CsmDeploymentStatus	Полезные данные ответа о состоянии развертывания.
DefaultErrorResponse	Ответ об ошибке службы приложений.
DeploymentBuildStatus	Состояние сборки развертывания.
Details
Error	Модель ошибок.
ErrorEntity	Текст ответа на ошибку, возвращенный API.

CsmDeploymentStatus

Object

Полезные данные ответа о состоянии развертывания.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
kind	string	Тип ресурса.
name	string	Имя ресурса.
properties.deploymentId	string	Идентификатор операции развертывания.
properties.errors	ErrorEntity[]	Список ошибок.
properties.failedInstancesLogs	string[]	Список URL-адресов, указывающих на журналы для экземпляров, которые не удалось подготовить.
properties.numberOfInstancesFailed	integer (int32)	Количество экземпляров сайта не удалось подготовить.
properties.numberOfInstancesInProgress	integer (int32)	Количество экземпляров сайта, которые в настоящее время подготавливаются.
properties.numberOfInstancesSuccessful	integer (int32)	Количество экземпляров сайта, подготовленных успешно.
properties.status	DeploymentBuildStatus	Состояние сборки развертывания.
type	string	Тип ресурса.

DefaultErrorResponse

Object

Ответ об ошибке службы приложений.

Имя	Тип	Описание
error	Error	Модель ошибок.

DeploymentBuildStatus

Перечисление

Состояние сборки развертывания.

Значение	Описание
BuildAborted
BuildFailed
BuildInProgress
BuildPending
BuildRequestReceived
BuildSuccessful
PostBuildRestartRequired
RuntimeFailed
RuntimeStarting
RuntimeSuccessful
StartPolling
StartPollingWithRestart
TimedOut

Details

Object

Имя	Тип	Описание
code	string	Стандартизованная строка для программной идентификации ошибки.
message	string	Подробные сведения об ошибке и сведения об отладке.
target	string	Подробные сведения об ошибке и сведения об отладке.

Error

Object

Модель ошибок.

Имя	Тип	Описание
code	string	Стандартизованная строка для программной идентификации ошибки.
details	Details[]	Подробные ошибки.
innererror	string	Дополнительные сведения об ошибке отладки.
message	string	Подробные сведения об ошибке и сведения об отладке.
target	string	Подробные сведения об ошибке и сведения об отладке.

ErrorEntity

Object

Текст ответа на ошибку, возвращенный API.

Имя	Тип	Описание
code	string	Базовый код ошибки.
details	ErrorEntity[]	Сведения об ошибке.
extendedCode	string	Тип ошибки.
innerErrors	ErrorEntity[]	Внутренние ошибки.
message	string	Все сведения об ошибке.
messageTemplate	string	Шаблон сообщения.
parameters	string[]	Параметры шаблона.
target	string	Целевой объект ошибки.