Role Definitions - Create Or Update

Service:

Key Vault

API-versie:

7.4

Hiermee maakt of werkt u een aangepaste roldefinitie bij.

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

URI-parameters

Name	In	Vereist	Type	Description
roleDefinitionName	path	True	string	De naam van de roldefinitie die moet worden gemaakt of bijgewerkt. Dit kan elke geldige GUID zijn.
scope	path	True	string	Het bereik van de roldefinitie die moet worden gemaakt of bijgewerkt. Beheerde HSM ondersteunt alleen '/'.
vaultBaseUrl	path	True	string	De kluisnaam, bijvoorbeeld https://myvault.vault.azure.net.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Vereist	Type	Description
properties	True	RoleDefinitionProperties	Eigenschappen van roldefinities.

Antwoorden

Name	Type	Description
201 Created	RoleDefinition	Gemaakt: retourneert informatie over de roldefinitie.
Other Status Codes	KeyVaultError	Key Vault-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

PutRoleDefinition

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
DataAction	Ondersteunde machtigingen voor gegevensacties.
Error	De sleutelkluisserverfout.
KeyVaultError	De fout-uitzondering voor de sleutelkluis.
Permission	Machtigingen voor roldefinities.
RoleDefinition	Roldefinitie.
RoleDefinitionCreateParameters	Parameters maken voor roldefinities.
RoleDefinitionProperties	Eigenschappen van roldefinities.
RoleDefinitionType	Het type roldefinitie.
RoleScope	Het rolbereik.
RoleType	Het roltype.

DataAction

Inventarisatie

Ondersteunde machtigingen voor gegevensacties.

Waarde	Description
Microsoft.KeyVault/managedHsm/backup/start/action	Start een HSM-back-up.
Microsoft.KeyVault/managedHsm/backup/status/action	Lees de back-upstatus van een HSM.
Microsoft.KeyVault/managedHsm/keys/backup/action	Back-up maken van HSM-sleutels.
Microsoft.KeyVault/managedHsm/keys/create	Maak een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	Ontsleutelen met behulp van een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/delete	Een HSM-sleutel verwijderen.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	Een verwijderde HSM-sleutel leegmaken.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	Verwijderde HSM-sleutel lezen.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	Verwijderde HSM-sleutel herstellen.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	Versleutelen met behulp van een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/export/action	Een HSM-sleutel exporteren.
Microsoft.KeyVault/managedHsm/keys/import/action	Importeer een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/read/action	HSM-sleutelmetagegevens lezen.
Microsoft.KeyVault/managedHsm/keys/release/action	Een HSM-sleutel vrijgeven met Secure Key Release.
Microsoft.KeyVault/managedHsm/keys/restore/action	HSM-sleutels herstellen.
Microsoft.KeyVault/managedHsm/keys/sign/action	Meld u aan met een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	Uitpakken met behulp van een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/verify/action	Controleer of u een HSM-sleutel gebruikt.
Microsoft.KeyVault/managedHsm/keys/wrap/action	Verpakken met behulp van een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/write/action	Werk een HSM-sleutel bij.
Microsoft.KeyVault/managedHsm/restore/start/action	Start een HSM-herstel.
Microsoft.KeyVault/managedHsm/restore/status/action	Lees de herstelstatus van een HSM.
Microsoft.KeyVault/managedHsm/rng/action	Genereer willekeurige getallen.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	Roltoewijzing verwijderen.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	Roltoewijzing ophalen.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	Roltoewijzing maken of bijwerken.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	Roldefinitie verwijderen.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	Roldefinitie ophalen.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	Roldefinitie maken of bijwerken.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	Download een HSM-beveiligingsdomein.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	Controleer de status van het downloaden van het HSM-beveiligingsdomein.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	Download een HSM-beveiligingsdomeinoverdrachtssleutel.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	Upload een HSM-beveiligingsdomein.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	Controleer de status van het HSM-beveiligingsdomeinuitwisselingsbestand.

Error

Object

De sleutelkluisserverfout.

Name	Type	Description
code	string	De foutcode.
innererror	Error	De sleutelkluisserverfout.
message	string	Het foutbericht.

KeyVaultError

Object

De fout-uitzondering voor de sleutelkluis.

Name	Type	Description
error	Error	De sleutelkluisserverfout.

Permission

Object

Machtigingen voor roldefinities.

Name	Type	Description
actions	string[]	Actiemachtigingen die worden verleend.
dataActions	DataAction[]	Machtigingen voor gegevensacties die worden verleend.
notActions	string[]	Actiemachtigingen die worden uitgesloten, maar niet worden geweigerd. Ze kunnen worden verleend door andere roldefinities die zijn toegewezen aan een principal.
notDataActions	DataAction[]	Machtigingen voor gegevensacties die worden uitgesloten, maar niet worden geweigerd. Ze kunnen worden verleend door andere roldefinities die zijn toegewezen aan een principal.

RoleDefinition

Object

Roldefinitie.

Name	Type	Description
id	string	De id van de roldefinitie.
name	string	De naam van de roldefinitie.
properties.assignableScopes	RoleScope[]	Toewijsbare bereiken voor roldefinities.
properties.description	string	De beschrijving van de roldefinitie.
properties.permissions	Permission[]	Machtigingen voor roldefinities.
properties.roleName	string	De naam van de rol.
properties.type	RoleType	Het roltype.
type	RoleDefinitionType	Het type roldefinitie.

RoleDefinitionCreateParameters

Object

Parameters maken voor roldefinities.

Name	Type	Description
properties	RoleDefinitionProperties	Eigenschappen van roldefinities.

RoleDefinitionProperties

Object

Eigenschappen van roldefinities.

Name	Type	Description
assignableScopes	RoleScope[]	Toewijsbare bereiken voor roldefinities.
description	string	De beschrijving van de roldefinitie.
permissions	Permission[]	Machtigingen voor roldefinities.
roleName	string	De naam van de rol.
type	RoleType	Het roltype.

RoleDefinitionType

Inventarisatie

Het type roldefinitie.

Waarde	Description
Microsoft.Authorization/roleDefinitions

RoleScope

Inventarisatie

Het rolbereik.

Waarde	Description
/	Globaal bereik
/keys	Bereik sleutels

RoleType

Inventarisatie

Het roltype.

Waarde	Description
AKVBuiltInRole	Ingebouwde rol.
CustomRole	Aangepaste rol.