Partilhar via

Deployments - Get

Serviço:
Resource Management
Versão da API:
2025-04-01

Obtém uma implantação.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2025-04-01

Parâmetros do URI

Name Em Necessário Tipo Description
deploymentName
 path True

string

minLength: 1
maxLength: 64
pattern: ^[-\w\._\(\)]+$

O nome da implantação.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId
 path True

string

A ID de assinatura do Microsoft Azure.
api-version
 query True

string

A versão da API a utilizar para esta operação.

Respostas

Name Tipo Description
200 OK

DeploymentExtended

OK - Retorna informações sobre a implantação, incluindo o status de provisionamento.
Other Status Codes

CloudError

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Definições

Name Description
Alias

O tipo de alias.
AliasPath

O tipo de caminhos para alias.
AliasPathAttributes

Os atributos do token ao qual o caminho do alias está se referindo.
AliasPathMetadata
AliasPathTokenType

O tipo de token ao qual o caminho do alias está se referindo.
AliasPattern

O tipo do padrão para um caminho de alias.
AliasPatternType

O tipo de padrão de alias
AliasType

O tipo do alias.
ApiProfile
BasicDependency

Informações de dependência de implantação.
CloudError

Uma resposta de erro para uma solicitação de gerenciamento de recursos.
DebugSetting

A configuração de depuração.
Dependency

Informações de dependência de implantação.
DeploymentDiagnosticsDefinition
DeploymentExtended

Informações de implantação.
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentMode

O modo usado para implantar recursos. Esse valor pode ser Incremental ou Completo. No modo Incremental, os recursos são implantados sem excluir os recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implantados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são excluídos. Tenha cuidado ao usar o modo Completo, pois você pode excluir recursos involuntariamente.
DeploymentPropertiesExtended

Propriedades de implantação com detalhes adicionais.
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorResponse

Resposta de erro
ExtensionConfigPropertyType
KeyVaultParameterReference

Referência de parâmetro do Azure Key Vault.
KeyVaultReference

Referência do Azure Key Vault.
Level

Indica o nível de resposta adicional.
OnErrorDeploymentExtended

Implantação sobre comportamento de erro com detalhes adicionais.
OnErrorDeploymentType

A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment.
ParametersLink

Entidade que representa a referência aos parâmetros de implantação.
Provider

Informações do provedor de recursos.
ProviderAuthorizationConsentState

O estado de consentimento de autorização do provedor.
ProviderExtendedLocation

A localização estendida do provedor.
ProviderResourceType

Tipo de recurso gerenciado pelo provedor de recursos.
ProvisioningState

Indica o estado de provisionamento.
ResourceReference

O modelo de ID do recurso.
TemplateLink

Entidade que representa a referência ao modelo.
ValidationLevel

O nível de validação realizado na implantação.
ZoneMapping

Alias

Object

O tipo de alias.

Name Tipo Description
defaultMetadata

AliasPathMetadata

Os metadados de caminho de alias padrão. Aplica-se ao caminho padrão e a qualquer caminho de alias que não tenha metadados
defaultPath

string

O caminho padrão para um alias.
defaultPattern

AliasPattern

O padrão padrão para um alias.
name

string

O nome do alias.
paths

AliasPath[]

Os caminhos para um alias.
type

AliasType

O tipo do alias.

AliasPath

Object

O tipo de caminhos para alias.

Name Tipo Description
apiVersions

string[]

As versões da API.
metadata

AliasPathMetadata

Os metadados do caminho do alias. Se estiver ausente, volte para os metadados padrão do alias.
path

string

O caminho de um alias.
pattern

AliasPattern

O padrão para um caminho de alias.

AliasPathAttributes

Enumeração

Os atributos do token ao qual o caminho do alias está se referindo.

Valor Description
None

O token ao qual o caminho do alias está se referindo não tem atributos.
Modifiable

O token ao qual o caminho do alias está se referindo é modificável por políticas com efeito 'modificar'.

AliasPathMetadata

Object
Name Tipo Description
attributes

AliasPathAttributes

Os atributos do token ao qual o caminho do alias está se referindo.
type

AliasPathTokenType

O tipo de token ao qual o caminho do alias está se referindo.

AliasPathTokenType

Enumeração

O tipo de token ao qual o caminho do alias está se referindo.

Valor Description
NotSpecified

O tipo de token não é especificado.
Any

O tipo de token pode ser qualquer coisa.
String

O tipo de token é string.
Object

O tipo de token é objeto.
Array

O tipo de token é array.
Integer

O tipo de token é inteiro.
Number

O tipo de token é número.
Boolean

O tipo de token é booleano.

AliasPattern

Object

O tipo do padrão para um caminho de alias.

Name Tipo Description
phrase

string

A frase padrão de alias.
type

AliasPatternType

O tipo de padrão de alias
variable

string

A variável de padrão de alias.

AliasPatternType

Enumeração

O tipo de padrão de alias

Valor Description
NotSpecified

NotSpecified não é permitido.
Extract

Extract é o único valor permitido.

AliasType

