az deployment group

  • Referência

Gerenciar a implantação de modelo do Gerenciador de Recursos do Azure no grupo de recursos.

Comandos

Nome Description Tipo Status
az deployment group cancel

Cancelar uma implantação no grupo de recursos.

 Núcleo GA
az deployment group create

Inicie uma implantação no grupo de recursos.

 Núcleo GA
az deployment group delete

Excluir uma implantação no grupo de recursos.

 Núcleo GA
az deployment group export

Exportar o modelo usado para uma implantação.

 Núcleo GA
az deployment group list

Listar implantações no grupo de recursos.

 Núcleo GA
az deployment group show

Mostrar uma implantação no grupo de recursos.

 Núcleo GA
az deployment group validate

Validar se um modelo é válido no grupo de recursos.

 Núcleo GA
az deployment group wait

Coloque a CLI em um estado de espera até que uma condição de implantação seja atendida.

 Núcleo GA
az deployment group what-if

Execute uma operação de Hipóteses de implantação no escopo do grupo de recursos.

 Núcleo GA

az deployment group cancel

Editar

Cancelar uma implantação no grupo de recursos.

az deployment group cancel --name
                           --resource-group

Exemplos

Cancelar uma implantação no grupo de recursos.

az deployment group cancel -g testrg -n deployment01

Parâmetros Exigidos

--name -n

O nome da implantação.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az deployment group create

Editar

Inicie uma implantação no grupo de recursos.

Especifique apenas um dos arquivos --template-file | --template-uri URI | --template-spec para inserir o modelo ARM.

