Compartir a través de

az keyvault role definition

Administrar definiciones de roles.

Comandos

Nombre Description Tipo Estado
az keyvault role definition create

Cree una definición de rol personalizada.

 Core GA
az keyvault role definition delete

Elimine una definición de rol.

 Core GA
az keyvault role definition list

Enumerar definiciones de roles.

 Core GA
az keyvault role definition show

Muestra los detalles de una definición de rol.

 Core GA
az keyvault role definition update

Actualice una definición de rol.

 Core GA

az keyvault role definition create

Editar

Cree una definición de rol personalizada.

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

Ejemplos

Cree un rol mediante una cadena 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": []
}'

Cree un rol a partir de un archivo que contenga una descripción JSON.

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

Parámetros requeridos

--hsm-name

Nombre del HSM.

Propiedad Valor
Grupo de parámetros: Id Arguments
--role-definition

Descripción de un rol como JSON o una ruta de acceso a un archivo que contiene una descripción JSON.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az keyvault role definition delete

Editar

Elimine una definición de rol.

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

Parámetros requeridos

--hsm-name

Nombre del HSM.

Propiedad Valor
Grupo de parámetros: Id Arguments

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--name -n

Nombre de definición de rol. Se trata de un GUID en la propiedad "name" de una definición de rol.

--role-id

Identificador de definición de rol.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az keyvault role definition list

Editar

Enumerar definiciones de roles.

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--custom-role-only

Solo se muestran definiciones de roles personalizadas.

Propiedad Valor
Valor predeterminado: False
Valores aceptados: false, true
--hsm-name

Nombre del HSM.

Propiedad Valor
Grupo de parámetros: Id Arguments
--scope

Ámbito en el que se aplica la asignación o definición de roles, por ejemplo, "/" o "/keys" o "/keys/{keyname}".

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az keyvault role definition show

Editar

Muestra los detalles de una definición de rol.

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

Parámetros requeridos

--hsm-name

Nombre del HSM.

Propiedad Valor
Grupo de parámetros: Id Arguments

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--name -n

Nombre de definición de rol. Se trata de un GUID en la propiedad "name" de una definición de rol.

--role-id

Identificador de definición de rol.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az keyvault role definition update

Editar

Actualice una definición de rol.

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

Ejemplos

Actualice un rol mediante una cadena 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": []
}'

Actualice un rol de un archivo que contiene una descripción JSON.

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

Parámetros requeridos

--hsm-name

Nombre del HSM.

Propiedad Valor
Grupo de parámetros: Id Arguments
--role-definition

Descripción de un rol como JSON o una ruta de acceso a un archivo que contiene una descripción JSON.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False