az blueprint

Referência

Observação

Essa referência faz parte da extensão de blueprint para a CLI do Azure (versão 2.50.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az blueprint . Saiba mais sobre extensões.

Comandos para gerenciar o blueprint.

Comandos

Nome	Description	Tipo	Status
az blueprint artifact	Comandos para gerenciar o artefato do blueprint.	Extensão	GA
az blueprint artifact delete	Exclua um artefato de blueprint.	Extensão	Versão Prévia
az blueprint artifact list	Listar artefatos para uma determinada definição de blueprint.	Extensão	Versão Prévia
az blueprint artifact policy	Comandos para gerenciar o artefato de atribuição de política de blueprint.	Extensão	GA
az blueprint artifact policy create	Criar artefato de política de blueprint.	Extensão	GA
az blueprint artifact policy update	Atualizar artefato de política de blueprint.	Extensão	GA
az blueprint artifact role	Comandos para gerenciar o artefato de atribuição de função do blueprint.	Extensão	GA
az blueprint artifact role create	Criar artefato de função de blueprint.	Extensão	GA
az blueprint artifact role update	Atualizar artefato de função do blueprint.	Extensão	GA
az blueprint artifact show	Obtenha um artefato de blueprint.	Extensão	Versão Prévia
az blueprint artifact template	Comandos para gerenciar o artefato de modelo ARM do blueprint.	Extensão	GA
az blueprint artifact template create	Criar artefato de braço de blueprint.	Extensão	GA
az blueprint artifact template update	Atualize o artefato do braço do blueprint.	Extensão	GA
az blueprint assignment	Comandos para gerenciar a atribuição do blueprint.	Extensão	GA
az blueprint assignment create	Crie uma atribuição de blueprint.	Extensão	GA
az blueprint assignment delete	Exclua uma atribuição de blueprint.	Extensão	Versão Prévia
az blueprint assignment list	Listar atribuições de blueprint em uma assinatura.	Extensão	Versão Prévia
az blueprint assignment show	Obtenha uma atribuição de blueprint.	Extensão	Versão Prévia
az blueprint assignment update	Atualizar uma atribuição de blueprint.	Extensão	GA
az blueprint assignment wait	Coloque a CLI em um estado de espera até que uma condição da Atribuição do Blueprint seja atendida.	Extensão	GA
az blueprint assignment who	Obtenha o Blueprint Servie Principal Name objectId.	Extensão	Versão Prévia
az blueprint create	Crie uma definição de blueprint.	Extensão	Versão Prévia
az blueprint delete	Exclua uma definição de blueprint.	Extensão	Versão Prévia
az blueprint export	Exporte uma definição de blueprint e artefatos para arquivo(s) json.	Extensão	GA
az blueprint import	Importe uma definição de blueprint e artefatos de um directoy de arquivos json.	Extensão	GA
az blueprint list	Listar definições de blueprint.	Extensão	Versão Prévia
az blueprint publish	Publique uma nova versão da definição de blueprint com os artefatos mais recentes. As definições de blueprint publicadas são imutáveis.	Extensão	Versão Prévia
az blueprint resource-group	Comandos para gerenciar o artefato do grupo de recursos do blueprint.	Extensão	GA
az blueprint resource-group add	Adicione um artefato de grupo de recursos ao blueprint.	Extensão	GA
az blueprint resource-group list	Artefato do grupo de recursos do blueprint de lista.	Extensão	GA
az blueprint resource-group remove	Remova um artefato de grupo de recursos do blueprint.	Extensão	GA
az blueprint resource-group show	Mostrar artefato de grupo de recursos do blueprint.	Extensão	GA
az blueprint resource-group update	Atualizar artefato de grupo de recursos do blueprint.	Extensão	GA
az blueprint show	Obtenha uma definição de blueprint.	Extensão	Versão Prévia
az blueprint update	Atualizar uma definição de blueprint.	Extensão	Versão Prévia
az blueprint version	Comandos para gerenciar versões de blueprint publicadas.	Extensão	Versão Prévia
az blueprint version artifact	Comandos para gerenciar artefatos de blueprint publicados.	Extensão	Versão Prévia
az blueprint version artifact list	Listar artefatos para uma versão de um blueprint publicado.	Extensão	Versão Prévia
az blueprint version artifact show	Mostrar um artefato para um plano publicado.	Extensão	Versão Prévia
az blueprint version delete	Excluir uma versão publicada de um blueprint.	Extensão	Versão Prévia
az blueprint version list	Listar versões publicadas de determinada definição de blueprint.	Extensão	Versão Prévia
az blueprint version show	Obtenha uma versão publicada de um blueprint.	Extensão	Versão Prévia

az blueprint create

Versão Prévia

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Crie uma definição de blueprint.

az blueprint create --name
                    --target-scope {managementGroup, subscription}
                    [--description]
                    [--display-name]
                    [--management-group]
                    [--parameters]
                    [--resource-groups]
                    [--subscription]

Exemplos

Criar um plano de assinatura

az blueprint create --subscription MySubscription --name MyBlueprint --description "blueprint contains all artifacts" --target-scope subscription

Criar um esquema de grupo de gerenciamento

az blueprint create --management-group MyManagementGroup --name MyBlueprint --description "blueprint contains all artifact" --target-scope subscription

Parâmetros Exigidos

--name -n

Nome da definição do blueprint.

--target-scope

O escopo onde essa definição de blueprint pode ser atribuída.

valores aceitos: managementGroup, subscription

Parâmetros Opcionais

--description

Várias linhas explicam esse recurso.

--display-name

Uma cadeia de caracteres de linha explica esse recurso.

--management-group -m

Use o grupo de gerenciamento para o escopo do blueprint.

--parameters -p

Parâmetros exigidos por esta definição de blueprint. Pode ser uma cadeia de caracteres JSON ou um caminho de arquivo JSON. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--resource-groups

Espaços reservados para grupos de recursos definidos por essa definição de blueprint. Valor esperado: json-string/@json-file. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--subscription -s

Use a assinatura para o escopo do blueprint. Se --management-group não for especificado, --valor de assinatura ou a assinatura padrão será usado como escopo.

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

Versão Prévia

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Exclua uma definição de blueprint.

az blueprint delete --name
                    [--management-group]
                    [--subscription]
                    [--yes]

Exemplos

Excluir um esquema de grupo de gerenciamento

az blueprint delete --management-group MyManagementGroup --name MyBlueprint

Excluir um esquema de assinatura

az blueprint delete --subscription MySubscription --name MyBlueprint

Parâmetros Exigidos

--name -n

Nome da definição do blueprint.

Parâmetros Opcionais

--management-group -m

Use o grupo de gerenciamento para o escopo do blueprint.

--subscription -s

Use a assinatura para o escopo do blueprint. Se --management-group não for especificado, --valor de assinatura ou a assinatura padrão será usado como escopo.

--yes -y

Não solicite confirmação.

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

Exporte uma definição de blueprint e artefatos para arquivo(s) json.

az blueprint export --name
                    --output-path
                    [--management-group]
                    [--subscription]
                    [--yes]

Exemplos

Exportar uma definição de blueprint e artefatos

az blueprint export --name MyBlueprint \
--output-path "path/to/blueprint/directory"

Parâmetros Exigidos

--name -n

Nome da definição de blueprint a ser exportada.

--output-path

O caminho do diretório para definições json do blueprint e artefatos. O arquivo de definição de blueprint será chamado blueprint.json. Os arquivos json de artefatos estarão em um subdiretório chamado artefatos.

Parâmetros Opcionais

--management-group -m

Use o grupo de gerenciamento para o escopo do blueprint.

--subscription -s

Use a assinatura para o escopo do blueprint. Se --management-group não for especificado, --valor de assinatura ou a assinatura padrão será usado como escopo.

--yes -y

Ignorar a confirmação do usuário. Quando definido, se o diretório não existir, ele será criado. Se o diretório existir e tiver conteúdo, eles serão substituídos. Se não estiver definido, o usuário será solicitado a fornecer permissão para continuar.

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 blueprint import

Importe uma definição de blueprint e artefatos de um directoy de arquivos json.

az blueprint import --input-path
                    --name
                    [--management-group]
                    [--subscription]
                    [--yes]

Exemplos

Importar uma definição de blueprint e artefatos

az blueprint import --name MyBlueprint \
--input-path "path/to/blueprint/directory"

Parâmetros Exigidos

--input-path

O caminho do diretório para definições json do blueprint e artefatos. O arquivo de definição de blueprint deve ser chamado blueprint.json. Os arquivos json de artefatos devem estar em um subdiretório chamado artefatos.

--name -n

Nome da definição do blueprint.

Parâmetros Opcionais

--management-group -m

Use o grupo de gerenciamento para o escopo do blueprint.

--subscription -s

Use a assinatura para o escopo do blueprint. Se --management-group não for especificado, --valor de assinatura ou a assinatura padrão será usado como escopo.

--yes -y

Não solicite confirmação.

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

Versão Prévia

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Listar definições de blueprint.

az blueprint list [--management-group]
                  [--max-items]
                  [--next-token]
                  [--subscription]

Exemplos

Listar blueprints em um grupo de gerenciamento

az blueprint list --management-group MyManagementGroup

Listar plantas em uma assinatura

az blueprint list --subscription MySubscription

Parâmetros Opcionais

--management-group -m

Use o grupo de gerenciamento para o escopo do blueprint.

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token no --next-token argumento de um comando subsequente.

--next-token

Token para especificar onde iniciar a paginação. Esse é o valor de token de uma resposta truncada anteriormente.

--subscription -s

Use a assinatura para o escopo do blueprint. Se --management-group não for especificado, --valor de assinatura ou a assinatura padrão será usado como escopo.

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 blueprint publish

Versão Prévia

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Publique uma nova versão da definição de blueprint com os artefatos mais recentes. As definições de blueprint publicadas são imutáveis.

az blueprint publish --blueprint-name
                     --version
                     [--change-notes]
                     [--management-group]
                     [--subscription]

Exemplos

Publicar um esquema de grupo de gerenciamento

az blueprint publish --management-group MyManagementGroup --blueprint-name MyBlueprint --version v2

Publicar um plano de assinatura

az blueprint publish --subscription MySubscription --blueprint-name MyBlueprint --version v2

Parâmetros Exigidos

--blueprint-name

Nome da definição do blueprint.

--version

Versão da definição de blueprint publicada.

Parâmetros Opcionais

--change-notes

Notas de alteração específicas da versão.

--management-group -m

Use o grupo de gerenciamento para o escopo do blueprint.

--subscription -s

Use a assinatura para o escopo do blueprint. Se --management-group não for especificado, --valor de assinatura ou a assinatura padrão será usado como escopo.

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

Versão Prévia

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Obtenha uma definição de blueprint.

az blueprint show --name
                  [--management-group]
                  [--subscription]

Exemplos

Mostrar um esquema de grupo de gerenciamento

az blueprint show --management-group MyManagementGroup --name MyBlueprint

Mostrar um esquema de assinatura

az blueprint show --subscription MySubscription --name MyBlueprint

Parâmetros Exigidos

--name -n

Nome da definição do blueprint.

Parâmetros Opcionais

--management-group -m

Use o grupo de gerenciamento para o escopo do blueprint.

--subscription -s

Use a assinatura para o escopo do blueprint. Se --management-group não for especificado, --valor de assinatura ou a assinatura padrão será usado como escopo.

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 blueprint update

Versão Prévia

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Atualizar uma definição de blueprint.

az blueprint update --name
                    [--add]
                    [--description]
                    [--display-name]
                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                    [--management-group]
                    [--parameters]
                    [--remove]
                    [--resource-groups]
                    [--set]
                    [--subscription]
                    [--target-scope {managementGroup, subscription}]

Parâmetros Exigidos

--name -n

Nome da definição do blueprint.

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string ou cadeia de caracteres> JSON.

--description

Várias linhas explicam esse recurso.

--display-name

Uma cadeia de caracteres de linha explica esse recurso.

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes

--management-group -m

Use o grupo de gerenciamento para o escopo do blueprint.

--parameters -p

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OU --remove propertyToRemove.

--resource-groups

Espaços reservados para grupos de recursos definidos por essa definição de blueprint. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=.

--subscription -s

Use a assinatura para o escopo do blueprint. Se --management-group não for especificado, --valor de assinatura ou a assinatura padrão será usado como escopo.

--target-scope

O escopo onde essa definição de blueprint pode ser atribuída.

valores aceitos: managementGroup, subscription

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.

Compartilhar via

az blueprint

Comandos

az blueprint create

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az blueprint delete

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az blueprint export

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az blueprint import

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az blueprint list

Exemplos

Parâmetros Opcionais

az blueprint publish

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az blueprint show

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az blueprint update

Parâmetros Exigidos

Parâmetros Opcionais

Recursos adicionais