Compartilhar via


Deployments - Get

Obtém uma implantação.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
deploymentName
path True

string

O nome da implantação.

Padrão Regex: ^[-\w\._\(\)]+$

resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

Padrão Regex: ^[-\w\._\(\)]+$

subscriptionId
path True

string

A ID da assinatura do Microsoft Azure.

api-version
query True

string

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

Respostas

Nome Tipo Description
200 OK

DeploymentExtended

OK – retorna informações sobre a implantação, incluindo status de provisionamento.

Other Status Codes

CloudError

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

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Definições

Nome Description
Alias

O tipo de alias.

AliasPath

O tipo dos caminhos para alias.

AliasPathAttributes

Os atributos do token aos quais o caminho do alias está se referindo.

AliasPathMetadata
AliasPathTokenType

O tipo do 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.

DeploymentExtended

Informações sobre a implantação.

DeploymentMode

O modo usado para implantar recursos. Esse valor pode ser Incremental ou Complete. 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 sem querer.

DeploymentPropertiesExtended

Propriedades de implantação com detalhes adicionais.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorResponse

Resposta de erro

OnErrorDeploymentExtended

Implantação no 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

O local estendido do provedor.

ProviderResourceType

Tipo de recurso gerenciado pelo provedor de recursos.

ProvisioningState

Indica o estado do provisionamento.

ResourceReference

O modelo de ID do recurso.

TemplateLink

Entidade que representa a referência para o modelo.

ZoneMapping

Alias

O tipo de alias.

Nome Tipo Description
defaultMetadata

AliasPathMetadata

Os metadados de caminho do 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

O tipo dos caminhos para alias.

Nome 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 de um caminho de alias.

AliasPathAttributes

Os atributos do token aos quais o caminho do alias está se referindo.

Nome Tipo Description
Modifiable

string

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

None

string

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

AliasPathMetadata

Nome Tipo Description
attributes

AliasPathAttributes

Os atributos do token aos quais o caminho do alias está se referindo.

type

AliasPathTokenType

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

AliasPathTokenType

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

Nome Tipo Description
Any

string

O tipo de token pode ser qualquer coisa.

Array

string

O tipo de token é matriz.

Boolean

string

O tipo de token é booliano.

Integer

string

O tipo de token é inteiro.

NotSpecified

string

O tipo de token não é especificado.

Number

string

O tipo de token é number.

Object

string

O tipo de token é objeto .

String

string

O tipo de token é cadeia de caracteres.

AliasPattern

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

Nome 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

O tipo de padrão de alias

Nome Tipo Description
Extract

string

Extração é o único valor permitido.

NotSpecified

string

NotSpecified não é permitido.

AliasType

O tipo do alias.

Nome Tipo Description
Mask

string

O valor do alias é secreto.

NotSpecified

string

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

PlainText

string

O valor do alias não é segredo.

ApiProfile

Nome Tipo Description
apiVersion

string

A versão da API.

profileVersion

string

A versão do perfil.

BasicDependency

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

Nome 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

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

Nome Tipo Description
error

ErrorResponse

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

DebugSetting

A configuração de depuração.

Nome 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 requestContent e responseContent separados por uma vírgula. O padrão é none. Ao definir esse valor, considere cuidadosamente o tipo de informação que você está passando durante a implantação. Ao registrar em log as informações sobre a solicitação ou resposta, você pode potencialmente expor dados confidenciais que são recuperados por meio de operações de implantação.

Dependency

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

Nome 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.

DeploymentExtended

Informações sobre a implantação.

Nome 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

Marcas de implantação

type

string

O tipo da implantação.

DeploymentMode

O modo usado para implantar recursos. Esse valor pode ser Incremental ou Complete. 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 sem querer.

Nome Tipo Description
Complete

string

Incremental

string

DeploymentPropertiesExtended

Propriedades de implantação com detalhes adicionais.

Nome 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.

duration

string

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

error

ErrorResponse

Resposta de erro
O erro de 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 do provisionamento.

templateHash

string

O hash produzido para o modelo.

templateLink

TemplateLink

O URI que faz referência ao modelo.

timestamp

string

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

validatedResources

ResourceReference[]

Matriz de recursos validados.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorResponse

Resposta de erro

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

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.

OnErrorDeploymentExtended

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

Nome Tipo Description
deploymentName

string

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

provisioningState

string

O estado do provisionamento para a implantação em caso de erro.

type

OnErrorDeploymentType

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

OnErrorDeploymentType

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

Nome Tipo Description
LastSuccessful

string

SpecificDeployment

string

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

Nome Tipo Description
contentVersion

string

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

uri

string

O URI do arquivo de parâmetros.

Provider

Informações do provedor de recursos.

Nome 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

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

Nome Tipo Description
Consented

string

NotRequired

string

NotSpecified

string

Required

string

ProviderExtendedLocation

O local estendido do provedor.

Nome Tipo Description
extendedLocations

string[]

Os locais estendidos para o local do azure.

location

string

O local do azure.

type

string

O tipo de local estendido.

ProviderResourceType

Tipo de recurso gerenciado pelo provedor de recursos.

Nome Tipo Description
aliases

Alias[]

Os aliases compatíveis com esse 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 localização compatíveis com esse tipo de recurso.

locations

string[]

A coleção de locais em que esse tipo de recurso pode ser criado.

properties

object

As propriedades.

resourceType

string

O tipo de recurso.

zoneMappings

ZoneMapping[]

ProvisioningState

Indica o estado do provisionamento.

Nome Tipo Description
Accepted

string

Canceled

string

Created

string

Creating

string

Deleted

string

Deleting

string

Failed

string

NotSpecified

string

Ready

string

Running

string

Succeeded

string

Updating

string

ResourceReference

O modelo de ID do recurso.

Nome Tipo Description
id

string

A ID do recurso totalmente qualificado.

Entidade que representa a referência para o modelo.

Nome Tipo Description
contentVersion

string

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

id

string

A ID de recurso de uma Especificação de Modelo. 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 tiver sido 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 ambos.

ZoneMapping

Nome Tipo Description
location

string

O local do mapeamento de zona.

zones

string[]