Role Definitions - List

Tjänst:

Key Vault

API-version:

7.4

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

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

Med valfria parametrar:

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

HTTP

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

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

Name	Typ	Description
Microsoft.KeyVault/managedHsm/backup/start/action	string	Starta en HSM-säkerhetskopiering.
Microsoft.KeyVault/managedHsm/backup/status/action	string	Läs status för HSM-säkerhetskopiering.
Microsoft.KeyVault/managedHsm/keys/backup/action	string	Säkerhetskopiera HSM-nycklar.
Microsoft.KeyVault/managedHsm/keys/create	string	Skapa en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	string	Dekryptera med en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/delete	string	Ta bort en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	string	Rensa en borttagen HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	string	Läs borttagen HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	string	Återställ borttagen HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	string	Kryptera med en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/export/action	string	Exportera en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/import/action	string	Importera en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/read/action	string	Läs HSM-nyckelmetadata.
Microsoft.KeyVault/managedHsm/keys/release/action	string	Släpp en HSM-nyckel med säker nyckel.
Microsoft.KeyVault/managedHsm/keys/restore/action	string	Återställ HSM-nycklar.
Microsoft.KeyVault/managedHsm/keys/sign/action	string	Signera med en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	string	Packa upp med en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/verify/action	string	Verifiera med hjälp av en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/wrap/action	string	Omslut med en HSM-nyckel.
Microsoft.KeyVault/managedHsm/keys/write/action	string	Uppdatera en HSM-nyckel.
Microsoft.KeyVault/managedHsm/restore/start/action	string	Starta en HSM-återställning.
Microsoft.KeyVault/managedHsm/restore/status/action	string	Läs en HSM-återställningsstatus.
Microsoft.KeyVault/managedHsm/rng/action	string	Generera slumpmässiga tal.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	string	Ta bort rolltilldelning.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	string	Hämta rolltilldelning.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	string	Skapa eller uppdatera rolltilldelning.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	string	Ta bort rolldefinition.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	string	Hämta rolldefinition.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	string	Skapa eller uppdatera rolldefinitionen.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	string	Ladda ned en HSM-säkerhetsdomän.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	string	Kontrollera status för nedladdning av HSM-säkerhetsdomän.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	string	Ladda ned en HSM-säkerhetsnyckel för domänöverföring.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	string	Ladda upp en HSM-säkerhetsdomän.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	string	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.

Name	Typ	Description
Microsoft.Authorization/roleDefinitions	string

RoleScope

Rollomfånget.

Name	Typ	Description
/	string	Globalt omfång
/keys	string	Omfång för nycklar

RoleType

Rolltypen.

Name	Typ	Description
AKVBuiltInRole	string	Inbyggd roll.
CustomRole	string	Anpassad roll.