az deployment group

  • Referência

Gerencie a implantação de modelo do Azure Resource Manager no grupo de recursos.

Comandos

Name Description Tipo Status
az deployment group cancel

Cancelar uma implantação no grupo de recursos.

 Principal GA
az deployment group create

Inicie uma implantação no grupo de recursos.

 Principal GA
az deployment group delete

Exclua uma implantação no grupo de recursos.

 Principal GA
az deployment group export

Exporte o modelo usado para uma implantação.

 Principal GA
az deployment group list

Listar implantações no grupo de recursos.

 Principal GA
az deployment group show

Mostrar uma implantação no grupo de recursos.

 Principal GA
az deployment group validate

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

 Principal GA
az deployment group wait

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

 Principal GA
az deployment group what-if

Execute uma operação hipotética de implantação no escopo do grupo de recursos.

 Principal 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 Obrigatórios

--name -n

O nome da implantação.

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az deployment group create

Editar

Inicie uma implantação no grupo de recursos.

Por favor, especifique apenas um dos --template-file 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 Obrigatórios

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

Subscrições auxiliares que serão utilizadas durante a implementação entre inquilinos.

--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 da implantação antes de executar a implantação. Em seguida, ele solicita que você reconheça as alterações de recursos antes que elas continuem.

--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 aceites: Complete, Incremental
Default value: 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 predefinido é false.

Valores aceites: false, true
Default value: False
--no-wait

Não espere que a operação de longa duração termine.

Default value: False
--parameters -p

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

Os parâmetros podem ser fornecidos a partir 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 seu arquivo de parâmetros primeiro e, em seguida, substitua seletivamente usando a sintaxe KEY=VALUE. Observe também que se você estiver fornecendo um arquivo bicepparam, então você pode usar esse argumento apenas uma vez.

--proceed-if-no-change

Instrua o comando para executar a implantação se o resultado de hipóteses 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 no 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 para executar o What-If.

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

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

Valores aceites: 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 é definido.

Valores aceites: FullResourcePayloads, ResourceIdOnly
Default value: FullResourcePayloads
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az deployment group delete

Editar

Exclua uma implantação no grupo de recursos.

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

Exemplos

Exclua uma implantação no grupo de recursos.

az deployment group delete -g testrg -n deployment01

Parâmetros Obrigatórios

--name -n

O nome da implantação.

--resource-group -g

o 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 espere que a operação de longa duração termine.

Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az deployment group export

Editar

Exporte 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 Obrigatórios

--name -n

O nome da implantação.

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 Obrigatórios

--resource-group -g

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

Parâmetros Opcionais

--filter
Pré-visualizar

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 Obrigatórios

--name -n

O nome da implantação.

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az deployment group validate

Editar

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

Por favor, especifique apenas um dos --template-file 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

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

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

Valide 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 Obrigatórios

--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 aceites: Complete, Incremental
Default value: 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 predefinido é false.

Valores aceites: false, true
Default value: False
--parameters -p

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

Os parâmetros podem ser fornecidos a partir 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 seu 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 no 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 Obrigatórios

--name -n

O nome da implantação.

--resource-group -g

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

Parâmetros Opcionais

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Default value: 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.

Default value: False
--exists

Aguarde até que o recurso exista.

Default value: False
--interval

Intervalo de sondagem em segundos.

Default value: 30
--timeout

Espera máxima em segundos.

Default value: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az deployment group what-if

Editar

Execute uma operação hipotética de implantação no escopo do grupo de recursos.

Por favor, especifique apenas um dos --template-file 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

Execute 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 hipotética 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 hipotética 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 Obrigatórios

--resource-group -g

O grupo de recursos para 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 de tipos de alteração de recursos a serem excluídos dos resultados de hipóteses.

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

O modo de implantação.

Valores aceites: Complete, Incremental
Default value: Incremental
--name -n

O nome da implantação.

--no-pretty-print

Desative a impressão bonita para 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 predefinido é false.

Valores aceites: false, true
Default value: False
--parameters -p

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

Os parâmetros podem ser fornecidos a partir 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 seu 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 aceites: FullResourcePayloads, ResourceIdOnly
Default value: 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.