Web Apps - Get Production Site Deployment Status

Referenz

Service:: App Service

API Version:: 2023-12-01

Ruft den Bereitstellungs-status für eine App (oder einen Bereitstellungsslot, falls angegeben) ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus/{deploymentStatusId}?api-version=2023-12-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	Name der Ressourcengruppe, zu der die Ressource gehört. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-00000000000000000).
api-version	query	True	string	API-Version

Antworten

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

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get Deployment Status

Sample Request

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=2023-12-01

Sample Response

Status code:: 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
  }
}

Status code:: 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
  }
}

Definitionen

Name	Beschreibung
CsmDeploymentStatus	Bereitstellung status Antwortnutzlast.
DefaultErrorResponse	App Service Fehlerantwort.
DeploymentBuildStatus	Bereitstellungsbuild status.
Details
Error	Fehlermodell.
ErrorEntity	Text der von der API zurückgegebenen Fehlerantwort.

CsmDeploymentStatus

Bereitstellung status Antwortnutzlast.

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 für Instanzen verweisen, die nicht bereitgestellt werden konnten.
properties.numberOfInstancesFailed	integer	Anzahl von Standortinstanzen, die nicht bereitgestellt werden konnten.
properties.numberOfInstancesInProgress	integer	Anzahl der derzeit bereitgestellten Standortinstanzen.
properties.numberOfInstancesSuccessful	integer	Anzahl der erfolgreich bereitgestellten Standortinstanzen.
properties.status	DeploymentBuildStatus	Bereitstellungsbuild status.
type	string	Der Ressourcentyp.

DefaultErrorResponse

App Service Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

DeploymentBuildStatus

Bereitstellungsbuild status.

Name	Typ	Beschreibung
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	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.
message	string	Ausführliche Fehlerbeschreibung und Debuginformationen.
target	string	Ausführliche Fehlerbeschreibung und Debuginformationen.

Error

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen des Fehlers.
message	string	Ausführliche Fehlerbeschreibung und Debuginformationen.
target	string	Ausführliche Fehlerbeschreibung und Debuginformationen.

ErrorEntity

Text der von der API zurückgegebenen Fehlerantwort.

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

Share via