az deployment group create --resource-group
                           [--aux-subs]
                           [--aux-tenants]
                           [--confirm-with-what-if]
                           [--handle-extended-json-format]
                           [--mode {Complete, Incremental}]
                           [--name]
                           [--no-prompt {false, true}]
                           [--no-wait]
                           [--parameters]
                           [--proceed-if-no-change]
                           [--query-string]
                           [--rollback-on-error]
                           [--template-file]
                           [--template-spec]
                           [--template-uri]
                           [--what-if]
                           [--what-if-exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                           [--what-if-result-format {FullResourcePayloads, ResourceIdOnly}]

Exemplos

Crie uma implantação no grupo de recursos a partir de um arquivo de modelo remoto, usando parâmetros de um arquivo JSON local.

az deployment group create --resource-group testrg --name rollout01 \
    --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

Crie uma implantação no grupo de recursos a partir de um arquivo de modelo local, usando parâmetros de uma cadeia de caracteres JSON.

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json  \
    --parameters '{ \"policyName\": { \"value\": \"policy2\" } }'

Crie uma implantação no grupo de recursos a partir de um arquivo de modelo local, usando parâmetros de uma cadeia de caracteres de matriz.

az deployment group create --resource-group testgroup --template-file demotemplate.json --parameters exampleString='inline string' exampleArray='("value1", "value2")'

Crie uma implantação no grupo de recursos a partir de um modelo local, usando um arquivo de parâmetro, um arquivo de parâmetro remoto e substituindo seletivamente pares chave/valor.

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json  --parameters @params.json \
    --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json

Criar uma implantação no escopo do grupo de recursos a partir de uma especificação de modelo

az deployment group create --resource-group testrg --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0"

Criar uma implantação no escopo do grupo de recursos a partir de um arquivo de parâmetro bicepparam

az deployment group create --resource-group testrg --parameters parameters.bicepparam

Criar uma implantação no grupo de recursos entre locatários

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json --parameters @myparameters.json --aux-tenants auxiliary_tenant01 auxiliary_tenant02

Parâmetros Exigidos

--resource-group -g

O grupo de recursos no qual criar a implantação.

Parâmetros Opcionais

--aux-subs
Preterido

A opção '--aux-subs' foi preterida e será removida em uma versão futura. Em vez disso, use '--aux-tenants'.

Assinaturas auxiliares que serão usadas durante a implantação entre locatários.

--aux-tenants

Locatários auxiliares que serão usados durante a implantação entre locatários.

--confirm-with-what-if -c

Instrua o comando a executar o What-If de implantação antes de executar a implantação. Em seguida, ele solicita que você reconheça as alterações de recursos antes de continuar.

--handle-extended-json-format -j
Preterido

A opção '--handle-extended-json-format/-j' foi preterida e será removida em uma versão futura.

Suporte para lidar com conteúdo de modelo estendido, incluindo várias linhas e comentários na implantação.

--mode

O modo de implantação.

Valores aceitos: Complete, Incremental
Valor padrão: Incremental
--name -n

O nome da implantação.

--no-prompt

A opção para desativar o prompt de parâmetros ausentes para o modelo ARM. Quando o valor for true, o prompt que exige que os usuários forneçam o parâmetro ausente será ignorado. O valor padrão é false.

Valores aceitos: false, true
Valor padrão: False
--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--parameters -p

Forneça valores de parâmetros de implantação.

Os parâmetros podem ser fornecidos de um arquivo usando a @{path} sintaxe, uma cadeia de caracteres JSON ou como <pares KEY=VALUE> . Os parâmetros são avaliados em ordem, portanto, quando um valor é atribuído duas vezes, o último valor será usado. É recomendável que você forneça o arquivo de parâmetros primeiro e, em seguida, substitua seletivamente usando a sintaxe KEY=VALUE. Observe também se você estiver fornecendo um arquivo bicepparam então você pode usar esse argumento apenas uma vez.

--proceed-if-no-change

Instrua o comando a executar a implantação se o resultado do What-If não contiver alterações de recursos. Aplicável quando --confirm-with-what-if está definido.

--query-string -q

A cadeia de caracteres de consulta (um token SAS) a ser usada com o template-uri no caso de modelos vinculados.

--rollback-on-error

O nome de uma implantação para reverter para o erro ou usar como um sinalizador para reverter para a última implantação bem-sucedida.

--template-file -f

O caminho para o arquivo de modelo ou arquivo Bicep.

--template-spec -s

A id do recurso de especificação do modelo.

--template-uri -u

O URI para o arquivo de modelo.

--what-if -w

Instrua o comando a executar o What-If.

--what-if-exclude-change-types -x

Lista separada por espaço dos tipos de alteração de recursos a serem excluídos dos resultados hipotéticos. Aplicável quando --confirm-with-what-if está definido.

Valores aceitos: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported
--what-if-result-format -r

O formato dos resultados hipotéticos. Aplicável quando --confirm-with-what-if está definido.

Valores aceitos: FullResourcePayloads, ResourceIdOnly
Valor padrão: FullResourcePayloads
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az deployment group delete

Editar

Excluir uma implantação no grupo de recursos.

az deployment group delete --name
                           --resource-group
                           [--no-wait]

Exemplos

Excluir uma implantação no grupo de recursos.

az deployment group delete -g testrg -n deployment01

Parâmetros Exigidos

--name -n

O nome da implantação.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az deployment group export

Editar

Exportar o modelo usado para uma implantação.

az deployment group export --name
                           --resource-group

Exemplos

Exporte o modelo usado para uma implantação no grupo de recursos.

az deployment group export --resource-group testrg --name MyDeployment

Parâmetros Exigidos

--name -n

O nome da implantação.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az deployment group list

Editar

Listar implantações no grupo de recursos.

az deployment group list --resource-group
                         [--filter]

Exemplos

Listar implantações no grupo de recursos.

az deployment group list -g testrg

Parâmetros Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--filter
Versão Prévia

Expressão de filtro usando notação OData. Você pode usar --filter "provisioningState eq '{state}'" para filtrar provisioningState. Para obter mais informações, acesse https://docs.microsoft.com/rest/api/resources/deployments/listatsubscriptionscope#uri-parameters.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az deployment group show

Editar

Mostrar uma implantação no grupo de recursos.

az deployment group show --name
                         --resource-group

Exemplos

Mostrar uma implantação no grupo de recursos.

az deployment group show -g testrg -n deployment01

Parâmetros Exigidos

--name -n

O nome da implantação.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az deployment group validate

Editar

Validar se um modelo é válido no grupo de recursos.

Especifique apenas um dos arquivos --template-file | --template-uri URI | --template-spec para inserir o modelo ARM.

az deployment group validate --resource-group
                             [--handle-extended-json-format]
                             [--mode {Complete, Incremental}]
                             [--name]
                             [--no-prompt {false, true}]
                             [--parameters]
                             [--query-string]
                             [--rollback-on-error]
                             [--template-file]
                             [--template-spec]
                             [--template-uri]

Exemplos

Validar se um modelo é válido no grupo de recursos.

az deployment group validate --resource-group testrg --template-file {template-file}

Validar se um modelo é válido no grupo de recursos. (gerado automaticamente)

az deployment group validate --parameters MyValue=This MyArray=@array.json --resource-group testrg --template-file azuredeploy.json

Parâmetros Exigidos

--resource-group -g

O grupo de recursos no qual criar a implantação.

Parâmetros Opcionais

--handle-extended-json-format -j
Preterido

A opção '--handle-extended-json-format/-j' foi preterida e será removida em uma versão futura.

Suporte para lidar com conteúdo de modelo estendido, incluindo várias linhas e comentários na implantação.

--mode

O modo de implantação.

Valores aceitos: Complete, Incremental
Valor padrão: Incremental
--name -n

O nome da implantação.

--no-prompt

A opção para desativar o prompt de parâmetros ausentes para o modelo ARM. Quando o valor for true, o prompt que exige que os usuários forneçam o parâmetro ausente será ignorado. O valor padrão é false.

Valores aceitos: false, true
Valor padrão: False
--parameters -p

Forneça valores de parâmetros de implantação.

Os parâmetros podem ser fornecidos de um arquivo usando a @{path} sintaxe, uma cadeia de caracteres JSON ou como <pares KEY=VALUE> . Os parâmetros são avaliados em ordem, portanto, quando um valor é atribuído duas vezes, o último valor será usado. É recomendável que você forneça o arquivo de parâmetros primeiro e, em seguida, substitua seletivamente usando a sintaxe KEY=VALUE.

--query-string -q

A cadeia de caracteres de consulta (um token SAS) a ser usada com o template-uri no caso de modelos vinculados.

--rollback-on-error

O nome de uma implantação para reverter para o erro ou usar como um sinalizador para reverter para a última implantação bem-sucedida.

--template-file -f

O caminho para o arquivo de modelo ou arquivo Bicep.

--template-spec -s

A id do recurso de especificação do modelo.

--template-uri -u

O URI para o arquivo de modelo.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az deployment group wait

Editar

Coloque a CLI em um estado de espera até que uma condição de implantação seja atendida.

az deployment group wait --name
                         --resource-group
                         [--created]
                         [--custom]
                         [--deleted]
                         [--exists]
                         [--interval]
                         [--timeout]
                         [--updated]

Exemplos

Coloque a CLI em um estado de espera até que uma condição de implantação seja atendida. (gerado automaticamente)

az deployment group wait --created --name MyDeployment --resource-group MyResourceGroup

Parâmetros Exigidos

--name -n

O nome da implantação.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--created

Aguarde até criar com 'provisioningState' em 'Succeeded'.

Valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

Valor padrão: False
--exists

Aguarde até que o recurso exista.

Valor padrão: False
--interval

Intervalo de sondagem em segundos.

Valor padrão: 30
--timeout

Espera máxima em segundos.

Valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az deployment group what-if

Editar

Execute uma operação de Hipóteses de implantação no escopo do grupo de recursos.

Especifique apenas um dos arquivos --template-file | --template-uri URI | --template-spec para inserir o modelo ARM.

az deployment group what-if --resource-group
                            [--aux-tenants]
                            [--exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                            [--mode {Complete, Incremental}]
                            [--name]
                            [--no-pretty-print]
                            [--no-prompt {false, true}]
                            [--parameters]
                            [--query-string]
                            [--result-format {FullResourcePayloads, ResourceIdOnly}]
                            [--template-file]
                            [--template-spec]
                            [--template-uri]

Exemplos

Executar uma operação hipotética de implantação em um grupo de recursos.

az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

Execute uma operação What-If de implantação em um grupo de recursos com o formato ResourceIdOnly.

az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly

Execute uma operação de Hipóteses de implantação em um grupo de recursos sem imprimir o resultado.

az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print

Parâmetros Exigidos

--resource-group -g

O grupo de recursos no qual executar a operação What-If de implantação.

Parâmetros Opcionais

--aux-tenants

Locatários auxiliares que serão usados durante a implantação entre locatários.

--exclude-change-types -x

Lista separada por espaço dos tipos de alteração de recursos a serem excluídos dos resultados hipotéticos.

Valores aceitos: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported
--mode

O modo de implantação.

Valores aceitos: Complete, Incremental
Valor padrão: Incremental
--name -n

O nome da implantação.

--no-pretty-print

Desative a impressão bonita para obter resultados hipotéticos. Quando definido, o tipo de formato de saída será usado.

--no-prompt

A opção para desativar o prompt de parâmetros ausentes para o modelo ARM. Quando o valor for true, o prompt que exige que os usuários forneçam o parâmetro ausente será ignorado. O valor padrão é false.

Valores aceitos: false, true
Valor padrão: False
--parameters -p

Forneça valores de parâmetros de implantação.

Os parâmetros podem ser fornecidos de um arquivo usando a @{path} sintaxe, uma cadeia de caracteres JSON ou como <pares KEY=VALUE> . Os parâmetros são avaliados em ordem, portanto, quando um valor é atribuído duas vezes, o último valor será usado. É recomendável que você forneça o arquivo de parâmetros primeiro e, em seguida, substitua seletivamente usando a sintaxe KEY=VALUE.

--query-string -q

A cadeia de caracteres de consulta (um token SAS) a ser usada com o template-uri no caso de modelos vinculados.

--result-format -r

O formato dos resultados hipotéticos.

Valores aceitos: FullResourcePayloads, ResourceIdOnly
Valor padrão: FullResourcePayloads
--template-file -f

O caminho para o arquivo de modelo ou arquivo Bicep.

--template-spec -s

A id do recurso de especificação do modelo.

--template-uri -u

O URI para o arquivo de modelo.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.