Web Apps - Get Production Site Deployment Status

Referência

Service:: App Service

API Version:: 2023-12-01

Obtém o estado de implementação de uma aplicação (ou bloco de implementação, se especificado).

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
deploymentStatusId	path	True	string	GUID da operação de implementação.
name	path	True	string	Nome da aplicação.
resourceGroupName	path	True	string	Nome do grupo de recursos ao qual o recurso pertence. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	O seu ID de subscrição do Azure. Esta é uma cadeia formatada com GUID (por exemplo, 000000000-0000-0000-0000-000000000000).
api-version	query	True	string	Versão da API

Respostas

Name	Tipo	Description
200 OK	CsmDeploymentStatus	OK
202 Accepted	CsmDeploymentStatus	A operação está em curso.
Other Status Codes	DefaultErrorResponse	Serviço de Aplicações resposta de erro.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

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

Definições

Name	Description
CsmDeploymentStatus	Payload de resposta do estado de implementação.
DefaultErrorResponse	Serviço de Aplicações resposta de erro.
DeploymentBuildStatus	Estado da compilação da implementação.
Details
Error	Modelo de erro.
ErrorEntity	Corpo da resposta de erro devolvida pela API.

CsmDeploymentStatus

Payload de resposta do estado de implementação.

Name	Tipo	Description
id	string	ID do Recurso.
kind	string	Tipo de recurso.
name	string	Nome do Recurso.
properties.deploymentId	string	ID da operação de implementação.
properties.errors	ErrorEntity[]	Lista de erros.
properties.failedInstancesLogs	string[]	Lista de URLs que apontam para registos de instâncias que não foram aprovisionados.
properties.numberOfInstancesFailed	integer	O número de instâncias de site não foi aprovisionado.
properties.numberOfInstancesInProgress	integer	Número de instâncias de site atualmente a ser aprovisionadas.
properties.numberOfInstancesSuccessful	integer	Número de instâncias de site aprovisionadas com êxito.
properties.status	DeploymentBuildStatus	Estado da compilação da implementação.
type	string	Tipo de recurso.

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Name	Tipo	Description
error	Error	Modelo de erro.

DeploymentBuildStatus

Estado da compilação da implementação.

Name	Tipo	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	Tipo	Description
code	string	Cadeia padronizada para identificar programaticamente o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

Error

Modelo de erro.

Name	Tipo	Description
code	string	Cadeia padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

ErrorEntity

Corpo da resposta de erro devolvida pela API.

Name	Tipo	Description
code	string	Código de erro básico.
details	ErrorEntity[]	Detalhes do Erro.
extendedCode	string	Tipo de erro.
innerErrors	ErrorEntity[]	Erros internos.
message	string	Quaisquer detalhes do erro.
messageTemplate	string	Modelo de mensagem.
parameters	string[]	Parâmetros para o modelo.
target	string	O destino do erro.