Role Definitions - List

Tjänst:

Key Vault

API-version:

2025-07-01

Hämta alla rolldefinitioner som gäller i omfånget och högre.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
scope	path	True	string	Omfånget för rolldefinitionen.
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
$filter	query		string	Filtret som ska tillämpas på åtgärden. Använd filtret atScopeAndBelow för att även söka under det angivna omfånget.

Svar

Name	Typ	Description
200 OK	RoleDefinitionListResult	Begäran har slutförts.
Other Status Codes	KeyVaultError	Ett oväntat felsvar.

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
https://vault.azure.net/.default

Exempel

Get all role definitions that are applicable at scope and above

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
DataAction	Behörigheter som stöds för dataåtgärder.
Error
KeyVaultError	Felundantaget för nyckelvalvet.
Permission	Behörigheter för rolldefinition.
RoleDefinition	Definition av roll.
RoleDefinitionListResult	Åtgärdsresultat för rolldefinitionslista.
RoleDefinitionType	Typ av rolldefinition.
RoleScope	Rollens omfång.
RoleType	Typ av roll.

DataAction

Uppräkning

Behörigheter som stöds för dataåtgärder.

Värde	Description
Microsoft.KeyVault/managedHsm/keys/read/action	Läs metadata för HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/write/action	Uppdatera en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	Läs borttagen HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	Återställ borttagen HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/backup/action	Säkerhetskopiera HSM-nycklar.
Microsoft.KeyVault/managedHsm/keys/restore/action	Återställa HSM-nycklar.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	Ta bort rolltilldelning.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	Hämta rolltilldelning.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	Skapa eller uppdatera rolltilldelning.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	Hämta rolldefinition.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	Skapa eller uppdatera rolldefinitionen.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	Ta bort rolldefinitionen.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	Kryptera med en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	Dekryptera med en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/wrap/action	Omslut med en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	Packa upp med en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/sign/action	Signera med en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/verify/action	Verifiera med hjälp av en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/create	Skapa en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/delete	Ta bort en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/export/action	Exportera en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/release/action	Frigör en HSM-nyckel med hjälp av Secure Key Release.
Microsoft.KeyVault/managedHsm/keys/import/action	Importera en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	Rensa en borttagen HSM-nyckel.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	Ladda ned en HSM-säkerhetsdomän.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	Kontrollera status för nedladdning av HSM-säkerhetsdomän.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	Ladda upp en HSM-säkerhetsdomän.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	Kontrollera statusen för utbytesfilen för HSM-säkerhetsdomänen.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	Ladda ned en överföringsnyckel för HSM-säkerhetsdomänen.
Microsoft.KeyVault/managedHsm/backup/start/action	Starta en HSM-säkerhetskopiering.
Microsoft.KeyVault/managedHsm/restore/start/action	Starta en HSM-återställning.
Microsoft.KeyVault/managedHsm/backup/status/action	Läsa status för en HSM-säkerhetskopiering.
Microsoft.KeyVault/managedHsm/restore/status/action	Läs en HSM-återställningsstatus.
Microsoft.KeyVault/managedHsm/rng/action	Generera slumptal.

Error

Objekt

Name	Typ	Description
code	string	Felkoden.
innererror	Error	Felet på nyckelvalvsservern.
message	string	Felmeddelandet.

KeyVaultError

Objekt

Felundantaget för nyckelvalvet.

Name	Typ	Description
error	Error	Felet på nyckelvalvsservern.

Permission

Objekt

Behörigheter för rolldefinition.

Name	Typ	Description
actions	string[]	Åtgärdsbehörigheter som beviljas.
dataActions	DataAction[]	Behörigheter för dataåtgärd som har beviljats.
notActions	string[]	Åtgärdsbehörigheter som är undantagna men inte nekade. De kan beviljas av andra rolldefinitioner som tilldelats ett huvudkonto.
notDataActions	DataAction[]	Behörigheter för dataåtgärder som är undantagna men inte nekade. De kan beviljas av andra rolldefinitioner som tilldelats ett huvudkonto.

RoleDefinition

Objekt

Definition av roll.

Name	Typ	Description
id	string	Rolldefinitions-ID.
name	string	Namnet på rolldefinitionen.
properties.assignableScopes	RoleScope[]	Tilldelningsbara omfång för rolldefinition.
properties.description	string	Beskrivning av rolldefinitionen.
properties.permissions	Permission[]	Behörigheter för rolldefinition.
properties.roleName	string	Rollnamnet.
properties.type	RoleType	Typ av roll.
type	RoleDefinitionType	Typ av rolldefinition.

RoleDefinitionListResult

Objekt

Åtgärdsresultat för rolldefinitionslista.

Name	Typ	Description
nextLink	string	Den URL som ska användas för att hämta nästa uppsättning resultat.
value	RoleDefinition[]	Lista över rolldefinitioner.

RoleDefinitionType

Uppräkning

Typ av rolldefinition.

Värde	Description
Microsoft.Authorization/roleDefinitions	Microsoft-definierade rolldefinitioner.

RoleScope

Uppräkning

Rollens omfång.

Värde	Description
/	Global räckvidd
/keys	Omfång för nycklar

RoleType

Uppräkning

Typ av roll.

Värde	Description
AKVBuiltInRole	Inbyggd roll.
CustomRole	Anpassad roll.