Dela via


Role Definitions - List

Hämta alla rolldefinitioner som är tillämpliga i omfånget och senare.

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

URI-parametrar

Name I Obligatorisk Typ Description
scope
path True

string

Rolldefinitionens omfattning.

vaultBaseUrl
path True

string

Valvnamnet, till exempel https://myvault.vault.azure.net.

api-version
query True

string

Klient-API-version.

$filter
query

string

Filtret som ska tillämpas på åtgärden. Använd atScopeAndBelow-filtret för att söka under det angivna omfånget också.

Svar

Name Typ Description
200 OK

RoleDefinitionListResult

OK – Returnerar en matris med rolldefinitioner.

Other Status Codes

KeyVaultError

Key Vault felsvar som beskriver varför åtgärden misslyckades.

Exempel

ListRoleDefinitions

Exempelbegäran

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

Exempelsvar

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

Key Vault-serverns fel.

KeyVaultError

Felfelet för nyckelvalvet.

Permission

Behörigheter för rolldefinition.

RoleDefinition

Rolldefinition.

RoleDefinitionListResult

Åtgärdsresultat för rolldefinitionslista.

RoleDefinitionType

Rolldefinitionstypen.

RoleScope

Rollomfånget.

RoleType

Rolltypen.

DataAction

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

Värde Description
Microsoft.KeyVault/managedHsm/backup/start/action

Starta en HSM-säkerhetskopiering.

Microsoft.KeyVault/managedHsm/backup/status/action

Läs status för HSM-säkerhetskopiering.

Microsoft.KeyVault/managedHsm/keys/backup/action

Säkerhetskopiera HSM-nycklar.

Microsoft.KeyVault/managedHsm/keys/create

Skapa en HSM-nyckel.

Microsoft.KeyVault/managedHsm/keys/decrypt/action

Dekryptera med en HSM-nyckel.

Microsoft.KeyVault/managedHsm/keys/delete

Ta bort en HSM-nyckel.

Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete

Rensa en borttagen 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/encrypt/action

Kryptera med en HSM-nyckel.

Microsoft.KeyVault/managedHsm/keys/export/action

Exportera en HSM-nyckel.

Microsoft.KeyVault/managedHsm/keys/import/action

Importera en HSM-nyckel.

Microsoft.KeyVault/managedHsm/keys/read/action

Läs HSM-nyckelmetadata.

Microsoft.KeyVault/managedHsm/keys/release/action

Släpp en HSM-nyckel med säker nyckel.

Microsoft.KeyVault/managedHsm/keys/restore/action

Återställ HSM-nycklar.

Microsoft.KeyVault/managedHsm/keys/sign/action

Signera med en HSM-nyckel.

Microsoft.KeyVault/managedHsm/keys/unwrap/action

Packa upp med en HSM-nyckel.

Microsoft.KeyVault/managedHsm/keys/verify/action

Verifiera med hjälp av en HSM-nyckel.

Microsoft.KeyVault/managedHsm/keys/wrap/action

Omslut med en HSM-nyckel.

Microsoft.KeyVault/managedHsm/keys/write/action

Uppdatera en HSM-nyckel.

Microsoft.KeyVault/managedHsm/restore/start/action

Starta en HSM-återställning.

Microsoft.KeyVault/managedHsm/restore/status/action

Läs en HSM-återställningsstatus.

Microsoft.KeyVault/managedHsm/rng/action

Generera slumpmässiga tal.

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/delete/action

Ta bort rolldefinition.

Microsoft.KeyVault/managedHsm/roleDefinitions/read/action

Hämta rolldefinition.

Microsoft.KeyVault/managedHsm/roleDefinitions/write/action

Skapa eller uppdatera rolldefinitionen.

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/transferkey/read

Ladda ned en HSM-säkerhetsnyckel för domänöverföring.

Microsoft.KeyVault/managedHsm/securitydomain/upload/action

Ladda upp en HSM-säkerhetsdomän.

Microsoft.KeyVault/managedHsm/securitydomain/upload/read

Kontrollera statusen för HSM-säkerhetsdomänens exchange-fil.

Error

Key Vault-serverns fel.

Name Typ Description
code

string

Felkoden.

innererror

Error

Key Vault-serverns fel.

message

string

Felmeddelandet.

KeyVaultError

Felfelet för nyckelvalvet.

Name Typ Description
error

Error

Key Vault-serverns fel.

Permission

Behörigheter för rolldefinition.

Name Typ Description
actions

string[]

Åtgärdsbehörigheter som beviljas.

dataActions

DataAction[]

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

notActions

string[]

Åtgärdsbehörigheter som undantas men inte nekas. De kan beviljas av andra rolldefinitioner som tilldelats ett huvudkonto.

notDataActions

DataAction[]

Behörigheter för dataåtgärder som undantas men inte nekas. De kan beviljas av andra rolldefinitioner som tilldelats ett huvudkonto.

RoleDefinition

Rolldefinition.

Name Typ Description
id

string

Rolldefinitions-ID.

name

string

Rolldefinitionens namn.

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

Rolltypen.

type

RoleDefinitionType

Rolldefinitionstypen.

RoleDefinitionListResult

Å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[]

Rolldefinitionslista.

RoleDefinitionType

Rolldefinitionstypen.

Värde Description
Microsoft.Authorization/roleDefinitions

RoleScope

Rollomfånget.

Värde Description
/

Globalt omfång

/keys

Omfång för nycklar

RoleType

Rolltypen.

Värde Description
AKVBuiltInRole

Inbyggd roll.

CustomRole

Anpassad roll.