az deployment tenant

  • Referência

Gerencie a implantação do modelo do Azure Resource Manager no escopo do locatário.

Comandos

Name Description Tipo Estado
az deployment tenant cancel

Cancele uma implantação no escopo do locatário.

 Principal GA
az deployment tenant create

Inicie uma implantação no escopo do locatário.

 Principal GA
az deployment tenant delete

Exclua uma implantação no escopo do locatário.

 Principal GA
az deployment tenant export

Exporte o modelo usado para uma implantação.

 Principal GA
az deployment tenant list

Listar implantações no escopo do locatário.

 Principal GA
az deployment tenant show

Mostrar uma implantação no escopo do locatário.

 Principal GA
az deployment tenant validate

Valide se um modelo é válido no escopo do locatário.

 Principal GA
az deployment tenant wait

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

 Principal GA
az deployment tenant what-if

Execute uma operação hipotética de implantação no escopo do locatário.

 Principal GA

az deployment tenant cancel

Editar

Cancele uma implantação no escopo do locatário.

az deployment tenant cancel --name

Exemplos

Cancele uma implantação no escopo do locatário.

az deployment tenant cancel -n deployment01

Parâmetros Obrigatórios

--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 tenant create

Editar

Inicie uma implantação no escopo do locatário.

Por favor, especifique apenas um dos --template-file FILE | --template-uri URI | --template-spec para inserir o modelo ARM.

az deployment tenant create --location
                            [--confirm-with-what-if]
                            [--handle-extended-json-format]
                            [--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 escopo do locatário a partir de um arquivo de modelo remoto, usando parâmetros de um arquivo JSON local.

az deployment tenant create --name rollout01 --location WestUS \
    --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

Crie uma implantação no escopo do locatário a partir de um arquivo de modelo local, usando parâmetros de uma cadeia de caracteres JSON.

az deployment tenant create --name rollout01 --location WestUS \
    --template-file azuredeploy.json \
    --parameters '{ \"policyName\": { \"value\": \"policy2\" } }'

Crie uma implantação no escopo do locatário 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 tenant create --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.

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.

--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 tenant delete

Editar

Exclua uma implantação no escopo do locatário.

az deployment tenant delete --name
                            [--no-wait]

Exemplos

Exclua uma implantação no escopo do locatário.

az deployment tenant delete -n deployment01

Parâmetros Obrigatórios

--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 tenant export

Editar

Exporte o modelo usado para uma implantação.

az deployment tenant export --name

Exemplos

Exporte o modelo usado para uma implantação no escopo do locatário.

az deployment tenant export --name MyDeployment

Parâmetros Obrigatórios

--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 tenant list

Editar

Listar implantações no escopo do locatário.

az deployment tenant list [--filter]

Exemplos

Listar implantações no escopo do locatário.

az deployment tenant list

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 tenant show

Editar

Mostrar uma implantação no escopo do locatário.

az deployment tenant show --name

Exemplos

Mostrar uma implantação no escopo do locatário.

az deployment tenant show -n deployment01

Parâmetros Obrigatórios

--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 tenant validate

Editar

Valide se um modelo é válido no escopo do locatário.

Por favor, especifique apenas um dos --template-file FILE | --template-uri URI | --template-spec para inserir o modelo ARM.

az deployment tenant validate --location
                              [--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 escopo do locatário.

az deployment tenant validate --location WestUS --template-file {template-file}

Valide se um modelo é válido no escopo do locatário. (gerado automaticamente)

az deployment tenant validate --location WestUS --name mydeployment --parameters @myparameters.json --template-file azuredeploy.json

Parâmetros Obrigatórios

--location -l

O local para armazenar os metadados de 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 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 tenant wait

Editar

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

az deployment tenant wait --name
                          [--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 tenant wait --deleted --name MyDeployment

Parâmetros Obrigatórios

--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 tenant what-if

Editar

Execute uma operação hipotética de implantação no escopo do locatário.

Por favor, especifique apenas um dos --template-file FILE | --template-uri URI | --template-spec para inserir o modelo ARM.

az deployment tenant what-if --location
                             [--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 no escopo do locatário.

az deployment tenant what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

Execute uma operação hipotética de implantação no escopo do locatário com o formato ResourceIdOnly.

az deployment tenant what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly

Execute uma operação hipotética de implantação no escopo do locatário sem imprimir o resultado.

az deployment tenant what-if --location WestUS --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print

Parâmetros Obrigatórios

--location -l

O local para armazenar os metadados da operação What-If de 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 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.