Compartilhar via

az deployment mg

  • Referência

Gerenciar a implantação de modelo do Azure Resource Manager no grupo de gerenciamento.

Comandos

Nome Description Tipo Status
az deployment mg cancel

Cancele uma implantação no grupo de gerenciamento.

 Núcleo GA
az deployment mg create

Inicie uma implantação no grupo de gerenciamento.

 Núcleo GA
az deployment mg delete

Exclua uma implantação no grupo de gerenciamento.

 Núcleo GA
az deployment mg export

Exporte o modelo usado para uma implantação.

 Núcleo GA
az deployment mg list

Listar implantações no grupo de gerenciamento.

 Núcleo GA
az deployment mg show

Mostrar uma implantação no grupo de gerenciamento.

 Núcleo GA
az deployment mg validate

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

 Núcleo GA
az deployment mg wait

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

 Núcleo GA
az deployment mg what-if

Execute uma operação de implantação What-If no escopo do grupo de gerenciamento.

 Núcleo GA

az deployment mg cancel

Editar

Cancele uma implantação no grupo de gerenciamento.

az deployment mg cancel --management-group-id
                        --name

Exemplos

Cancele uma implantação no grupo de gerenciamento.

az deployment mg cancel -m testmg -n deployment01

Parâmetros Exigidos

--management-group-id -m

A ID do grupo de gerenciamento.

--name -n

O nome da implantação.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

az deployment mg create

Editar

Inicie uma implantação no grupo de gerenciamento.

Especifique apenas um de --template-file FILE | --template-uri URI | --template-spec para inserir o modelo do ARM.

