Pobiera stan wdrożenia aplikacji (lub miejsca wdrożenia, jeśli określono).
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus/{deploymentStatusId}?api-version=2023-12-01
Parametry identyfikatora URI
Nazwa |
W |
Wymagane |
Typ |
Opis |
deploymentStatusId
|
path |
True
|
string
|
Identyfikator GUID operacji wdrażania.
|
name
|
path |
True
|
string
|
Nazwa aplikacji.
|
resourceGroupName
|
path |
True
|
string
|
Nazwa grupy zasobów, do której należy zasób.
Wzorzec wyrażenia regularnego: ^[-\w\._\(\)]+[^\.]$
|
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
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa |
Opis |
user_impersonation
|
personifikacja konta użytkownika
|
Przykłady
Get Deployment Status
Przykładowe żądanie
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=2023-12-01
/**
* Samples for WebApps GetProductionSiteDeploymentStatus.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/web/resource-manager/Microsoft.Web/stable/2023-12-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
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/2023-12-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
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/v4"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/21c2852d62ccc3abe9cc3800c989c6826f8363dc/specification/web/resource-manager/Microsoft.Web/stable/2023-12-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
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-12-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
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.Resources;
using Azure.ResourceManager.AppService;
// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2023-12-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
Przykładowa odpowiedź
{
"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
}
}
{
"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
}
}
Definicje
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.
|
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.
|