az keyvault role definition

Gerenciar definições de função.

Comandos

Nome	Description	Tipo	Status
az keyvault role definition create	Crie uma definição de função personalizada.	Core	GA
az keyvault role definition delete	Exclua uma definição de função.	Core	GA
az keyvault role definition list	Listar definições de função.	Core	GA
az keyvault role definition show	Mostre os detalhes de uma definição de função.	Core	GA
az keyvault role definition update	Atualize uma definição de função.	Core	GA

az keyvault role definition create

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.

Propriedade	Valor
Parameter group:	Id Arguments

--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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

az keyvault role definition delete

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

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

Parâmetros Exigidos

--hsm-name

Nome do HSM.

Propriedade	Valor
Parameter group:	Id Arguments

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--name -n

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

--role-id

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

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

az keyvault role definition list

Listar definições de função.

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

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--custom-role-only

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

Propriedade	Valor
Valor padrão:	False
Valores aceitos:	false, true

--hsm-name

Nome do HSM.

Propriedade	Valor
Parameter group:	Id Arguments

--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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

az keyvault role definition show

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

Propriedade	Valor
Parameter group:	Id Arguments

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--name -n

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

--role-id

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

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

az keyvault role definition update

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

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

Exemplos

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

Propriedade	Valor
Parameter group:	Id Arguments

--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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Output format.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False