az deployment mg create --location
                        --management-group-id
                        [--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]
                        [--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 gerenciamento de um arquivo de modelo remoto usando parâmetros de um arquivo JSON local.

az deployment mg create --management-group-id testrg --name rollout01 --location WestUS \
    --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

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

az deployment mg create --management-group-id testmg --name rollout01 --location WestUS \
    --template-file azuredeploy.json \
    --parameters '{ \"policyName\": { \"value\": \"policy2\" } }'

Crie uma implantação no grupo de gerenciamento 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 mg create --management-group-id testmg --name rollout01 --location WestUS \
    --template-file azuredeploy.json --parameters @params.json \
    --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json

Parâmetros Exigidos

--location -l

O local para armazenar os metadados de implantação.

--management-group-id -m

A ID do grupo de gerenciamento na qual criar a implantação.

Parâmetros Opcionais

--confirm-with-what-if -c

Instrua o comando a executar 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 usado para implantar recursos. Esse valor pode ser Incremental ou Concluído. No modo incremental, os recursos são implantados sem excluir 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.

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

O nome da implantação.

--no-prompt

A opção para desabilitar o prompt de parâmetros ausentes para o modelo do ARM. Quando o valor for verdadeiro, 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 prolongada.

Valor padrão: False
--parameters -p

Fornecer valores de parâmetro de implantação.

Os parâmetros podem ser fornecidos de um arquivo usando a sintaxe @{path}, 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 primeiro o arquivo de parâmetros e, em seguida, substitua seletivamente usando a sintaxe KEY=VALUE.

--proceed-if-no-change

Instrua o comando para executar a implantação se o resultado do What-If não contiver nenhuma alteração de recurso. 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 modelo-uri no caso de modelos vinculados.

--template-file -f

O caminho para o arquivo de modelo ou arquivo Bicep.

--template-spec -s

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

--template-uri -u

O URI para o arquivo de modelo.

--what-if -w

Instrua o comando para executar a implantação de 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 What-If. 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 de resultados What-If. Aplicável quando --confirm-with-what-if é definido.

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

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

az deployment mg delete

Editar

Exclua uma implantação no grupo de gerenciamento.

az deployment mg delete --management-group-id
                        --name
                        [--no-wait]

Exemplos

Exclua uma implantação no grupo de gerenciamento.

az deployment mg delete -m testmg -n deployment01

Parâmetros Exigidos

--management-group-id -m

A ID do grupo de gerenciamento.

--name -n

O nome da implantação.

Parâmetros Opcionais

--no-wait

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

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

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

az deployment mg export

Editar

Exporte o modelo usado para uma implantação.

az deployment mg export --management-group-id
                        --name

Exemplos

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

az deployment mg export --management-group-id testmg --name MyDeployment

Parâmetros Exigidos

--management-group-id -m

A ID do grupo de gerenciamento.

--name -n

O nome da implantação.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

az deployment mg list

Editar

Listar implantações no grupo de gerenciamento.

az deployment mg list --management-group-id
                      [--filter]

Exemplos

Listar implantações no grupo de gerenciamento.

az deployment mg list -m testmg

Parâmetros Exigidos

--management-group-id -m

A ID do grupo de gerenciamento.

Parâmetros Opcionais

--filter
Versão Prévia

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

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

az deployment mg show

Editar

Mostrar uma implantação no grupo de gerenciamento.

az deployment mg show --management-group-id
                      --name

Exemplos

Mostrar uma implantação no grupo de gerenciamento.

az deployment mg show -m testmg -n deployment01

Parâmetros Exigidos

--management-group-id -m

A ID do grupo de gerenciamento.

--name -n

O nome da implantação.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

az deployment mg validate

Editar

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

Especifique apenas um de --template-file FILE | --template-uri URI | --template-spec para inserir o modelo do ARM.

az deployment mg validate --location
                          --management-group-id
                          [--handle-extended-json-format]
                          [--name]
                          [--no-prompt {false, true}]
                          [--parameters]
                          [--query-string]
                          [--template-file]
                          [--template-spec]
                          [--template-uri]

Exemplos

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

az deployment mg validate --management-group-id testmg --location WestUS --template-file {template-file}

Valide se um modelo é válido no grupo de gerenciamento. (gerado automaticamente)

az deployment mg validate --location WestUS --management-group-id testmg --name mydeployment --parameters @myparameters.json --template-file azuredeploy.json

Parâmetros Exigidos

--location -l

O local para armazenar os metadados de implantação.

--management-group-id -m

A ID do grupo de gerenciamento na 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.

--name -n

O nome da implantação.

--no-prompt

A opção para desabilitar o prompt de parâmetros ausentes para o modelo do ARM. Quando o valor for verdadeiro, 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

Fornecer valores de parâmetro de implantação.

Os parâmetros podem ser fornecidos de um arquivo usando a sintaxe @{path}, 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 primeiro o arquivo de parâmetros 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 modelo-uri no caso de modelos vinculados.

--template-file -f

O caminho para o arquivo de modelo ou arquivo Bicep.

--template-spec -s

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

--template-uri -u

O URI para o arquivo de modelo.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

az deployment mg wait

Editar

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

az deployment mg wait --management-group-id
                      --name
                      [--created]
                      [--custom]
                      [--deleted]
                      [--exists]
                      [--interval]
                      [--timeout]
                      [--updated]

Parâmetros Exigidos

--management-group-id -m

A ID do grupo de gerenciamento.

--name -n

O nome da implantação.

Parâmetros Opcionais

--created

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

Valor padrão: False
--custom

Aguarde até que a condição atenda 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 a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

az deployment mg what-if

Editar

Execute uma operação de implantação What-If no escopo do grupo de gerenciamento.

Especifique apenas um de --template-file FILE | --template-uri URI | --template-spec para inserir o modelo do ARM.

az deployment mg what-if --location
                         --management-group-id
                         [--exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                         [--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 de implantação What-If em um grupo de gerenciamento.

az deployment mg what-if --management-group-id testmg --location westus --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

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

az deployment mg what-if --management-group-id testmg --location westus --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly

Execute uma operação de implantação What-If em um grupo de gerenciamento sem imprimir o resultado.

az deployment mg what-if --management-group-id testmg --location westus --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print

Parâmetros Exigidos

--location -l

O local para armazenar os metadados de implantação.

--management-group-id -m

A ID do grupo de gerenciamento na qual criar a implantação.

Parâmetros Opcionais

--exclude-change-types -x

Lista separada por espaço de tipos de alteração de recursos a serem excluídos dos resultados What-If.

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

O nome da implantação.

--no-pretty-print

Desabilite a impressão bonita para resultados What-If. Quando definido, o tipo de formato de saída será usado.

--no-prompt

A opção para desabilitar o prompt de parâmetros ausentes para o modelo do ARM. Quando o valor for verdadeiro, 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

Fornecer valores de parâmetro de implantação.

Os parâmetros podem ser fornecidos de um arquivo usando a sintaxe @{path}, 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 primeiro o arquivo de parâmetros 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 modelo-uri no caso de modelos vinculados.

--result-format -r

O formato de resultados What-If.

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 de modelo.

--template-uri -u

O URI para o arquivo de modelo.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.