Role Definitions - Create Or Update

Service:: Key Vault

Version d'API:: 2025-07-01

Crée ou met à jour une définition de rôle personnalisée.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
roleDefinitionName	path	True	string	Nom de la définition de rôle à créer ou à mettre à jour. Il peut s’agir de n’importe quel GUID valide.
scope	path	True	string	Étendue de la définition de rôle à créer ou à mettre à jour. Le HSM managé ne prend en charge que « / ».
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
properties	True	RoleDefinitionProperties	Propriétés de définition de rôle.

Réponses

Nom	Type	Description
201 Created	RoleDefinition	La requête a réussi et une nouvelle ressource a été créée en conséquence.
Other Status Codes	KeyVaultError	Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
https://vault.azure.net/.default

Exemples

Create or update a custom role definition

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:: 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"
}

Définitions

Nom	Description
DataAction	Autorisations prises en charge pour les actions de données.
Error
KeyVaultError	Exception d’erreur du coffre de clés.
Permission	Autorisations de définition de rôle.
RoleDefinition	Définition du rôle.
RoleDefinitionCreateParameters	Définition de rôle : créer des paramètres.
RoleDefinitionProperties	Propriétés de définition de rôle.
RoleDefinitionType	Type de définition de rôle.
RoleScope	Étendue du rôle.
RoleType	Le type de rôle.

DataAction

Énumération

Autorisations prises en charge pour les actions de données.

Valeur	Description
Microsoft.KeyVault/managedHsm/keys/read/action	Lire les métadonnées de clé HSM.
Microsoft.KeyVault/managedHsm/keys/write/action	Mettre à jour une clé HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	Lire la clé HSM supprimée.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	Récupérez la clé HSM supprimée.
Microsoft.KeyVault/managedHsm/keys/backup/action	Sauvegardez les clés HSM.
Microsoft.KeyVault/managedHsm/keys/restore/action	Restaurez les clés HSM.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	Supprimer l’attribution de rôle.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	Obtenir l’attribution de rôle.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	Créez ou mettez à jour l’attribution de rôle.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	Obtenir la définition du rôle.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	Créez ou mettez à jour la définition du rôle.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	Supprimer la définition de rôle.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	Chiffrez à l’aide d’une clé HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	Déchiffrez à l’aide d’une clé HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action	Encapsulez à l’aide d’une clé HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	Dépliage à l’aide d’une clé HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action	Signez à l’aide d’une clé HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action	Vérifiez à l’aide d’une clé HSM.
Microsoft.KeyVault/managedHsm/keys/create	Créez une clé HSM.
Microsoft.KeyVault/managedHsm/keys/delete	Supprimez une clé HSM.
Microsoft.KeyVault/managedHsm/keys/export/action	Exportez une clé HSM.
Microsoft.KeyVault/managedHsm/keys/release/action	Libérez une clé HSM à l’aide de Secure Key Release.
Microsoft.KeyVault/managedHsm/keys/import/action	Importez une clé HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	Purger une clé HSM supprimée.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	Téléchargez un domaine de sécurité HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	Vérifiez l’état du téléchargement du domaine de sécurité HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	Chargez un domaine de sécurité HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	Vérifiez l’état du fichier d’échange de domaine de sécurité HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	Téléchargez une clé de transfert de domaine de sécurité HSM.
Microsoft.KeyVault/managedHsm/backup/start/action	Démarrez une sauvegarde HSM.
Microsoft.KeyVault/managedHsm/restore/start/action	Démarrez une restauration HSM.
Microsoft.KeyVault/managedHsm/backup/status/action	Lire l’état d’une sauvegarde HSM.
Microsoft.KeyVault/managedHsm/restore/status/action	Lire l’état d’une restauration HSM.
Microsoft.KeyVault/managedHsm/rng/action	Générez des nombres aléatoires.

Error

Object

Nom	Type	Description
code	string	Code d’erreur.
innererror	Error	Erreur de serveur Key Vault.
message	string	Message d’erreur.

KeyVaultError

Object

Exception d’erreur du coffre de clés.

Nom	Type	Description
error	Error	Erreur de serveur Key Vault.

Permission

Object

Autorisations de définition de rôle.

Nom	Type	Description
actions	string[]	Autorisations d’action accordées.
dataActions	DataAction[]	Autorisations d’action de données accordées.
notActions	string[]	Autorisations d’action exclues mais pas refusées. Ils peuvent être accordés par d’autres définitions de rôle attribuées à un directeur.
notDataActions	DataAction[]	Autorisations d’action de données exclues mais pas refusées. Ils peuvent être accordés par d’autres définitions de rôle attribuées à un directeur.

RoleDefinition

Object

Définition du rôle.

Nom	Type	Description
id	string	ID de définition de rôle.
name	string	Nom de la définition du rôle.
properties.assignableScopes	RoleScope[]	Définition de rôle : étendues assignables.
properties.description	string	Description de la définition du rôle.
properties.permissions	Permission[]	Autorisations de définition de rôle.
properties.roleName	string	Nom du rôle.
properties.type	RoleType	Le type de rôle.
type	RoleDefinitionType	Type de définition de rôle.

RoleDefinitionCreateParameters

Object

Définition de rôle : créer des paramètres.

Nom	Type	Description
properties	RoleDefinitionProperties	Propriétés de définition de rôle.

RoleDefinitionProperties

Object

Propriétés de définition de rôle.

Nom	Type	Description
assignableScopes	RoleScope[]	Définition de rôle : étendues assignables.
description	string	Description de la définition du rôle.
permissions	Permission[]	Autorisations de définition de rôle.
roleName	string	Nom du rôle.
type	RoleType	Le type de rôle.

RoleDefinitionType

Énumération

Type de définition de rôle.

Valeur	Description
Microsoft.Authorization/roleDefinitions	Définitions de rôle définies par Microsoft.

RoleScope

Énumération

Étendue du rôle.

Valeur	Description
/	Portée mondiale
/keys	Portée des clés

RoleType

Énumération

Le type de rôle.

Valeur	Description
AKVBuiltInRole	Rôle intégré.
CustomRole	Rôle personnalisé.

Partager via

Role Definitions - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

OAuth2Auth

Étendues

Exemples

Create or update a custom role definition

Exemple de requête

Exemple de réponse

Définitions

DataAction

Error

KeyVaultError

Permission

RoleDefinition

RoleDefinitionCreateParameters

RoleDefinitionProperties

RoleDefinitionType

RoleScope

RoleType