Deployments - Validate At Management Group Scope

Serviço:

Resource Management

Versão da API:

2021-04-01

Valida se o modelo especificado está sintaticamente correto e será aceite pelo Azure Resource Manager..

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate?api-version=2021-04-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
deploymentName	path	True	string	O nome da implementação. Padrão Regex: ^[-\w\._\(\)]+$
groupId	path	True	string	O ID do grupo de gestão.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
location	True	string	A localização para armazenar os dados de implementação.
properties	True	DeploymentProperties	As propriedades de implementação.
tags		object	Etiquetas de implementação

Respostas

Name	Tipo	Description
200 OK	DeploymentValidateResult	OK - Devolve o resultado da validação.
202 Accepted		Aceite – o pedido foi aceite para processamento e a operação será concluída de forma assíncrona.
400 Bad Request	DeploymentValidateResult	Devolve o resultado da validação.
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Âmbitos

Name	Description
user_impersonation	representar 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 a que o caminho do alias se refere.
AliasPathMetadata
AliasPathTokenType	O tipo de token a que o caminho do alias se refere.
AliasPattern	O tipo do padrão para um caminho de alias.
AliasPatternType	O tipo de padrão de alias
AliasType	O tipo de alias.
ApiProfile
BasicDependency	Informações de dependência de implementação.
CloudError	Uma resposta de erro para um pedido de gestão de recursos.
DebugSetting	A definição de depuração.
Dependency	Informações de dependência de implementação.
DeploymentMode	O modo utilizado para implementar recursos. Este valor pode ser Incremental ou Complete. No modo Incremental, os recursos são implementados sem eliminar recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implementados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são eliminados. Tenha cuidado ao utilizar o Modo completo, uma vez que pode eliminar recursos involuntariamente.
DeploymentProperties	Propriedades de implementação.
DeploymentPropertiesExtended	Propriedades de implementação com detalhes adicionais.
DeploymentValidateResult	Informações de validar a resposta de implementação de modelos.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorResponse	Resposta a Erros
ExpressionEvaluationOptions	Especifica se as expressões de modelo são avaliadas no âmbito do modelo principal ou do modelo aninhado.
ExpressionEvaluationOptionsScopeType	O âmbito a utilizar para a avaliação de parâmetros, variáveis e funções num modelo aninhado.
OnErrorDeployment	Implementação no comportamento do erro.
OnErrorDeploymentExtended	Implementação no comportamento do erro com detalhes adicionais.
OnErrorDeploymentType	A implementaçã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 implementação.
Provider	Informações do fornecedor de recursos.
ProviderAuthorizationConsentState	O estado de consentimento da autorização do fornecedor.
ProviderExtendedLocation	A localização expandida do fornecedor.
ProviderResourceType	Tipo de recurso gerido pelo fornecedor de recursos.
ProvisioningState	Indica o estado do aprovisionamento.
ResourceReference	O modelo de ID do recurso.
ScopedDeployment	Parâmetros da operação de implementação.
TemplateLink	Entidade que representa a referência ao modelo.
ZoneMapping

Alias

O tipo de alias.

Name	Tipo	Description
defaultMetadata	AliasPathMetadata	Os metadados do caminho do alias predefinido. Aplica-se ao caminho predefinido e a qualquer caminho de alias que não tenha metadados
defaultPath	string	O caminho predefinido para um alias.
defaultPattern	AliasPattern	O padrão predefinido para um alias.
name	string	O nome do alias.
paths	AliasPath[]	Os caminhos para um alias.
type	AliasType	O tipo de alias.

AliasPath

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 em falta, recue para os metadados predefinidos do alias.
path	string	O caminho de um alias.
pattern	AliasPattern	O padrão para um caminho de alias.

AliasPathAttributes

Os atributos do token a que o caminho do alias se refere.

Name	Tipo	Description
Modifiable	string	O token a que o caminho do alias se refere é modificável por políticas com efeito "modificar".
None	string	O token a que o caminho do alias se refere não tem atributos.

AliasPathMetadata

Name	Tipo	Description
attributes	AliasPathAttributes	Os atributos do token a que o caminho do alias se refere.
type	AliasPathTokenType	O tipo de token a que o caminho do alias se refere.

AliasPathTokenType

O tipo de token a que o caminho do alias se refere.

Name	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 é booleano.
Integer	string	O tipo de token é número inteiro.
NotSpecified	string	O tipo de token não é especificado.
Number	string	O tipo de token é número.
Object	string	O tipo de token é objeto.
String	string	O tipo de token é cadeia.

AliasPattern

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

Name	Tipo	Description
phrase	string	A expressão de 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

Name	Tipo	Description
Extract	string	Extrair é o único valor permitido.
NotSpecified	string	Não é permitido notSpecified.

