Role Definitions - Create Or Update

Service:

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 för att skapa eller uppdatera. 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

Sample Request

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

Sample Response

Status code:

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	Nyckelvalvsserverfelet.
KeyVaultError	Felfelet för nyckelvalvet.
Permission	Behörigheter för rolldefinition.
RoleDefinition	Rolldefinition.
RoleDefinitionCreateParameters	Rolldefinitionen skapar parametrar.
RoleDefinitionProperties	Egenskaper för rolldefinition.
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 en HSM-säkerhetskopieringsstatus.
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 hjälp av säker nyckelversion.
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 rolldefinition.
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änutbytesfilen.

Error

Nyckelvalvsserverfelet.

Name	Typ	Description
code	string	Felkoden.
innererror	Error	Nyckelvalvsserverfelet.
message	string	Felmeddelandet.

KeyVaultError

Felfelet för nyckelvalvet.

Name	Typ	Description
error	Error	Nyckelvalvsserverfelet.

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 huvudnamn.
notDataActions	DataAction[]	Dataåtgärdsbehörigheter som undantas men inte nekas. De kan beviljas av andra rolldefinitioner som tilldelats ett huvudnamn.

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	Beskrivningen av rolldefinitionen.
properties.permissions	Permission[]	Behörigheter för rolldefinition.
properties.roleName	string	Rollnamnet.
properties.type	RoleType	Rolltypen.
type	RoleDefinitionType	Rolldefinitionstypen.

RoleDefinitionCreateParameters

Rolldefinitionen skapar parametrar.

Name	Typ	Description
properties	RoleDefinitionProperties	Egenskaper för rolldefinition.

RoleDefinitionProperties

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

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.