Enumeração

O tipo do alias.

Valor Description
NotSpecified

O tipo de alias é desconhecido (o mesmo que não fornecer o tipo de alias).
PlainText

O valor do alias não é secreto.
Mask

O valor do alias é secreto.

ApiProfile

Object
Name Tipo Description
apiVersion

string

A versão da API.
profileVersion

string

A versão do perfil.

BasicDependency

Object

Informações de dependência de implantação.

Name Tipo Description
id

string

A ID da dependência.
resourceName

string

O nome do recurso de dependência.
resourceType

string

O tipo de recurso de dependência.

CloudError

Object

Uma resposta de erro para uma solicitação de gerenciamento de recursos.

Name Tipo Description
error

ErrorResponse

Resposta de erro
Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

DebugSetting

Object

A configuração de depuração.

Name Tipo Description
detailLevel

string

Especifica o tipo de informação a ser registrada para depuração. Os valores permitidos são none, requestContent, responseContent ou ambos requestContent e responseContent separados por uma vírgula. O padrão é nenhum. Ao definir esse valor, considere cuidadosamente o tipo de informação que você está passando durante a implantação. Ao registrar informações sobre a solicitação ou resposta, você pode expor dados confidenciais recuperados por meio das operações de implantação.

Dependency

Object

Informações de dependência de implantação.

Name Tipo Description
dependsOn

BasicDependency[]

A lista de dependências.
id

string

A ID da dependência.
resourceName

string

O nome do recurso de dependência.
resourceType

string

O tipo de recurso de dependência.

DeploymentDiagnosticsDefinition

Object
Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
code

string

O código de erro.
level

Level

Indica o nível de resposta adicional.
message

string

A mensagem de erro.
target

string

O destino do erro.

DeploymentExtended

Object

Informações de implantação.

Name Tipo Description
id

string

A ID da implantação.
location

string

o local da implantação.
name

string

O nome da implantação.
properties

DeploymentPropertiesExtended

Propriedades de implantação.
tags

object

Tags de implantação
type

string

O tipo de implantação.

DeploymentExtensionConfigItem

Object
Name Tipo Description
keyVaultReference

KeyVaultParameterReference

A referência do Cofre da Chave do Azure usada para recuperar o valor secreto da propriedade de configuração da extensão.
type

ExtensionConfigPropertyType

O tipo de valor da propriedade de configuração de extensão.
value

O valor da propriedade extension config.

DeploymentExtensionDefinition

Object
Name Tipo Description
alias

string

O alias da extensão, conforme definido no modelo de implantação.
config

<string,  DeploymentExtensionConfigItem>

A configuração da extensão.
configId

string

O ID de configuração da extensão. Ele identifica exclusivamente um plano de controle de implantação dentro de uma extensão.
name

string

O nome da extensão.
version

string

A versão de extensão.

DeploymentMode

Enumeração

O modo usado para implantar recursos. Esse valor pode ser Incremental ou Completo. No modo Incremental, os recursos são implantados sem excluir os recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implantados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são excluídos. Tenha cuidado ao usar o modo Completo, pois você pode excluir recursos involuntariamente.

Valor Description
Incremental
Complete

DeploymentPropertiesExtended

Object

Propriedades de implantação com detalhes adicionais.

Name Tipo Description
correlationId

string

A ID de correlação da implantação.
debugSetting

DebugSetting

A configuração de depuração da implantação.
dependencies

Dependency[]

A lista de dependências de implantação.
diagnostics

DeploymentDiagnosticsDefinition[]

Contém informações de diagnóstico coletadas durante o processo de validação.
duration

string

A duração da implantação do modelo.
error

ErrorResponse

Resposta de erro
O erro de implantação.
extensions

DeploymentExtensionDefinition[]

As extensões usadas nesta implantação.
mode

DeploymentMode

O modo de implantação. Os valores possíveis são Incremental e Complete.
onErrorDeployment

OnErrorDeploymentExtended

A implantação no comportamento de erro.
outputResources

ResourceReference[]

Matriz de recursos provisionados.
outputs

object

Pares chave/valor que representam a saída da implantação.
parameters

object

Parâmetros de implantação.
parametersLink

ParametersLink

O URI que faz referência aos parâmetros.
providers

Provider[]

A lista de provedores de recursos necessários para a implantação.
provisioningState

ProvisioningState

Indica o estado de provisionamento.
templateHash

string

O hash produzido para o modelo.
templateLink

TemplateLink

O URI que faz referência ao modelo.
timestamp

string (date-time)

O carimbo de data/hora da implantação do modelo.
validatedResources

ResourceReference[]

Matriz de recursos validados.
validationLevel

ValidationLevel

O nível de validação da implantação

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorResponse

Object

Resposta de erro

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
code

string

O código de erro.
details