AliasType

O tipo de alias.

Name	Tipo	Description
Mask	string	O valor do alias é secreto.
NotSpecified	string	O tipo de alias é desconhecido (o mesmo que não fornecer o tipo de alias).
PlainText	string	O valor do alias não é secreto.

ApiProfile

Name	Tipo	Description
apiVersion	string	A versão da API.
profileVersion	string	A versão do perfil.

BasicDependency

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

Name	Tipo	Description
id	string	O 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 um pedido de gestão de recursos.

Name	Tipo	Description
error	ErrorResponse	Resposta a Erros Resposta de erro comum para todas as APIs Resource Manager do Azure para devolver detalhes de erro para operações falhadas. (Isto também segue o formato de resposta a erros OData.)

DebugSetting

A definição de depuração.

Name	Tipo	Description
detailLevel	string	Especifica o tipo de informações a registar para depuração. Os valores permitidos não são nenhum, requestContent, responseContent ou requestContent e responseContent separados por uma vírgula. A predefinição é Nenhum. Ao definir este valor, considere cuidadosamente o tipo de informação que está a transmitir durante a implementação. Ao registar informações sobre o pedido ou a resposta, pode potencialmente expor dados confidenciais obtidos através das operações de implementação.

Dependency

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

Name	Tipo	Description
dependsOn	BasicDependency[]	A lista de dependências.
id	string	O ID da dependência.
resourceName	string	O nome do recurso de dependência.
resourceType	string	O tipo de recurso de dependência.

DeploymentMode

O modo utilizado para implementar recursos. Este valor pode ser Incremental ou Complete. No modo Incremental, os recursos são implementados sem eliminar recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implementados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são eliminados. Tenha cuidado ao utilizar o Modo completo, uma vez que pode eliminar recursos involuntariamente.

Name	Tipo	Description
Complete	string
Incremental	string

DeploymentProperties

Propriedades de implementação.

Name	Tipo	Description
debugSetting	DebugSetting	A definição de depuração da implementação.
expressionEvaluationOptions	ExpressionEvaluationOptions	Especifica se as expressões de modelo são avaliadas no âmbito do modelo principal ou do modelo aninhado. Aplicável apenas a modelos aninhados. Se não for especificado, o valor predefinido é externo.
mode	DeploymentMode	O modo utilizado para implementar recursos. Este valor pode ser Incremental ou Complete. No modo Incremental, os recursos são implementados sem eliminar recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implementados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são eliminados. Tenha cuidado ao utilizar o Modo completo, uma vez que pode eliminar recursos involuntariamente.
onErrorDeployment	OnErrorDeployment	A implementação no comportamento do erro.
parameters	object	Pares de nomes e valores que definem os parâmetros de implementação do modelo. Utilize este elemento quando pretender fornecer os valores de parâmetros diretamente no pedido em vez de ligar a um ficheiro de parâmetro existente. Utilize a propriedade parametersLink ou a propriedade parameters, mas não ambos. Pode ser um JObject ou uma cadeia JSON bem formada.
parametersLink	ParametersLink	O URI do ficheiro de parâmetros. Utilize este elemento para ligar a um ficheiro de parâmetros existente. Utilize a propriedade parametersLink ou a propriedade parameters, mas não ambos.
template	object	O conteúdo do modelo. Utilize este elemento quando pretender transmitir a sintaxe do modelo diretamente no pedido em vez de ligar a um modelo existente. Pode ser uma cadeia JObject ou JSON bem formada. Utilize a propriedade templateLink ou a propriedade do modelo, mas não ambas.
templateLink	TemplateLink	O URI do modelo. Utilize a propriedade templateLink ou a propriedade do modelo, mas não ambas.

DeploymentPropertiesExtended

Propriedades de implementação com detalhes adicionais.

Name	Tipo	Description
correlationId	string	O ID de correlação da implementação.
debugSetting	DebugSetting	A definição de depuração da implementação.
dependencies	Dependency[]	A lista de dependências de implementação.
duration	string	A duração da implementação do modelo.
error	ErrorResponse	Resposta a Erros O erro de implementação.
mode	DeploymentMode	O modo de implementação. Os valores possíveis são Incremental e Complete.
onErrorDeployment	OnErrorDeploymentExtended	A implementação no comportamento do erro.
outputResources	ResourceReference[]	Matriz de recursos aprovisionados.
outputs	object	Pares chave/valor que representam a saída da implementação.
parameters	object	Parâmetros de implementação.
parametersLink	ParametersLink	O URI que referencia os parâmetros.
providers	Provider[]	A lista de fornecedores de recursos necessários para a implementação.
provisioningState	ProvisioningState	Indica o estado do aprovisionamento.
templateHash	string	O hash produzido para o modelo.
templateLink	TemplateLink	O URI que referencia o modelo.
timestamp	string	O carimbo de data/hora da implementação do modelo.
validatedResources	ResourceReference[]	Matriz de recursos validados.

