Role Definitions - List

Référence

Service:: Key Vault

Version d'API:: 7.4

Obtenez toutes les définitions de rôle applicables à l’étendue et au-dessus.

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

Avec des paramètres facultatifs:

GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleDefinitions?$filter={$filter}&api-version=7.4

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
scope	path	True	string	Étendue de la définition de rôle.
vaultBaseUrl	path	True	string	Nom du coffre, par exemple https://myvault.vault.azure.net.
api-version	query	True	string	Version d’API client.
$filter	query		string	Filtre à appliquer à l’opération. Utilisez également le filtre atScopeAndBelow pour effectuer une recherche sous l’étendue donnée.

Réponses

Nom	Type	Description
200 OK	RoleDefinitionListResult	OK : retourne un tableau de définitions de rôles.
Other Status Codes	KeyVaultError	Key Vault réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

ListRoleDefinitions

Exemple de requête

HTTP

GET https://myvault.vault.azure.net//keys/providers/Microsoft.Authorization/roleDefinitions?api-version=7.4

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "properties": {
        "roleName": "Role name",
        "type": "roletype",
        "description": "Role description",
        "assignableScopes": [
          "/keys"
        ],
        "permissions": [
          {
            "actions": [
              "get"
            ],
            "notActions": []
          }
        ]
      },
      "id": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId",
      "type": "Microsoft.Authorization/roleDefinitions",
      "name": "roleDefinitionId"
    }
  ]
}

Définitions

Nom	Description
DataAction	Autorisations prises en charge pour les actions de données.
Error	Erreur du serveur du coffre de clés.
KeyVaultError	Exception d’erreur du coffre de clés.
Permission	Autorisations de définition de rôle.
RoleDefinition	Définition de rôle.
RoleDefinitionListResult	Résultat de l’opération de liste de définitions de rôle.
RoleDefinitionType	Type de définition de rôle.
RoleScope	Étendue du rôle.
RoleType	Type de rôle.

DataAction

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

Nom	Type	Description
Microsoft.KeyVault/managedHsm/backup/start/action	string	Démarrez une sauvegarde HSM.
Microsoft.KeyVault/managedHsm/backup/status/action	string	Lisez un status de sauvegarde HSM.
Microsoft.KeyVault/managedHsm/keys/backup/action	string	Clés HSM de sauvegarde.
Microsoft.KeyVault/managedHsm/keys/create	string	Créez une clé HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	string	Déchiffrez à l’aide d’une clé HSM.
Microsoft.KeyVault/managedHsm/keys/delete	string	Supprimez une clé HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	string	Purgez une clé HSM supprimée.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	string	Lire la clé HSM supprimée.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	string	Récupérer la clé HSM supprimée.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	string	Chiffrez à l’aide d’une clé HSM.
Microsoft.KeyVault/managedHsm/keys/export/action	string	Exporter une clé HSM.
Microsoft.KeyVault/managedHsm/keys/import/action	string	Importez une clé HSM.
Microsoft.KeyVault/managedHsm/keys/read/action	string	Lisez les métadonnées de clé HSM.
Microsoft.KeyVault/managedHsm/keys/release/action	string	Libérer une clé HSM à l’aide de la version de clé sécurisée.
Microsoft.KeyVault/managedHsm/keys/restore/action	string	Restaurez les clés HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action	string	Signez à l’aide d’une clé HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	string	Désencapsuler à l’aide d’une clé HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action	string	Vérifiez à l’aide d’une clé HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action	string	Encapsuler à l’aide d’une clé HSM.
Microsoft.KeyVault/managedHsm/keys/write/action	string	Mettre à jour une clé HSM.
Microsoft.KeyVault/managedHsm/restore/start/action	string	Démarrez une restauration HSM.
Microsoft.KeyVault/managedHsm/restore/status/action	string	Lisez un status de restauration HSM.
Microsoft.KeyVault/managedHsm/rng/action	string	Générer des nombres aléatoires.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	string	Supprimer l’attribution de rôle.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	string	Obtenir l’attribution de rôle.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	string	Créer ou mettre à jour l’attribution de rôle.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	string	Supprimer la définition de rôle.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	string	Obtenir la définition de rôle.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	string	Créer ou mettre à jour une définition de rôle.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	string	Téléchargez un domaine de sécurité HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	string	Vérifiez status de téléchargement du domaine de sécurité HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	string	Téléchargez une clé de transfert de domaine de sécurité HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	string	Chargez un domaine de sécurité HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	string	Vérifiez le status du fichier d’échange de domaine de sécurité HSM.

Error

Erreur du serveur du coffre de clés.

Nom	Type	Description
code	string	Code d'erreur.
innererror	Error	Erreur du serveur du coffre de clés.
message	string	Message d’erreur.

KeyVaultError

Exception d’erreur du coffre de clés.

Nom	Type	Description
error	Error	Erreur du serveur du coffre de clés.

Permission

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 qui sont exclues, mais pas refusées. Elles peuvent être accordées par d’autres définitions de rôle attribuées à un principal.
notDataActions	DataAction[]	Autorisations d’action de données qui sont exclues, mais pas refusées. Elles peuvent être accordées par d’autres définitions de rôle attribuées à un principal.

RoleDefinition

Définition de rôle.

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

RoleDefinitionListResult

Résultat de l’opération de liste de définitions de rôle.

Nom	Type	Description
nextLink	string	URL à utiliser pour obtenir l’ensemble de résultats suivant.
value	RoleDefinition[]	Liste de définitions de rôle.

RoleDefinitionType

Type de définition de rôle.

Nom	Type	Description
Microsoft.Authorization/roleDefinitions	string

RoleScope

Étendue du rôle.

Nom	Type	Description
/	string	Étendue globale
/keys	string	Étendue des clés

RoleType

Type de rôle.

Nom	Type	Description
AKVBuiltInRole	string	Rôle intégré.
CustomRole	string	Rôle personnalisé.

Partager via