az deployment mg

  • Referência

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

Comandos

Name Description Tipo Estado
az deployment mg cancel

Cancelar uma implantação no grupo de gerenciamento.

 Principal GA
az deployment mg create

Inicie uma implantação no grupo de gerenciamento.

 Principal GA
az deployment mg delete

Exclua uma implantação no grupo de gerenciamento.

 Principal GA
az deployment mg export

Exporte o modelo usado para uma implantação.

 Principal GA
az deployment mg list

Listar implantações no grupo de gerenciamento.

 Principal GA
az deployment mg show

Mostrar uma implantação no grupo de gerenciamento.

 Principal GA
az deployment mg validate

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

 Principal GA
az deployment mg wait

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

 Principal GA
az deployment mg what-if

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

 Principal GA

az deployment mg cancel

Editar

Cancelar uma implantação no grupo de gerenciamento.

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

Exemplos

Cancelar uma implantação no grupo de gerenciamento.

az deployment mg cancel -m testmg -n deployment01

Parâmetros Obrigatórios

--management-group-id -m

A ID do grupo de gerenciamento.

--name -n

O nome da implantação.

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
valor predefinido: 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 mg create

Editar

Inicie uma implantação no grupo de gerenciamento.

Por favor, especifique apenas um dos --template-file FILE | --template-uri URI | --template-spec para inserir o modelo 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 a partir 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 Obrigatórios

--location -l

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

--management-group-id -m

A ID do grupo de gerenciamento para criar a implantação em.

Parâmetros Opcionais

--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 usado para implantar recursos. Esse valor pode ser Incremental ou Completo. 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 involuntariamente.

valores aceites: Complete, Incremental
valor predefinido: 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
valor predefinido: False
--no-wait

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

valor predefinido: 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.

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

--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
valor predefinido: 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
valor predefinido: 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 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 Obrigatórios

--management-group-id -m

A ID do grupo de gerenciamento.

--name -n

O nome da implantação.

Parâmetros Opcionais

--no-wait

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

valor predefinido: 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
valor predefinido: 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 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 Obrigatórios

--management-group-id -m

A ID do grupo de gerenciamento.

--name -n

O nome da implantação.

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
valor predefinido: 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 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 Obrigatórios

--management-group-id -m

A ID do grupo de gerenciamento.

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
valor predefinido: 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 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 Obrigatórios

--management-group-id -m

A ID do grupo de gerenciamento.

--name -n

O nome da implantação.

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
valor predefinido: 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 mg validate

Editar

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

Por favor, especifique apenas um dos --template-file FILE | --template-uri URI | --template-spec para inserir o modelo 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 Obrigatórios

--location -l

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

--management-group-id -m

A ID do grupo de gerenciamento para criar a implantação em.

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 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
valor predefinido: 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.

--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
valor predefinido: 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 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 Obrigatórios

--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 predefinido: 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 predefinido: False
--exists

Aguarde até que o recurso exista.

valor predefinido: False
--interval

Intervalo de sondagem em segundos.

valor predefinido: 30
--timeout

Espera máxima em segundos.

valor predefinido: 3600
--updated

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

valor predefinido: 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
valor predefinido: 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 mg what-if

Editar

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

Por favor, especifique apenas um dos --template-file FILE | --template-uri URI | --template-spec para inserir o modelo 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 hipotética de implantação 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 hipotética de implantação 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 hipotética de implantação em um grupo de gerenciamento sem imprimir o resultado de forma bonita.

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

--location -l

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

--management-group-id -m

A ID do grupo de gerenciamento para criar a implantação em.

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 de hipóteses.

valores aceites: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported
--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
valor predefinido: 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
valor predefinido: 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
valor predefinido: 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.