Role Definitions - Get

Dienst:

Key Vault

API-Version:

7.4

Rufen Sie die angegebene Rollendefinition ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
roleDefinitionName	path	True	string	Der Name der abzurufenden Rollendefinition.
scope	path	True	string	Der Umfang der abzurufenden Rollendefinition. Verwaltetes HSM unterstützt nur '/'.
vaultBaseUrl	path	True	string	Der Tresorname, z. B. https://myvault.vault.azure.net.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	RoleDefinition	OK – Gibt Informationen zur Rollendefinition zurück.
Other Status Codes	KeyVaultError	Key Vault-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

GetRoleAssignments

Beispielanforderung

HTTP

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

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	Der Schlüsseltresorserverfehler.
KeyVaultError	Ausnahme des Schlüsseltresorfehlers.
Permission	Rollendefinitionsberechtigungen.
RoleDefinition	Rollendefinition.
RoleDefinitionType	Der Rollendefinitionstyp.
RoleScope	Der Rollenbereich.
RoleType	Der Rollentyp.

DataAction

Enumeration

Unterstützte Berechtigungen für Datenaktionen.

Wert	Beschreibung
Microsoft.KeyVault/managedHsm/backup/start/action	Starten Sie eine HSM-Sicherung.
Microsoft.KeyVault/managedHsm/backup/status/action	Lesen Sie einen HSM-Sicherungsstatus.
Microsoft.KeyVault/managedHsm/keys/backup/action	HsM-Schlüssel sichern.
Microsoft.KeyVault/managedHsm/keys/create	Erstellen Sie einen HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	Entschlüsseln sie mithilfe eines HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/keys/delete	Löschen Sie einen HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	Löschen eines gelöschten HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	Gelesener HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	Wiederherstellen des gelöschten HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	Verschlüsseln Sie mithilfe eines HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/keys/export/action	Exportieren Sie einen HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/import/action	Importieren Sie einen HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/read/action	Lesen Sie HSM-Schlüsselmetadaten.
Microsoft.KeyVault/managedHsm/keys/release/action	Lassen Sie einen HSM-Schlüssel mit Secure Key Release frei.
Microsoft.KeyVault/managedHsm/keys/restore/action	Stellen Sie HSM-Schlüssel wieder her.
Microsoft.KeyVault/managedHsm/keys/sign/action	Signieren Sie mit einem HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	Entschlüsselung mithilfe eines HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/keys/verify/action	Überprüfen Sie die Verwendung eines HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/keys/wrap/action	Umbrechen sie mithilfe einer HSM-Taste.
Microsoft.KeyVault/managedHsm/keys/write/action	Aktualisieren sie einen HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/restore/start/action	Starten Sie eine HSM-Wiederherstellung.
Microsoft.KeyVault/managedHsm/restore/status/action	Lesen Sie einen HSM-Wiederherstellungsstatus.
Microsoft.KeyVault/managedHsm/rng/action	Zufallszahlen generieren.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	Rollenzuweisung löschen.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	Rollenzuweisung abrufen.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	Erstellen oder Aktualisieren der Rollenzuweisung.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	Rollendefinition löschen.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	Rollendefinition abrufen.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	Erstellen oder Aktualisieren der Rollendefinition
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 HSM-Sicherheitsdomänendownloads.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	Laden Sie einen HSM-Sicherheitsdomänenübertragungsschlüssel herunter.
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 HSM-Sicherheitsdomänenaustauschdatei.

Error

Objekt

Der Schlüsseltresorserverfehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
innererror	Error	Der Schlüsseltresorserverfehler.
message	string	Die Fehlermeldung.

KeyVaultError

Objekt

Ausnahme des Schlüsseltresorfehlers.

Name	Typ	Beschreibung
error	Error	Der Schlüsseltresorserverfehler.

Permission

Objekt

Rollendefinitionsberechtigungen.

Name	Typ	Beschreibung
actions	string[]	Aktionsberechtigungen, die gewährt werden.
dataActions	DataAction[]	Berechtigungen für Datenaktion, die gewährt 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[]	Datenaktionsberechtigungen, die ausgeschlossen, aber nicht verweigert werden. Sie können von anderen Rollendefinitionen gewährt werden, die einem Prinzipal zugewiesen sind.

RoleDefinition

Objekt

Rollendefinition.

Name	Typ	Beschreibung
id	string	Die Rollendefinitions-ID.
name	string	Der Rollendefinitionsname.
properties.assignableScopes	RoleScope[]	Rollendefinitions-zuweisungsfähige Bereiche.
properties.description	string	Die Beschreibung der Rollendefinition.
properties.permissions	Permission[]	Rollendefinitionsberechtigungen.
properties.roleName	string	Der Rollenname.
properties.type	RoleType	Der Rollentyp.
type	RoleDefinitionType	Der Rollendefinitionstyp.

RoleDefinitionType

Enumeration

Der Rollendefinitionstyp.

Wert	Beschreibung
Microsoft.Authorization/roleDefinitions

RoleScope

Enumeration

Der Rollenbereich.

Wert	Beschreibung
/	Globaler Bereich
/keys	Schlüsselbereich

RoleType

Enumeration

Der Rollentyp.

Wert	Beschreibung
AKVBuiltInRole	Integrierte Rolle.
CustomRole	Benutzerdefinierte Rolle.