Role Definitions - Get

Service:

Key Vault

API-versie:

7.4

Haal de opgegeven roldefinitie op.

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

URI-parameters

Name	In	Vereist	Type	Description
roleDefinitionName	path	True	string	De naam van de roldefinitie die u wilt ophalen.
scope	path	True	string	Het bereik van de roldefinitie die u wilt ophalen. Beheerde HSM ondersteunt alleen '/'.
vaultBaseUrl	path	True	string	De kluisnaam, bijvoorbeeld https://myvault.vault.azure.net.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	RoleDefinition	OK: retourneert informatie over de roldefinitie.
Other Status Codes	KeyVaultError	Key Vault foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

GetRoleAssignments

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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"
}

Definities

Name	Description
DataAction	Ondersteunde machtigingen voor gegevensacties.
Error	De sleutelkluisserverfout.
KeyVaultError	De foutuitzondering voor de sleutelkluis.
Permission	Roldefinitiemachtigingen.
RoleDefinition	Roldefinitie.
RoleDefinitionType	Het type roldefinitie.
RoleScope	Het rolbereik.
RoleType	Het roltype.

DataAction

Ondersteunde machtigingen voor gegevensacties.

Name	Type	Description
Microsoft.KeyVault/managedHsm/backup/start/action	string	Start een HSM-back-up.
Microsoft.KeyVault/managedHsm/backup/status/action	string	Lees de back-upstatus van een HSM.
Microsoft.KeyVault/managedHsm/keys/backup/action	string	Back-up maken van HSM-sleutels.
Microsoft.KeyVault/managedHsm/keys/create	string	Maak een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	string	Ontsleutelen met een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/delete	string	Een HSM-sleutel verwijderen.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	string	Een verwijderde HSM-sleutel opschonen.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	string	Verwijderde HSM-sleutel lezen.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	string	Verwijderde HSM-sleutel herstellen.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	string	Versleutelen met behulp van een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/export/action	string	Een HSM-sleutel exporteren.
Microsoft.KeyVault/managedHsm/keys/import/action	string	Importeer een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/read/action	string	Metagegevens van HSM-sleutels lezen.
Microsoft.KeyVault/managedHsm/keys/release/action	string	Een HSM-sleutel vrijgeven met behulp van Secure Key Release.
Microsoft.KeyVault/managedHsm/keys/restore/action	string	HSM-sleutels herstellen.
Microsoft.KeyVault/managedHsm/keys/sign/action	string	Teken met een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	string	Uitpakken met behulp van een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/verify/action	string	Controleer met behulp van een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/wrap/action	string	Verpakken met behulp van een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/write/action	string	Een HSM-sleutel bijwerken.
Microsoft.KeyVault/managedHsm/restore/start/action	string	Een HSM-herstel starten.
Microsoft.KeyVault/managedHsm/restore/status/action	string	Een HSM-herstelstatus lezen.
Microsoft.KeyVault/managedHsm/rng/action	string	Genereer willekeurige getallen.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	string	Roltoewijzing verwijderen.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	string	Roltoewijzing ophalen.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	string	Roltoewijzing maken of bijwerken.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	string	Roldefinitie verwijderen.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	string	Roldefinitie ophalen.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	string	Roldefinitie maken of bijwerken.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	string	Download een HSM-beveiligingsdomein.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	string	Controleer de status van het downloaden van het HSM-beveiligingsdomein.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	string	Download een overdrachtssleutel voor een HSM-beveiligingsdomein.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	string	Upload een HSM-beveiligingsdomein.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	string	Controleer de status van het exchange-bestand van het HSM-beveiligingsdomein.

Error

De sleutelkluisserverfout.

Name	Type	Description
code	string	De foutcode.
innererror	Error	De sleutelkluisserverfout.
message	string	Het foutbericht.

KeyVaultError

De foutuitzondering voor de sleutelkluis.

Name	Type	Description
error	Error	De sleutelkluisserverfout.

Permission

Roldefinitiemachtigingen.

Name	Type	Description
actions	string[]	Actiemachtigingen die worden verleend.
dataActions	DataAction[]	Machtigingen voor gegevensacties die worden verleend.
notActions	string[]	Actiemachtigingen die zijn uitgesloten, maar niet worden geweigerd. Ze kunnen worden verleend door andere roldefinities die aan een principal zijn toegewezen.
notDataActions	DataAction[]	Machtigingen voor gegevensacties die zijn uitgesloten, maar niet worden geweigerd. Ze kunnen worden verleend door andere roldefinities die aan een principal zijn toegewezen.

RoleDefinition

Roldefinitie.

Name	Type	Description
id	string	De roldefinitie-id.
name	string	De naam van de roldefinitie.
properties.assignableScopes	RoleScope[]	Toewijsbare bereiken voor roldefinities.
properties.description	string	De beschrijving van de roldefinitie.
properties.permissions	Permission[]	Roldefinitiemachtigingen.
properties.roleName	string	De naam van de rol.
properties.type	RoleType	Het roltype.
type	RoleDefinitionType	Het type roldefinitie.

RoleDefinitionType

Het type roldefinitie.

Name	Type	Description
Microsoft.Authorization/roleDefinitions	string

RoleScope

Het rolbereik.

Name	Type	Description
/	string	Globaal bereik
/keys	string	Sleutelbereik

RoleType

Het roltype.

Name	Type	Description
AKVBuiltInRole	string	Ingebouwde rol.
CustomRole	string	Aangepaste rol.