Freigeben über

Role Definitions - Get

Dienst:
Key Vault
API-Version:
2025-07-01

Rufen Sie die angegebene Rollendefinition ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
roleDefinitionName
 path True

string

Der Name der Rollendefinition, die abgerufen werden soll.
scope
 path True

string

Der Bereich der abzurufenden Rollendefinition. Managed HSM unterstützt nur '/'.
vaultBaseUrl
 path True

string (uri)

api-version
 query True

string

minLength: 1

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

RoleDefinition

Die Anforderung ist erfolgreich.
Other Status Codes

KeyVaultError

Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
https://vault.azure.net/.default

Beispiele

Get the specified role definition

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
{
  "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"
}

Definitionen

Name Beschreibung
DataAction

Unterstützte Berechtigungen für Datenaktionen.
Error
KeyVaultError

Die Key Vault-Fehlerausnahme.
Permission

Berechtigungen für die Rollendefinition.
RoleDefinition

Definition der Rolle.
RoleDefinitionType

Der Rollendefinitionstyp.
RoleScope

Der Rollenbereich.
RoleType

Der Rollentyp.

DataAction

Enumeration

Unterstützte Berechtigungen für Datenaktionen.

Wert Beschreibung
Microsoft.KeyVault/managedHsm/keys/read/action

Lesen Sie die Metadaten des HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/keys/write/action

Aktualisieren Sie einen HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action

Gelöschten HSM-Schlüssel lesen.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action

Gelöschten HSM-Schlüssel wiederherstellen.
Microsoft.KeyVault/managedHsm/keys/backup/action

Sichern Sie HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/restore/action

Stellen Sie HSM-Schlüssel wieder her.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action

Löschen Sie die Rollenzuweisung.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action

Rufen Sie die Rollenzuweisung ab.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action

Erstellen oder Aktualisieren der Rollenzuweisung.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action

Abrufen der Rollendefinition.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action

Erstellen oder Aktualisieren der Rollendefinition.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action

Löschen der Rollendefinition.
Microsoft.KeyVault/managedHsm/keys/encrypt/action

Verschlüsseln Sie mit einem HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/decrypt/action

Entschlüsseln Sie mit einem HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/wrap/action

Umbrechen mit einem HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/unwrap/action

Entpacken Sie mit einem HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/sign/action

Signieren Sie mit einem HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/verify/action

Überprüfen Sie mit einem HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/create

Erstellen Sie einen HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/delete

Löschen Sie einen HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/export/action

Exportieren eines HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/keys/release/action

Freigeben eines HSM-Schlüssels mit Secure Key Release.
Microsoft.KeyVault/managedHsm/keys/import/action

Importieren Sie einen HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete

Löschen eines gelöschten HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/securitydomain/download/action

Laden Sie eine HSM-Sicherheitsdomäne herunter.
Microsoft.KeyVault/managedHsm/securitydomain/download/read

Überprüfen Sie den Status des Downloads der HSM-Sicherheitsdomäne.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action

Laden Sie eine HSM-Sicherheitsdomäne hoch.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read

Überprüfen Sie den Status der Austauschdatei der HSM-Sicherheitsdomäne.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read

Laden Sie einen Schlüssel für die Übertragung der HSM-Sicherheitsdomäne herunter.
Microsoft.KeyVault/managedHsm/backup/start/action

Starten Sie eine HSM-Sicherung.
Microsoft.KeyVault/managedHsm/restore/start/action

Starten Sie eine HSM-Wiederherstellung.
Microsoft.KeyVault/managedHsm/backup/status/action

Lesen des Status einer HSM-Sicherung.
Microsoft.KeyVault/managedHsm/restore/status/action

Lesen des Status einer HSM-Wiederherstellung.
Microsoft.KeyVault/managedHsm/rng/action

Generieren Sie Zufallszahlen.

Error

Objekt
Name Typ Beschreibung
code

string

Der Fehlercode.
innererror

Error

Der Key Vault-Serverfehler.
message

string

Die Fehlermeldung.

KeyVaultError

Objekt

Die Key Vault-Fehlerausnahme.

Name Typ Beschreibung
error

Error

Der Key Vault-Serverfehler.

Permission

Objekt

Berechtigungen für die Rollendefinition.

Name Typ Beschreibung
actions

string[]

Aktionsberechtigungen, die erteilt werden.
dataActions

DataAction[]

Berechtigungen für Datenaktionen, die erteilt werden.
notActions

string[]

Aktionsberechtigungen, die ausgeschlossen, aber nicht verweigert werden. Sie können von anderen Rollendefinitionen gewährt werden, die einem Prinzipal zugewiesen sind.
notDataActions

DataAction[]

Berechtigungen für Datenaktionen, die ausgeschlossen, aber nicht verweigert werden. Sie können von anderen Rollendefinitionen gewährt werden, die einem Prinzipal zugewiesen sind.

RoleDefinition

Objekt

Definition der Rolle.

Name Typ Beschreibung
id

string

Die Rollendefinitions-ID.
name

string

Der Name der Rollendefinition.
properties.assignableScopes

RoleScope[]

Zuweisbare Bereiche für die Rollendefinition.
properties.description

string

Die Beschreibung der Rollendefinition.
properties.permissions

Permission[]

Berechtigungen für die Rollendefinition.
properties.roleName

string

Der Rollenname.
properties.type

RoleType

Der Rollentyp.
type

RoleDefinitionType

Der Rollendefinitionstyp.

RoleDefinitionType

Enumeration

Der Rollendefinitionstyp.

Wert Beschreibung
Microsoft.Authorization/roleDefinitions

Von Microsoft definierte Rollendefinitionen.

RoleScope

Enumeration

Der Rollenbereich.

Wert Beschreibung
/

Globaler Geltungsbereich
/keys

Geltungsbereich von Schlüsseln

RoleType

Enumeration

Der Rollentyp.

Wert Beschreibung
AKVBuiltInRole

Eingebaute Rolle.
CustomRole

Benutzerdefinierte Rolle.