Hiermee wordt de implementatiestatus voor een app (of implementatiesite, indien opgegeven) opgevraagd.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus/{deploymentStatusId}?api-version=2023-12-01
URI-parameters
| Name |
In |
Vereist |
Type |
Description |
|
deploymentStatusId
|
path |
True
|
string
|
GUID van de implementatiebewerking.
|
|
name
|
path |
True
|
string
|
Naam van de app.
|
|
resourceGroupName
|
path |
True
|
string
|
Naam van de resourcegroep waartoe de resource behoort.
Regex-patroon: ^[-\w\._\(\)]+[^\.]$
|
|
subscriptionId
|
path |
True
|
string
|
Uw Azure-abonnements-id. Dit is een tekenreeks met GUID-indeling (bijvoorbeeld 000000000-0000-0000-0000-000000000000).
|
|
api-version
|
query |
True
|
string
|
API-versie
|
Antwoorden
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
| Name |
Description |
|
user_impersonation
|
Uw gebruikersaccount imiteren
|
Voorbeelden
Get Deployment Status
Voorbeeldaanvraag
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
Voorbeeldrespons
{
"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
}
}
Definities
CsmDeploymentStatus
Nettolading van antwoord op implementatiestatus.
| Name |
Type |
Description |
|
id
|
string
|
Resource-id.
|
|
kind
|
string
|
Soort resource.
|
|
name
|
string
|
Resourcenaam.
|
|
properties.deploymentId
|
string
|
Id van implementatiebewerking.
|
|
properties.errors
|
ErrorEntity[]
|
Lijst met fouten.
|
|
properties.failedInstancesLogs
|
string[]
|
Lijst met URL's die verwijzen naar logboeken voor exemplaren die niet zijn ingericht.
|
|
properties.numberOfInstancesFailed
|
integer
|
Het aantal site-exemplaren kan niet worden ingericht.
|
|
properties.numberOfInstancesInProgress
|
integer
|
Het aantal site-exemplaren dat momenteel wordt ingericht.
|
|
properties.numberOfInstancesSuccessful
|
integer
|
Het aantal site-exemplaren dat is ingericht.
|
|
properties.status
|
DeploymentBuildStatus
|
Status van implementatiebuild.
|
|
type
|
string
|
Resourcetype.
|
DefaultErrorResponse
App Service foutreactie.
| Name |
Type |
Description |
|
error
|
Error
|
Foutmodel.
|
DeploymentBuildStatus
Status van implementatiebuild.
| 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
|
Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
|
|
message
|
string
|
Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
|
|
target
|
string
|
Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
|
Error
Foutmodel.
| Name |
Type |
Description |
|
code
|
string
|
Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
|
|
details
|
Details[]
|
Gedetailleerde fouten.
|
|
innererror
|
string
|
Meer informatie over foutopsporing.
|
|
message
|
string
|
Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
|
|
target
|
string
|
Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
|
ErrorEntity
Hoofdtekst van het foutbericht dat is geretourneerd door de API.
| Name |
Type |
Description |
|
code
|
string
|
Basisfoutcode.
|
|
details
|
ErrorEntity[]
|
Foutdetails.
|
|
extendedCode
|
string
|
Type fout.
|
|
innerErrors
|
ErrorEntity[]
|
Interne fouten.
|
|
message
|
string
|
Eventuele details van de fout.
|
|
messageTemplate
|
string
|
Berichtsjabloon.
|
|
parameters
|
string[]
|
Parameters voor de sjabloon.
|
|
target
|
string
|
Het foutdoel.
|