Role Definitions - Create Or Update

Servicio:

Key Vault

Versión de la API:

7.4

Crea o actualiza una definición de rol personalizada.

PUT {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName}?api-version=7.4

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
roleDefinitionName	path	True	string	Nombre de la definición de roles que se va a crear o actualizar. Puede ser cualquier GUID válido.
scope	path	True	string	Ámbito de la definición de roles que se va a crear o actualizar. HSM administrado solo admite "/".
vaultBaseUrl	path	True	string	El nombre del almacén, por ejemplo https://myvault.vault.azure.net, .
api-version	query	True	string	Versión de API del cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties	True	RoleDefinitionProperties	Propiedades de definición de roles.

Respuestas

Nombre	Tipo	Description
201 Created	RoleDefinition	Creado: devuelve información sobre la definición de roles.
Other Status Codes	KeyVaultError	Key Vault respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

PutRoleDefinition

Solicitud de ejemplo

HTTP

PUT https://myvault.vault.azure.net//keys/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000?api-version=7.4

{
  "properties": {
    "roleName": "My custom role",
    "type": "CustomRole",
    "description": "Role description",
    "permissions": [
      {
        "dataActions": [
          "Microsoft.KeyVault/managedHsm/keys/sign/action"
        ]
      }
    ]
  }
}

Respuesta de muestra

status code:

201

{
  "properties": {
    "roleName": "My custom role",
    "type": "CustomRole",
    "description": "Role description",
    "assignableScopes": [
      "/"
    ],
    "permissions": [
      {
        "dataActions": [
          "Microsoft.KeyVault/managedHsm/keys/sign/action"
        ]
      }
    ]
  },
  "id": "Microsoft.KeyVault/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Authorization/roleDefinitions",
  "name": "00000000-0000-0000-0000-000000000000"
}

Definiciones

Nombre	Description
DataAction	Permisos admitidos para acciones de datos.
Error	Error del servidor del almacén de claves.
KeyVaultError	Excepción de error del almacén de claves.
Permission	Permisos de definición de roles.
RoleDefinition	Definición de roles.
RoleDefinitionCreateParameters	Parámetros de creación de definiciones de roles.
RoleDefinitionProperties	Propiedades de definición de roles.
RoleDefinitionType	Tipo de definición de rol.
RoleScope	Ámbito de rol.
RoleType	Tipo de rol.

DataAction

Permisos admitidos para acciones de datos.

Nombre	Tipo	Description
Microsoft.KeyVault/managedHsm/backup/start/action	string	Inicie una copia de seguridad de HSM.
Microsoft.KeyVault/managedHsm/backup/status/action	string	Lee un estado de copia de seguridad de HSM.
Microsoft.KeyVault/managedHsm/keys/backup/action	string	Copia de seguridad de claves HSM.
Microsoft.KeyVault/managedHsm/keys/create	string	Cree una clave HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	string	Descifrado mediante una clave HSM.
Microsoft.KeyVault/managedHsm/keys/delete	string	Elimine una clave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	string	Purgar una clave HSM eliminada.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	string	Lee la clave HSM eliminada.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	string	Recuperar la clave HSM eliminada.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	string	Cifre mediante una clave HSM.
Microsoft.KeyVault/managedHsm/keys/export/action	string	Exporte una clave HSM.
Microsoft.KeyVault/managedHsm/keys/import/action	string	Importe una clave HSM.
Microsoft.KeyVault/managedHsm/keys/read/action	string	Lee los metadatos de clave HSM.
Microsoft.KeyVault/managedHsm/keys/release/action	string	Libere una clave HSM mediante la versión de clave segura.
Microsoft.KeyVault/managedHsm/keys/restore/action	string	Restaure las claves de HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action	string	Inicie sesión con una clave HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	string	Desencapsular mediante una clave HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action	string	Compruebe el uso de una clave HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action	string	Ajuste mediante una clave HSM.
Microsoft.KeyVault/managedHsm/keys/write/action	string	Actualice una clave HSM.
Microsoft.KeyVault/managedHsm/restore/start/action	string	Inicie una restauración de HSM.
Microsoft.KeyVault/managedHsm/restore/status/action	string	Lee un estado de restauración de HSM.
Microsoft.KeyVault/managedHsm/rng/action	string	Generar números aleatorios.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	string	Elimina la asignación de roles.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	string	Obtiene la asignación de roles.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	string	Crear o actualizar la asignación de roles.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	string	Eliminar definición de roles.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	string	Obtiene la definición de roles.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	string	Cree o actualice la definición de roles.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	string	Descargue un dominio de seguridad de HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	string	Compruebe el estado de descarga del dominio de seguridad de HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	string	Descargue una clave de transferencia de dominio de seguridad de HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	string	Cargue un dominio de seguridad de HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	string	Compruebe el estado del archivo de intercambio de dominio de seguridad de HSM.

Error

Error del servidor del almacén de claves.

Nombre	Tipo	Description
code	string	Código de error.
innererror	Error	Error del servidor del almacén de claves.
message	string	El mensaje de error.

KeyVaultError

Excepción de error del almacén de claves.

Nombre	Tipo	Description
error	Error	Error del servidor del almacén de claves.

Permission

Permisos de definición de roles.

Nombre	Tipo	Description
actions	string[]	Permisos de acción concedidos.
dataActions	DataAction[]	Permisos de acción de datos que se conceden.
notActions	string[]	Permisos de acción que se excluyen pero no se deniegan. Pueden concederlas otras definiciones de roles asignadas a una entidad de seguridad.
notDataActions	DataAction[]	Permisos de acción de datos que se excluyen pero no se deniegan. Pueden concederlas otras definiciones de roles asignadas a una entidad de seguridad.

RoleDefinition

Definición de roles.

Nombre	Tipo	Description
id	string	Identificador de la definición de roles.
name	string	Nombre de la definición de rol.
properties.assignableScopes	RoleScope[]	Ámbitos asignables de definición de roles.
properties.description	string	Descripción de la definición de roles.
properties.permissions	Permission[]	Permisos de definición de roles.
properties.roleName	string	Nombre del rol.
properties.type	RoleType	Tipo de rol.
type	RoleDefinitionType	Tipo de definición de rol.

RoleDefinitionCreateParameters

Parámetros de creación de definiciones de roles.

Nombre	Tipo	Description
properties	RoleDefinitionProperties	Propiedades de definición de roles.

RoleDefinitionProperties

Propiedades de definición de roles.

Nombre	Tipo	Description
assignableScopes	RoleScope[]	Ámbitos asignables de definición de roles.
description	string	Descripción de la definición de roles.
permissions	Permission[]	Permisos de definición de roles.
roleName	string	Nombre del rol.
type	RoleType	Tipo de rol.

RoleDefinitionType

Tipo de definición de rol.

Nombre	Tipo	Description
Microsoft.Authorization/roleDefinitions	string

RoleScope

Ámbito de rol.

Nombre	Tipo	Description
/	string	Ámbito global
/keys	string	Ámbito de claves

RoleType

Tipo de rol.

Nombre	Tipo	Description
AKVBuiltInRole	string	Rol integrado.
CustomRole	string	Rol personalizado.