Role Definitions - List

Usługa:: Key Vault

Wersja interfejsu API:: 2025-07-01

Pobierz wszystkie definicje ról, które mają zastosowanie w zakresie i powyżej.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
scope	path	True	string	Zakres definicji roli.
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
$filter	query		string	Filtr do zastosowania w operacji. Użyj filtru atScopeAndBelow, aby wyszukać również poniżej podanego zakresu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RoleDefinitionListResult	Żądanie zakończyło się pomyślnie.
Other Status Codes	KeyVaultError	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://vault.azure.net/.default

Przykłady

Get all role definitions that are applicable at scope and above

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  ]
}

Definicje

Nazwa	Opis
DataAction	Obsługiwane uprawnienia do akcji na danych.
Error
KeyVaultError	Wyjątek błędu magazynu kluczy.
Permission	Uprawnienia definicji roli.
RoleDefinition	Definicja roli.
RoleDefinitionListResult	Wynik operacji na liście definicji ról.
RoleDefinitionType	Typ definicji roli.
RoleScope	Zakres roli.
RoleType	Typ roli.

DataAction

Wyliczanie

Obsługiwane uprawnienia do akcji na danych.

Wartość	Opis
Microsoft.KeyVault/managedHsm/keys/read/action	Odczytywanie metadanych klucza modułu HSM.
Microsoft.KeyVault/managedHsm/keys/write/action	Zaktualizuj klucz HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	Odczyt usuniętego klucza HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	Odzyskaj usunięty klucz HSM.
Microsoft.KeyVault/managedHsm/keys/backup/action	Kopia zapasowa kluczy HSM.
Microsoft.KeyVault/managedHsm/keys/restore/action	Przywróć klucze HSM.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	Usuń przypisanie roli.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	Pobierz przypisanie roli.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	Tworzenie lub aktualizowanie przypisania roli.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	Pobierz definicję roli.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	Tworzenie lub aktualizowanie definicji roli.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	Usuń definicję roli.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	Szyfruj przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	Odszyfrowywanie przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action	Zawijaj przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	Rozpakuj przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action	Podpisz przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action	Sprawdź przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/create	Utwórz klucz modułu HSM.
Microsoft.KeyVault/managedHsm/keys/delete	Usuń klucz HSM.
Microsoft.KeyVault/managedHsm/keys/export/action	Eksportowanie klucza HSM.
Microsoft.KeyVault/managedHsm/keys/release/action	Zwalnianie klucza HSM przy użyciu bezpiecznego zwalniania klucza.
Microsoft.KeyVault/managedHsm/keys/import/action	Zaimportuj klucz HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	Wyczyść usunięty klucz HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	Pobierz domenę zabezpieczeń modułu HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	Sprawdź stan pobierania domeny zabezpieczeń modułu HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	Przekaż domenę zabezpieczeń modułu HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	Sprawdź stan pliku wymiany domen zabezpieczeń modułu HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	Pobierz klucz transferu domeny zabezpieczeń modułu HSM.
Microsoft.KeyVault/managedHsm/backup/start/action	Uruchom kopię zapasową modułu HSM.
Microsoft.KeyVault/managedHsm/restore/start/action	Rozpocznij przywracanie modułu HSM.
Microsoft.KeyVault/managedHsm/backup/status/action	Odczytywanie stanu kopii zapasowej modułu HSM.
Microsoft.KeyVault/managedHsm/restore/status/action	Odczytywanie stanu przywracania modułu HSM.
Microsoft.KeyVault/managedHsm/rng/action	Generuj liczby losowe.

Error

Objekt

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	Error	Błąd serwera magazynu kluczy.
message	string	Komunikat o błędzie.

KeyVaultError

Objekt

Wyjątek błędu magazynu kluczy.

Nazwa	Typ	Opis
error	Error	Błąd serwera magazynu kluczy.

Permission

Objekt

Uprawnienia definicji roli.

Nazwa	Typ	Opis
actions	string[]	Uprawnienia do akcji, które są udzielane.
dataActions	DataAction[]	Uprawnienia do działania na danych, które są udzielane.
notActions	string[]	Uprawnienia do akcji, które są wykluczone, ale nie zostały odrzucone. Mogą one być przyznawane przez inne definicje ról przypisane do podmiotu zabezpieczeń.
notDataActions	DataAction[]	Uprawnienia do działania na danych, które są wykluczone, ale nie odrzucone. Mogą one być przyznawane przez inne definicje ról przypisane do podmiotu zabezpieczeń.

RoleDefinition

Objekt

Definicja roli.

Nazwa	Typ	Opis
id	string	Identyfikator definicji roli.
name	string	Nazwa definicji roli.
properties.assignableScopes	RoleScope[]	Zakresy, które można przypisać do definicji ról.
properties.description	string	Opis definicji roli.
properties.permissions	Permission[]	Uprawnienia definicji roli.
properties.roleName	string	Nazwa roli.
properties.type	RoleType	Typ roli.
type	RoleDefinitionType	Typ definicji roli.

RoleDefinitionListResult

Objekt

Wynik operacji na liście definicji ról.

Nazwa	Typ	Opis
nextLink	string	Adres URL używany do pobierania następnego zestawu wyników.
value	RoleDefinition[]	Lista definicji ról.

RoleDefinitionType

Wyliczanie

Typ definicji roli.

Wartość	Opis
Microsoft.Authorization/roleDefinitions	Definicje ról zdefiniowane przez firmę Microsoft.

RoleScope

Wyliczanie

Zakres roli.

Wartość	Opis
/	Globalny zasięg
/keys	Zakres kluczy

RoleType

Wyliczanie

Typ roli.

Wartość	Opis
AKVBuiltInRole	Wbudowana rola.
CustomRole	Rola niestandardowa.

Udostępnij przez

Role Definitions - List

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

OAuth2Auth

Zakresy

Przykłady

Get all role definitions that are applicable at scope and above

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

DataAction

Error

KeyVaultError

Permission

RoleDefinition

RoleDefinitionListResult

RoleDefinitionType

RoleScope

RoleType