Share via

az blueprint assignment

  • Referência

Nota

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 assignment . Saiba mais sobre extensões.

Comandos para gerenciar a atribuição do blueprint.

Comandos

Name Description Tipo Estado
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 Pré-visualizar
az blueprint assignment list

Listar atribuições de blueprint em uma assinatura.

 Extensão Pré-visualizar
az blueprint assignment show

Obtenha uma tarefa de blueprint.

 Extensão Pré-visualizar
az blueprint assignment update

Atualize 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 Pré-visualizar

az blueprint assignment create

Crie uma atribuição de blueprint.

az blueprint assignment create --name
                               [--blueprint-version]
                               [--description]
                               [--display-name]
                               [--identity-type {None, SystemAssigned, UserAssigned}]
                               [--location]
                               [--locks-excluded-principals]
                               [--locks-mode {AllResourcesDoNotDelete, AllResourcesReadOnly, None}]
                               [--management-group]
                               [--parameters]
                               [--resource-group-value]
                               [--subscription]
                               [--user-assigned-identity]

Exemplos

Atribuição com identidade gerenciada atribuída pelo sistema

az blueprint assignment create --subscription MySubscription --name \
MyBlueprintAssignment --location eastus --identity-type SystemAssigned \
--description "Enforce pre-defined MyBlueprint to this subscription." \
--blueprint-version "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/provid \
ers/Microsoft.Blueprint/blueprints/MyBlueprint/versions/v2" \
--resource-group-value artifact_name=rg-art-1 name=rg1 location=westus \
--resource-group-value artifact_name=rg-art-2 name=rg2 location=eastus \
--parameters "path/to/parameter/file" \

Atribuição com identidade gerenciada atribuída pelo usuário

az blueprint assignment create --subscription MySubscription --name \
MyBlueprintAssignment --location eastus --identity-type UserAssigned \
--user-assigned-identity "/subscriptions/00000000-0000-0000-0000-000000000000 \
/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"\
--description "Enforce pre-defined MyBlueprint to this subscription." \
--blueprint-version "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup \
/providers/Microsoft.Blueprint/blueprints/MyBlueprint/versions/v2" \
--resource-group-value artifact_name=rg-art-1 name=rg1 location=eastus \
--parameters "path/to/parameter/file" \

Parâmetros Obrigatórios

--name -n

Nome da atribuição do blueprint.

Parâmetros Opcionais

--blueprint-version

ID do recurso da versão publicada de uma definição de blueprint.

--description

Multi-linha explicar este recurso.

--display-name

Uma cadeia de caracteres de linha única explica este recurso.

--identity-type

Tipo de identidade gerenciada.

valores aceites: None, SystemAssigned, UserAssigned
valor predefinido: SystemAssigned
--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--locks-excluded-principals

Lista de entidades de AAD excluídas dos bloqueios de blueprint. São permitidos até 5 princípios.

--locks-mode

Modo de bloqueio.

valores aceites: AllResourcesDoNotDelete, AllResourcesReadOnly, None
--management-group -m

Use o grupo de gerenciamento para o escopo de destino da atribuição do blueprint. Está reservado para uso futuro. Em vez disso, use --subscription.

--parameters -p

Valores dos parâmetros de atribuição do Blueprint. Pode ser uma cadeia de caracteres JSON ou um caminho de arquivo JSON.

--resource-group-value

Pares Key=Value para um grupo de recursos. As chaves incluem 'artifact_name'(obrigatório), 'nome', 'localização'.

--subscription -s

Use a assinatura para o escopo de destino da atribuição do blueprint. Susbcription padrão será usado se a opção não for especificada.

--user-assigned-identity

A identidade gerenciada atribuída pelo usuário associada ao recurso.

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

Pré-visualizar

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

Exclua uma atribuição de blueprint.

az blueprint assignment delete --name
                               [--delete-behavior {all, none}]
                               [--management-group]
                               [--subscription]
                               [--yes]

Exemplos

Eliminar uma atribuição

az blueprint assignment delete --subscription MySubscription --name MyBlueprintAssignment

Parâmetros Obrigatórios

--name -n

Nome da atribuição do blueprint.

