az keyvault role definition

  • Referência

Gerenciar definições de função.

Comandos

Nome Description Tipo Status
az keyvault role definition create

Crie uma definição de função personalizada.

 Núcleo GA
az keyvault role definition delete

Excluir uma definição de função.

 Núcleo GA
az keyvault role definition list

Listar definições de função.

 Núcleo GA
az keyvault role definition show

Mostrar os detalhes de uma definição de função.

 Núcleo GA
az keyvault role definition update

Atualizar uma definição de função.

 Núcleo GA

az keyvault role definition create

Editar

Crie uma definição de função personalizada.

az keyvault role definition create --hsm-name
                                   --role-definition

Exemplos

Crie uma função por uma cadeia de caracteres JSON.

az keyvault role definition create --hsm-name MyHSM --role-definition '{
    "roleName": "My Custom Role",
    "description": "The description of the custom rule.",
    "actions": [],
    "notActions": [],
    "dataActions": [
        "Microsoft.KeyVault/managedHsm/keys/read/action"
    ],
    "notDataActions": []
}'

Crie uma função a partir de um arquivo que contém uma descrição JSON.

az keyvault role definition create --hsm-name MyHSM --role-definition @keyvault-role.json

Parâmetros Exigidos

--hsm-name

Nome do HSM.

--role-definition

Descrição de uma função como JSON ou um caminho para um arquivo que contém uma descrição JSON.

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 keyvault role definition delete

Editar

Excluir uma definição de função.

az keyvault role definition delete --hsm-name
                                   [--name]
                                   [--role-id]

Parâmetros Exigidos

--hsm-name

Nome do HSM.

Parâmetros Opcionais

--name -n

O nome da definição de função. Este é um GUID na propriedade "name" de uma definição de função.

--role-id

A ID de definição de função.

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 keyvault role definition list

Editar

Listar definições de função.

az keyvault role definition list [--custom-role-only {false, true}]
                                 [--hsm-name]
                                 [--scope]

Parâmetros Opcionais

--custom-role-only

Mostrar apenas definições de função personalizadas.

Valores aceitos: false, true
Valor padrão: False
--hsm-name

Nome do HSM.

--scope

Escopo ao qual a atribuição ou definição de função se aplica, por exemplo, "/" ou "/keys" ou "/keys/{keyname}".

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 keyvault role definition show

Editar

Mostrar os detalhes de uma definição de função.

az keyvault role definition show --hsm-name
                                 [--name]
                                 [--role-id]

Parâmetros Exigidos

--hsm-name

Nome do HSM.

Parâmetros Opcionais

--name -n

O nome da definição de função. Este é um GUID na propriedade "name" de uma definição de função.

--role-id

A ID de definição de função.

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 keyvault role definition update

Editar

Atualizar uma definição de função.

az keyvault role definition update --hsm-name
                                   --role-definition

Exemplos

Atualizar uma função por uma cadeia de caracteres JSON.

az keyvault role definition update --hsm-name MyHSM --role-definition '{
    "roleName": "My Custom Role",
    "name": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "id": "Microsoft.KeyVault/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "description": "The description of the custom rule.",
    "actions": [],
    "notActions": [],
    "dataActions": [
        "Microsoft.KeyVault/managedHsm/keys/read/action",
        "Microsoft.KeyVault/managedHsm/keys/write/action",
        "Microsoft.KeyVault/managedHsm/keys/backup/action",
        "Microsoft.KeyVault/managedHsm/keys/create"
    ],
    "notDataActions": []
}'

Atualize uma função de um arquivo que contém uma descrição JSON.

az keyvault role definition update --hsm-name MyHSM --role-definition @keyvault-role.json

Parâmetros Exigidos

--hsm-name

Nome do HSM.

--role-definition

Descrição de uma função como JSON ou um caminho para um arquivo que contém uma descrição JSON.

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.