Role Definitions - List

Usługa:

Key Vault

Wersja interfejsu API:

7.4

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

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
scope	path	True	string	Zakres definicji roli.
vaultBaseUrl	path	True	string	Nazwa magazynu, na przykład https://myvault.vault.azure.net.
api-version	query	True	string	Wersja interfejsu API klienta.
$filter	query		string	Filtr do zastosowania w operacji. Użyj filtru atScopeAndBelow, aby wyszukać pod podanym zakresem.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RoleDefinitionListResult	OK — zwraca tablicę definicji ról.
Other Status Codes	KeyVaultError	Key Vault odpowiedź o błędzie opisująca, dlaczego operacja nie powiodła się.

Przykłady

ListRoleDefinitions

Przykładowe żądanie

HTTP

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

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 dla akcji danych.
Error	Błąd serwera magazynu kluczy.
KeyVaultError	Wyjątek błędu magazynu kluczy.
Permission	Uprawnienia definicji roli.
RoleDefinition	Definicja roli.
RoleDefinitionListResult	Wynik operacji listy definicji roli.
RoleDefinitionType	Typ definicji roli.
RoleScope	Zakres roli.
RoleType	Typ roli.

DataAction

Obsługiwane uprawnienia dla akcji danych.

Nazwa	Typ	Opis
Microsoft.KeyVault/managedHsm/backup/start/action	string	Uruchom kopię zapasową modułu HSM.
Microsoft.KeyVault/managedHsm/backup/status/action	string	Odczyt stanu kopii zapasowej modułu HSM.
Microsoft.KeyVault/managedHsm/keys/backup/action	string	Tworzenie kopii zapasowych kluczy HSM.
Microsoft.KeyVault/managedHsm/keys/create	string	Utwórz klucz HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	string	Odszyfruj przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/delete	string	Usuń klucz HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	string	Przeczyść usunięty klucz HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	string	Odczyt usuniętego klucza modułu HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	string	Odzyskiwanie usuniętego klucza modułu HSM.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	string	Szyfrowanie przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/export/action	string	Wyeksportuj klucz HSM.
Microsoft.KeyVault/managedHsm/keys/import/action	string	Zaimportuj klucz HSM.
Microsoft.KeyVault/managedHsm/keys/read/action	string	Odczytywanie metadanych klucza modułu HSM.
Microsoft.KeyVault/managedHsm/keys/release/action	string	Zwolnij klucz HSM przy użyciu bezpiecznego wydania klucza.
Microsoft.KeyVault/managedHsm/keys/restore/action	string	Przywracanie kluczy HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action	string	Podpisywanie przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	string	Odpakuj przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action	string	Sprawdź przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action	string	Zawijanie przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/write/action	string	Aktualizowanie klucza modułu HSM.
Microsoft.KeyVault/managedHsm/restore/start/action	string	Uruchom przywracanie modułu HSM.
Microsoft.KeyVault/managedHsm/restore/status/action	string	Odczyt stanu przywracania modułu HSM.
Microsoft.KeyVault/managedHsm/rng/action	string	Generowanie liczb losowych.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	string	Usuń przypisanie roli.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	string	Pobierz przypisanie roli.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	string	Utwórz lub zaktualizuj przypisanie roli.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	string	Usuń definicję roli.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	string	Pobierz definicję roli.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	string	Tworzenie lub aktualizowanie definicji roli.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	string	Pobierz domenę zabezpieczeń modułu HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	string	Sprawdź stan pobierania domeny zabezpieczeń modułu HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	string	Pobierz klucz transferu domeny zabezpieczeń modułu HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	string	Przekaż domenę zabezpieczeń modułu HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	string	Sprawdź stan pliku wymiany domeny zabezpieczeń modułu HSM.

Error

Błąd serwera magazynu kluczy.

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

KeyVaultError

Wyjątek błędu magazynu kluczy.

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

Permission

Uprawnienia definicji roli.

Nazwa	Typ	Opis
actions	string[]	Przyznane uprawnienia akcji.
dataActions	DataAction[]	Przyznane uprawnienia akcji danych.
notActions	string[]	Uprawnienia 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 akcji danych, które są wykluczone, ale nie zostały odrzucone. Mogą one być przyznawane przez inne definicje ról przypisane do podmiotu zabezpieczeń.

RoleDefinition

Definicja roli.

Nazwa	Typ	Opis
id	string	Identyfikator definicji roli.
name	string	Nazwa definicji roli.
properties.assignableScopes	RoleScope[]	Zakresy przypisywane przez definicję roli.
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

Wynik operacji listy definicji roli.

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

RoleDefinitionType

Typ definicji roli.

Nazwa	Typ	Opis
Microsoft.Authorization/roleDefinitions	string

RoleScope

Zakres roli.

Nazwa	Typ	Opis
/	string	Zakres globalny
/keys	string	Zakres kluczy

RoleType

Typ roli.

Nazwa	Typ	Opis
AKVBuiltInRole	string	Wbudowana rola.
CustomRole	string	Rola niestandardowa.