Role Definitions - Create Or Update

Tjänst:

Key Vault

API-version:

7.4

Skapar eller uppdaterar en anpassad rolldefinition.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
roleDefinitionName	path	True	string	Namnet på rolldefinitionen som ska skapas eller uppdateras. Det kan vara valfritt giltigt GUID.
scope	path	True	string	Omfånget för rolldefinitionen som ska skapas eller uppdateras. Hanterad HSM stöder endast "/".
vaultBaseUrl	path	True	string	Valvnamnet, till exempel https://myvault.vault.azure.net.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Obligatorisk	Typ	Description
properties	True	RoleDefinitionProperties	Egenskaper för rolldefinition.

Svar

Name	Typ	Description
201 Created	RoleDefinition	Skapad – Returnerar information om rolldefinitionen.
Other Status Codes	KeyVaultError	Key Vault-felsvar som beskriver varför åtgärden misslyckades.

Exempel

PutRoleDefinition

Exempelbegäran

HTTP

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

{
  "properties": {
    "roleName": "My custom role",
    "type": "CustomRole",
    "description": "Role description",
    "permissions": [
      {
        "dataActions": [
          "Microsoft.KeyVault/managedHsm/keys/sign/action"
        ]
      }
    ]
  }
}

Exempelsvar

Statuskod:

201

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

Definitioner

Name	Description
DataAction	Behörigheter som stöds för dataåtgärder.
Error	Key Vault-serverfelet.
KeyVaultError	Felfelet för nyckelvalvet.
Permission	Behörigheter för rolldefinition.
RoleDefinition	Rolldefinition.
RoleDefinitionCreateParameters	Skapa parametrar för rolldefinition.
RoleDefinitionProperties	Egenskaper för rolldefinition.
RoleDefinitionType	Rolldefinitionstypen.
RoleScope	Rollomfånget.
RoleType	Rolltypen.

DataAction

Uppräkning

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 en HSM-säkerhetskopieringsstatus.
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	Kontrollera att du använder 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

Objekt

Key Vault-serverfelet.

Name	Typ	Description
code	string	Felkoden.
innererror	Error	Key Vault-serverfelet.
message	string	Felmeddelandet.

KeyVaultError

Objekt

Felfelet för nyckelvalvet.

Name	Typ	Description
error	Error	Key Vault-serverfelet.

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ärder som beviljas.
notActions	string[]	Åtgärdsbehörigheter som undantas men inte nekas. De kan beviljas av andra rolldefinitioner som tilldelats ett huvudnamn.
notDataActions	DataAction[]	Behörigheter för dataåtgärder som är undantagna men som inte nekas. De kan beviljas av andra rolldefinitioner som tilldelats ett huvudnamn.

RoleDefinition

Objekt

Rolldefinition.

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

RoleDefinitionCreateParameters

Objekt

Skapa parametrar för rolldefinition.

Name	Typ	Description
properties	RoleDefinitionProperties	Egenskaper för rolldefinition.

RoleDefinitionProperties

Objekt

Egenskaper för rolldefinition.

Name	Typ	Description
assignableScopes	RoleScope[]	Tilldelningsbara omfång för rolldefinition.
description	string	Beskrivningen av rolldefinitionen.
permissions	Permission[]	Behörigheter för rolldefinition.
roleName	string	Rollnamnet.
type	RoleType	Rolltypen.

RoleDefinitionType

Uppräkning

Rolldefinitionstypen.

Värde	Description
Microsoft.Authorization/roleDefinitions

RoleScope

Uppräkning

Rollomfånget.

Värde	Description
/	Globalt omfång
/keys	Omfång för nycklar

RoleType

Uppräkning

Rolltypen.

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