Parâmetros Opcionais

--delete-behavior

Quando deleteBehavior=all, os recursos que foram criados pela atribuição de blueprint serão excluídos.

valores aceites: all, none
--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, --o valor da assinatura ou a assinatura padrão serão usados como escopo.

--yes -y

Não solicite confirmação.

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

Pré-visualizar

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

Listar atribuições de blueprint em uma assinatura.

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

Exemplos

Listar atribuições

az blueprint assignment 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 por onde começar a paginar. Este é o valor do token de uma resposta truncada anteriormente.

--subscription -s

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

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

Pré-visualizar

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

Obtenha uma tarefa de blueprint.

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

Exemplos

Mostrar uma tarefa

az blueprint assignment show --subscription MySubscription --name MyBlueprintAssignment

Parâmetros Obrigatórios

--name -n

Nome da atribuiçã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, --o valor da assinatura ou a assinatura padrão serão usados como escopo.

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

Atualize uma atribuição de blueprint.

az blueprint assignment update --name
                               [--blueprint-version]
                               [--description]
                               [--display-name]
                               [--identity-type {None, SystemAssigned, UserAssigned}]
                               [--location]
                               [--locks-excluded-principals]
                               [--locks-mode {AllResourcesDoNotDelete, AllResourcesReadOnly, None}]
                               [--management-group]
                               [--parameters]
                               [--resource-group-value]
                               [--subscription]
                               [--user-assigned-identity]

Parâmetros Obrigatórios

--name -n

Nome da atribuição do blueprint.

Parâmetros Opcionais

--blueprint-version

ID do recurso da versão publicada de uma definição de blueprint.

--description

Multi-linha explicar este recurso.

--display-name

Uma cadeia de caracteres de linha única explica este recurso.

--identity-type

Tipo de identidade gerenciada.

valores aceites: None, SystemAssigned, UserAssigned
--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--locks-excluded-principals

Lista de entidades de AAD excluídas dos bloqueios de blueprint. São permitidos até 5 princípios.

--locks-mode

Modo de bloqueio.

valores aceites: AllResourcesDoNotDelete, AllResourcesReadOnly, None
--management-group -m

Use o grupo de gerenciamento para o escopo de destino da atribuição do blueprint. Está reservado para uso futuro. Em vez disso, use --subscription.

--parameters -p

Valores dos parâmetros de atribuição do Blueprint. Pode ser uma cadeia de caracteres JSON ou um caminho de arquivo JSON.

--resource-group-value

Pares Key=Value para um grupo de recursos. As chaves incluem 'artifact_name'(obrigatório), 'nome', 'localização'.

--subscription -s

Use a assinatura para o escopo de destino da atribuição do blueprint. Susbcription padrão será usado se a opção não for especificada.

--user-assigned-identity

A identidade gerenciada atribuída pelo usuário associada ao recurso.

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 blueprint assignment wait

Coloque a CLI em um estado de espera até que uma condição da atribuição do Blueprint seja atendida.

az blueprint assignment wait --name
                             [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--interval]
                             [--management-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

Exemplos

Pause a execução da próxima linha do script da CLI até que a atribuição do Blueprint seja provisionada com êxito.

az blueprint assignment wait --subscription MySubscription \ --name MyBlueprintAssignment --created

Parâmetros Obrigatórios

--name -n

Nome da atribuição do blueprint.

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
--management-group -m

Use o grupo de gerenciamento para o escopo de destino da atribuição do blueprint. Está reservado para uso futuro. Em vez disso, use --subscription.

--subscription -s

Use a assinatura para o escopo de destino da atribuição do blueprint. Susbcription padrão será usado se a opção não for especificada.

--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 blueprint assignment who

Pré-visualizar

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

Obtenha o Blueprint Servie Principal Name objectId.

az blueprint assignment who --name
                            [--management-group]
                            [--subscription]

Exemplos

Obter objectId do SPN

az blueprint assignment who --subscription MySubscription --name MyBlueprintAssignment

Parâmetros Obrigatórios

--name -n

Nome da atribuiçã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, --o valor da assinatura ou a assinatura padrão serão usados como escopo.

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.