DeploymentValidateResult

Informações de validar a resposta de implementação de modelos.

Name	Tipo	Description
error	ErrorResponse	Resposta a Erros O erro de validação da implementação.
properties	DeploymentPropertiesExtended	As propriedades de implementação do modelo.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorResponse

Resposta a Erros

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

ExpressionEvaluationOptions

Especifica se as expressões de modelo são avaliadas no âmbito do modelo principal ou do modelo aninhado.

Name	Tipo	Description
scope	ExpressionEvaluationOptionsScopeType	O âmbito a utilizar para a avaliação de parâmetros, variáveis e funções num modelo aninhado.

ExpressionEvaluationOptionsScopeType

O âmbito a utilizar para a avaliação de parâmetros, variáveis e funções num modelo aninhado.

Name	Tipo	Description
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Implementação no comportamento do erro.

Name	Tipo	Description
deploymentName	string	A implementação a ser utilizada em caso de erro.
type	OnErrorDeploymentType	A implementação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment.

OnErrorDeploymentExtended

Implementação no comportamento do erro com detalhes adicionais.

Name	Tipo	Description
deploymentName	string	A implementação a ser utilizada em caso de erro.
provisioningState	string	O estado do aprovisionamento para a implementação de erros.
type	OnErrorDeploymentType	A implementação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment.

OnErrorDeploymentType

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

Name	Tipo	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

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

Name	Tipo	Description
contentVersion	string	Se estiver incluído, tem de corresponder ao ContentVersion no modelo.
uri	string	O URI do ficheiro de parâmetros.

Provider

Informações do fornecedor de recursos.

Name	Tipo	Description
id	string	O ID do fornecedor.
namespace	string	O espaço de nomes do fornecedor de recursos.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	O estado de consentimento da autorização do fornecedor.
registrationPolicy	string	A política de registo do fornecedor de recursos.
registrationState	string	O estado de registo do fornecedor de recursos.
resourceTypes	ProviderResourceType[]	A coleção de tipos de recursos do fornecedor.

ProviderAuthorizationConsentState

O estado de consentimento da autorização do fornecedor.

Name	Tipo	Description
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderExtendedLocation

A localização expandida do fornecedor.

Name	Tipo	Description
extendedLocations	string[]	As localizações expandidas para a localização do azure.
location	string	A localização do azure.
type	string	O tipo de localização expandida.

ProviderResourceType

Tipo de recurso gerido pelo fornecedor de recursos.

Name	Tipo	Description
aliases	Alias[]	Os aliases suportados por este tipo de recurso.
apiProfiles	ApiProfile[]	Os perfis de API para o fornecedor de recursos.
apiVersions	string[]	A versão da API.
capabilities	string	As capacidades adicionais oferecidas por este tipo de recurso.
defaultApiVersion	string	A versão predefinida da API.
locationMappings	ProviderExtendedLocation[]	Os mapeamentos de localização suportados por este tipo de recurso.
locations	string[]	A coleção de localizações onde este tipo de recurso pode ser criado.
properties	object	As propriedades.
resourceType	string	O tipo de recurso.
zoneMappings	ZoneMapping[]

ProvisioningState

Indica o estado do aprovisionamento.

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

Name	Tipo	Description
id	string	O ID de recurso completamente qualificado.

ScopedDeployment

Parâmetros da operação de implementação.

Name	Tipo	Description
location	string	A localização para armazenar os dados de implementação.
properties	DeploymentProperties	As propriedades de implementação.
tags	object	Etiquetas de implementação

TemplateLink

Entidade que representa a referência ao modelo.

Name	Tipo	Description
contentVersion	string	Se estiver incluído, tem de corresponder ao ContentVersion no modelo.
id	string	O ID de recurso de uma Especificação de Modelo. Utilize a propriedade ID ou URI, mas não ambas.
queryString	string	A cadeia de consulta (por exemplo, um token de SAS) a ser utilizada com o URI de templateLink.
relativePath	string	A propriedade relativePath pode ser utilizada para implementar um modelo ligado numa localização relativa ao principal. Se o modelo principal estiver ligado a um TemplateSpec, isto fará referência a um artefacto no TemplateSpec. Se o elemento principal tiver sido associado a um URI, a implementação subordinada será uma combinação dos URIs principal e relativePath
uri	string	O URI do modelo a implementar. Utilize a propriedade uri ou id, mas não ambas.

ZoneMapping

Name	Tipo	Description
location	string	A localização do mapeamento da zona.
zones	string[]