Role Assignments - List For Scope

Dienst:

Key Vault

API-Version:

2025-07-01

Ruft Rollenzuweisungen für einen Bereich ab.

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

Mit optionalen Parametern:

GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleAssignments?api-version=2025-07-01&$filter={$filter}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
scope	path	True	string	Der Bereich der Rollenzuweisungen.
vaultBaseUrl	path	True	string (uri)	Die Basis-URL der Key Vault-Instanz (z. B. https://myvault.vault.azure.net/)
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$filter	query		string	Der filter, der auf den Vorgang angewendet werden soll. Verwenden Sie $filter=atScope(), um alle Rollenzuweisungen im oder über dem Bereich zurückzugeben. Verwenden Sie $filter=principalId eq {id}, um alle Rollenzuweisungen am, oberhalb oder unterhalb des Bereichs für den angegebenen Prinzipal zurückzugeben.

Antworten

Name	Typ	Beschreibung
200 OK	RoleAssignmentListResult	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 role assignments for a scope

Beispielanforderung

HTTP

GET https://myvault.vault.azure.net//keys/providers/Microsoft.Authorization/roleAssignments?api-version=2025-07-01

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "properties": {
        "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId",
        "principalId": "principalId",
        "scope": "/keys"
      },
      "id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId",
      "type": "Microsoft.Authorization/roleAssignments",
      "name": "roleAssignmentId"
    }
  ]
}

Definitionen

Name	Beschreibung
Error
KeyVaultError	Die Key Vault-Fehlerausnahme.
RoleAssignment	Rollenzuweisungen
RoleAssignmentListResult	Ergebnis des Vorgangs der Rollenzuweisungsliste.
RoleAssignmentPropertiesWithScope	Rollenzuweisungseigenschaften mit Bereich.
RoleScope	Der Rollenbereich.

Error

Objekt

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

KeyVaultError

Objekt

Die Key Vault-Fehlerausnahme.

Name	Typ	Beschreibung
error	Error	Der Schlüsseltresorserverfehler.

RoleAssignment

Objekt

Rollenzuweisungen

Name	Typ	Beschreibung
id	string	Hierbei handelt es sich um die Rollenzuweisungs-ID.
name	string	Der Name der Rollenzuweisung.
properties	RoleAssignmentPropertiesWithScope	Rollenzuweisungseigenschaften.
type	string	Der Rollenzuweisungstyp.

RoleAssignmentListResult

Objekt

Ergebnis des Vorgangs der Rollenzuweisungsliste.

Name	Typ	Beschreibung
nextLink	string	Die URL, die zum Abrufen des nächsten Resultsets verwendet werden soll.
value	RoleAssignment[]	Liste der Rollenzuweisungen.

RoleAssignmentPropertiesWithScope

Objekt

Rollenzuweisungseigenschaften mit Bereich.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID.
roleDefinitionId	string	Die Rollendefinitions-ID.
scope	RoleScope	Der Rollenbereich.

RoleScope

Enumeration

Der Rollenbereich.

Wert	Beschreibung
/	Globaler Bereich
/keys	Geltungsbereich von Schlüsseln