Deployments - Create Or Update At Management Group Scope
Implanta recursos no escopo do grupo de gerenciamento.
Você pode fornecer o modelo e os parâmetros diretamente na solicitação ou no link para arquivos JSON.
PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
deployment
|
path | True |
string |
O nome da implantação. Padrão Regex: |
group
|
path | True |
string |
A ID do grupo de gerenciamento. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Corpo da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
location | True |
string |
O local para armazenar os dados de implantação. |
properties | True |
As propriedades de implantação. |
|
tags |
object |
Marcas de implantação |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
OK – retorna informações sobre a implantação, incluindo status de provisionamento. |
|
201 Created |
Criado – retorna informações sobre a implantação, incluindo status de provisionamento. |
|
Other Status Codes |
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 |
Exemplos
Create deployment at management group scope.
Solicitação de exemplo
PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment?api-version=2021-04-01
{
"location": "eastus",
"properties": {
"templateLink": {
"uri": "https://example.com/exampleTemplate.json"
},
"parameters": {},
"mode": "Incremental"
}
}
Resposta de exemplo
{
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
"name": "my-deployment",
"type": "Microsoft.Resources/deployments",
"location": "eastus",
"properties": {
"parameters": {},
"mode": "Incremental",
"provisioningState": "Accepted",
"timestamp": "2019-04-24T22:52:38.7895563Z",
"duration": "PT1.2970875S",
"correlationId": "00000000-0000-0000-0000-000000000000",
"providers": [
{
"namespace": "Microsoft.Authorization",
"resourceTypes": [
{
"resourceType": "policyDefinitions",
"locations": [
null
]
},
{
"resourceType": "policyAssignments",
"locations": [
null
]
}
]
},
{
"namespace": "Microsoft.Resources",
"resourceTypes": [
{
"resourceType": "deployments",
"locations": [
"eastus"
]
}
]
}
],
"dependencies": [
{
"dependsOn": [
{
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
"resourceType": "Microsoft.Authorization/policyDefinitions",
"resourceName": "policy-definition-name"
}
],
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
"resourceType": "Microsoft.Authorization/policyAssignments",
"resourceName": "location-lock"
}
]
}
}
{
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
"name": "my-deployment",
"type": "Microsoft.Resources/deployments",
"location": "eastus",
"properties": {
"parameters": {},
"mode": "Incremental",
"provisioningState": "Accepted",
"timestamp": "2019-04-24T22:52:38.7895563Z",
"duration": "PT1.2970875S",
"correlationId": "00000000-0000-0000-0000-000000000000",
"providers": [
{
"namespace": "Microsoft.Authorization",
"resourceTypes": [
{
"resourceType": "policyDefinitions",
"locations": [
null
]
},
{
"resourceType": "policyAssignments",
"locations": [
null
]
}
]
},
{
"namespace": "Microsoft.Resources",
"resourceTypes": [
{
"resourceType": "deployments",
"locations": [
"eastus"
]
}
]
}
],
"dependencies": [
{
"dependsOn": [
{
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
"resourceType": "Microsoft.Authorization/policyDefinitions",
"resourceName": "policy-definition-name"
}
],
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
"resourceType": "Microsoft.Authorization/policyAssignments",
"resourceName": "location-lock"
}
]
}
}
Definições
Nome | Description |
---|---|
Alias |
O tipo de alias. |
Alias |
O tipo dos caminhos para alias. |
Alias |
Os atributos do token aos quais o caminho do alias está se referindo. |
Alias |
|
Alias |
O tipo do token ao qual o caminho do alias está se referindo. |
Alias |
O tipo do padrão para um caminho de alias. |
Alias |
O tipo de padrão de alias |
Alias |
O tipo do alias. |
Api |
|
Basic |
Informações de dependência de implantação. |
Cloud |
Uma resposta de erro para uma solicitação de gerenciamento de recursos. |
Debug |
A configuração de depuração. |
Dependency |
Informações de dependência de implantação. |
Deployment |
Informações sobre a implantação. |
Deployment |
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. |
Deployment |
Propriedades de implantação. |
Deployment |
Propriedades de implantação com detalhes adicionais. |
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
Resposta de erro |
Expression |
Especifica se as expressões de modelo são avaliadas dentro do escopo do modelo pai ou do modelo aninhado. |
Expression |
O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado. |
On |
Implantação no comportamento de erro. |
On |
Implantação no comportamento de erro com detalhes adicionais. |
On |
A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment. |
Parameters |
Entidade que representa a referência aos parâmetros de implantação. |
Provider |
Informações do provedor de recursos. |
Provider |
O estado de consentimento de autorização do provedor. |
Provider |
O local estendido do provedor. |
Provider |
Tipo de recurso gerenciado pelo provedor de recursos. |
Provisioning |
Indica o estado do provisionamento. |
Resource |
O modelo de ID do recurso. |
Scoped |
Parâmetros de operação de implantação. |
Template |
Entidade que representa a referência para o modelo. |
Zone |
Alias
O tipo de alias.
Nome | Tipo | Description |
---|---|---|
defaultMetadata |
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 |
O padrão padrão para um alias. |
|
name |
string |
O nome do alias. |
paths |
Os caminhos para um alias. |
|
type |
O tipo do alias. |
AliasPath
O tipo dos caminhos para alias.
Nome | Tipo | Description |
---|---|---|
apiVersions |
string[] |
As versões da API. |
metadata |
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 |
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 |
Os atributos do token aos quais o caminho do alias está se referindo. |
|
type |
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 |
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 |
Resposta de erro |
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 |
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 |
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 |
DeploymentProperties
Propriedades de implantação.
Nome | Tipo | Description |
---|---|---|
debugSetting |
A configuração de depuração da implantação. |
|
expressionEvaluationOptions |
Especifica se as expressões de modelo são avaliadas dentro do escopo do modelo pai ou do modelo aninhado. Aplicável somente a modelos aninhados. Se não for especificado, o valor padrão será externo. |
|
mode |
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. |
|
onErrorDeployment |
A implantação no comportamento de erro. |
|
parameters |
object |
Pares de nome e valor que definem os parâmetros de implantação para o modelo. Use esse elemento quando quiser fornecer os valores de parâmetro diretamente na solicitação em vez de vincular a um arquivo de parâmetro existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos. Pode ser um JObject ou uma cadeia de caracteres JSON bem formada. |
parametersLink |
O URI do arquivo de parâmetros. Use esse elemento para vincular a um arquivo de parâmetros existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos. |
|
template |
object |
O conteúdo do modelo. Use esse elemento quando quiser passar a sintaxe do modelo diretamente na solicitação, em vez de vincular a um modelo existente. Pode ser um JObject ou uma cadeia de caracteres JSON bem formada. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos. |
templateLink |
O URI do modelo. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos. |
DeploymentPropertiesExtended
Propriedades de implantação com detalhes adicionais.
Nome | Tipo | Description |
---|---|---|
correlationId |
string |
A ID de correlação da implantação. |
debugSetting |
A configuração de depuração da implantação. |
|
dependencies |
A lista de dependências de implantação. |
|
duration |
string |
A duração da implantação do modelo. |
error |
Resposta de erro |
|
mode |
O modo de implantação. Os valores possíveis são Incremental e Complete. |
|
onErrorDeployment |
A implantação no comportamento de erro. |
|
outputResources |
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 |
O URI que faz referência aos parâmetros. |
|
providers |
Provider[] |
A lista de provedores de recursos necessários para a implantação. |
provisioningState |
Indica o estado do provisionamento. |
|
templateHash |
string |
O hash produzido para o modelo. |
templateLink |
O URI que faz referência ao modelo. |
|
timestamp |
string |
O carimbo de data/hora da implantação do modelo. |
validatedResources |
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 |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
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 dentro do escopo do modelo pai ou do modelo aninhado.
Nome | Tipo | Description |
---|---|---|
scope |
O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado. |
ExpressionEvaluationOptionsScopeType
O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado.
Nome | Tipo | Description |
---|---|---|
Inner |
string |
|
NotSpecified |
string |
|
Outer |
string |
OnErrorDeployment
Implantação no comportamento de erro.
Nome | Tipo | Description |
---|---|---|
deploymentName |
string |
A implantação a ser usada em caso de erro. |
type |
A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment. |
OnErrorDeploymentExtended
Implantação no comportamento de erro com detalhes adicionais.
Nome | Tipo | Description |
---|---|---|
deploymentName |
string |
A implantação a ser usada no caso de erro. |
provisioningState |
string |
O estado do provisionamento para a implantação em caso de erro. |
type |
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 |
ParametersLink
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 |
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 |
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 |
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 |
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 |
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. |
ScopedDeployment
Parâmetros de operação de implantação.
Nome | Tipo | Description |
---|---|---|
location |
string |
O local para armazenar os dados de implantação. |
properties |
As propriedades de implantação. |
|
tags |
object |
Marcas de implantação |
TemplateLink
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[] |