ErrorResponse[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ExtensionConfigPropertyType

Enumeração
Valor Description
String

Tipo de propriedade que representa um valor de cadeia de caracteres.
Int

Tipo de propriedade que representa um valor inteiro.
Bool

Tipo de propriedade que representa um valor booleano.
Array

Tipo de propriedade que representa um valor de matriz.
Object

Tipo de propriedade que representa um valor de objeto.
SecureString

Tipo de propriedade que representa um valor de cadeia de caracteres seguro.
SecureObject

Tipo de propriedade que representa um valor de objeto seguro.

KeyVaultParameterReference

Object

Referência de parâmetro do Azure Key Vault.

Name Tipo Description
keyVault

KeyVaultReference

Referência do Azure Key Vault.
secretName

string

Nome secreto do Azure Key Vault.
secretVersion

string

Versão secreta do Azure Key Vault.

KeyVaultReference

Object

Referência do Azure Key Vault.

Name Tipo Description
id

string

ID do recurso do Azure Key Vault.

Level

Enumeração

Indica o nível de resposta adicional.

Valor Description
Warning
Info
Error

OnErrorDeploymentExtended

Object

Implantação sobre comportamento de erro com detalhes adicionais.

Name Tipo Description
deploymentName

string

A implantação a ser usada em caso de erro.
provisioningState

string

O estado do provisionamento para a implantação on error.
type

OnErrorDeploymentType

A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment.

OnErrorDeploymentType

Enumeração

A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment.

Valor Description
LastSuccessful
SpecificDeployment
Object

Entidade que representa a referência aos parâmetros de implantação.

Name Tipo Description
contentVersion

string

Se incluído, deve corresponder ao ContentVersion no modelo.
uri

string

O URI do arquivo de parâmetros.

Provider

Object

Informações do provedor de recursos.

Name Tipo Description
id

string

O ID do provedor.
namespace

string

O namespace do provedor de recursos.
providerAuthorizationConsentState

ProviderAuthorizationConsentState

O estado de consentimento de autorização do provedor.
registrationPolicy

string

A política de registro do provedor de recursos.
registrationState

string

O estado de registro do provedor de recursos.
resourceTypes

ProviderResourceType[]

A coleção de tipos de recursos do provedor.

ProviderAuthorizationConsentState

Enumeração

O estado de consentimento de autorização do provedor.

Valor Description
NotSpecified
Required
NotRequired
Consented

ProviderExtendedLocation

Object

A localização estendida do provedor.

Name Tipo Description
extendedLocations

string[]

Os locais estendidos para o local azure.
location

string

O local azure.
type

string

O tipo de local estendido.

ProviderResourceType

Object

Tipo de recurso gerenciado pelo provedor de recursos.

Name Tipo Description
aliases

Alias[]

Os aliases suportados por este tipo de recurso.
apiProfiles

ApiProfile[]

Os perfis de API para o provedor de recursos.
apiVersions

string[]

A versão da API.
capabilities

string

Os recursos adicionais oferecidos por esse tipo de recurso.
defaultApiVersion

string

A versão padrão da API.
locationMappings

ProviderExtendedLocation[]

Os mapeamentos de local suportados por esse tipo de recurso.
locations

string[]

A coleção de locais onde esse tipo de recurso pode ser criado.
properties

object

As propriedades.
resourceType

string

O tipo do recurso.
zoneMappings

ZoneMapping[]

ProvisioningState

Enumeração

Indica o estado de provisionamento.

Valor Description
NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Updating

ResourceReference

Object

O modelo de ID do recurso.

Name Tipo Description
apiVersion

string

A versão da API com a qual o recurso foi implantado.
extension

DeploymentExtensionDefinition

A extensão com a qual o recurso foi implantado.
id

string

A ID de recurso do Azure totalmente qualificada.
identifiers

object

Os identificadores de recursos extensíveis.
resourceType

string

O tipo do recurso.
Object

Entidade que representa a referência ao modelo.

Name Tipo Description
contentVersion

string

Se incluído, deve corresponder ao ContentVersion no modelo.
id

string

Use a propriedade id ou uri, mas não ambas.
queryString

string

A cadeia de caracteres de consulta (por exemplo, um token SAS) a ser usada com o URI templateLink.
relativePath

string

A propriedade relativePath pode ser usada para implantar um modelo vinculado em um local relativo ao pai. Se o modelo pai foi vinculado a um TemplateSpec, isso fará referência a um artefato no TemplateSpec. Se o pai foi vinculado a um URI, a implantação filho será uma combinação dos URIs pai e relativePath
uri

string

O URI do modelo a ser implantado. Use a propriedade uri ou id, mas não ambas.

ValidationLevel

Enumeração

O nível de validação realizado na implantação.

Valor Description
Template

A análise estática do modelo é realizada.
Provider

A análise estática do modelo é executada e as declarações de recursos são enviadas aos provedores de recursos para validação semântica. Valida se o chamador tem permissões de gravação RBAC em cada recurso.
ProviderNoRbac

A análise estática do modelo é executada e as declarações de recursos são enviadas aos provedores de recursos para validação semântica. Ignora a validação de que o chamador tem permissões de gravação RBAC em cada recurso.

ZoneMapping

Object
Name Tipo Description
location

string

A localização do mapeamento de zona.
zones

string[]