Delen via


Role Definitions - Get

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

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

Voorbeeldrespons

{
  "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.

Waarde Description
Microsoft.KeyVault/managedHsm/backup/start/action

Start een HSM-back-up.

Microsoft.KeyVault/managedHsm/backup/status/action

Lees de back-upstatus van een HSM.

Microsoft.KeyVault/managedHsm/keys/backup/action

Back-up maken van HSM-sleutels.

Microsoft.KeyVault/managedHsm/keys/create

Maak een HSM-sleutel.

Microsoft.KeyVault/managedHsm/keys/decrypt/action

Ontsleutelen met een HSM-sleutel.

Microsoft.KeyVault/managedHsm/keys/delete

Een HSM-sleutel verwijderen.

Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete

Een verwijderde HSM-sleutel opschonen.

Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action

Verwijderde HSM-sleutel lezen.

Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action

Verwijderde HSM-sleutel herstellen.

Microsoft.KeyVault/managedHsm/keys/encrypt/action

Versleutelen met behulp van een HSM-sleutel.

Microsoft.KeyVault/managedHsm/keys/export/action

Een HSM-sleutel exporteren.

Microsoft.KeyVault/managedHsm/keys/import/action

Importeer een HSM-sleutel.

Microsoft.KeyVault/managedHsm/keys/read/action

Metagegevens van HSM-sleutels lezen.

Microsoft.KeyVault/managedHsm/keys/release/action

Een HSM-sleutel vrijgeven met behulp van Secure Key Release.

Microsoft.KeyVault/managedHsm/keys/restore/action

HSM-sleutels herstellen.

Microsoft.KeyVault/managedHsm/keys/sign/action

Teken met een HSM-sleutel.

Microsoft.KeyVault/managedHsm/keys/unwrap/action

Uitpakken met behulp van een HSM-sleutel.

Microsoft.KeyVault/managedHsm/keys/verify/action

Controleer met behulp van een HSM-sleutel.

Microsoft.KeyVault/managedHsm/keys/wrap/action

Verpakken met behulp van een HSM-sleutel.

Microsoft.KeyVault/managedHsm/keys/write/action

Een HSM-sleutel bijwerken.

Microsoft.KeyVault/managedHsm/restore/start/action

Een HSM-herstel starten.

Microsoft.KeyVault/managedHsm/restore/status/action

Een HSM-herstelstatus lezen.

Microsoft.KeyVault/managedHsm/rng/action

Genereer willekeurige getallen.

Microsoft.KeyVault/managedHsm/roleAssignments/delete/action

Roltoewijzing verwijderen.

Microsoft.KeyVault/managedHsm/roleAssignments/read/action

Roltoewijzing ophalen.

Microsoft.KeyVault/managedHsm/roleAssignments/write/action

Roltoewijzing maken of bijwerken.

Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action

Roldefinitie verwijderen.

Microsoft.KeyVault/managedHsm/roleDefinitions/read/action

Roldefinitie ophalen.

Microsoft.KeyVault/managedHsm/roleDefinitions/write/action

Roldefinitie maken of bijwerken.

Microsoft.KeyVault/managedHsm/securitydomain/download/action

Download een HSM-beveiligingsdomein.

Microsoft.KeyVault/managedHsm/securitydomain/download/read

Controleer de status van het downloaden van het HSM-beveiligingsdomein.

Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read

Download een overdrachtssleutel voor een HSM-beveiligingsdomein.

Microsoft.KeyVault/managedHsm/securitydomain/upload/action

Upload een HSM-beveiligingsdomein.

Microsoft.KeyVault/managedHsm/securitydomain/upload/read

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.

Waarde Description
Microsoft.Authorization/roleDefinitions

RoleScope

Het rolbereik.

Waarde Description
/

Globaal bereik

/keys

Sleutelbereik

RoleType

Het roltype.

Waarde Description
AKVBuiltInRole

Ingebouwde rol.

CustomRole

Aangepaste rol.