Role Definitions - Create Or Update

Referenz

Dienst:: Key Vault

API-Version:: 7.4

Erstellt oder aktualisiert eine benutzerdefinierte Rollendefinition.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
roleDefinitionName	path	True	string	Der Name der zu erstellenden oder zu aktualisierenden Rollendefinition. Es kann sich um eine beliebige gültige GUID sein.
scope	path	True	string	Der Bereich der zu erstellenden oder zu aktualisierenden Rollendefinition. Verwaltetes HSM unterstützt nur "/".
vaultBaseUrl	path	True	string	Der Tresorname, z. B https://myvault.vault.azure.net. .
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties	True	RoleDefinitionProperties	Rollendefinitionseigenschaften.

Antworten

Name	Typ	Beschreibung
201 Created	RoleDefinition	Erstellt: Gibt Informationen zur Rollendefinition zurück.
Other Status Codes	KeyVaultError	Key Vault Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

PutRoleDefinition

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
DataAction	Unterstützte Berechtigungen für Datenaktionen.
Error	Der Schlüsseltresorserverfehler.
KeyVaultError	Die Schlüsseltresorfehler-Ausnahme.
Permission	Rollendefinitionsberechtigungen.
RoleDefinition	Rollendefinition.
RoleDefinitionCreateParameters	Rollendefinition: Erstellen von Parametern.
RoleDefinitionProperties	Rollendefinitionseigenschaften.
RoleDefinitionType	Der Rollendefinitionstyp.
RoleScope	Der Rollenbereich.
RoleType	Der Rollentyp.

DataAction

Unterstützte Berechtigungen für Datenaktionen.

Name	Typ	Beschreibung
Microsoft.KeyVault/managedHsm/backup/start/action	string	Starten Sie eine HSM-Sicherung.
Microsoft.KeyVault/managedHsm/backup/status/action	string	Lesen Sie eine HSM-Sicherung status.
Microsoft.KeyVault/managedHsm/keys/backup/action	string	Sichern von HSM-Schlüsseln
Microsoft.KeyVault/managedHsm/keys/create	string	Erstellen Sie einen HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	string	Entschlüsseln sie mithilfe eines HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/keys/delete	string	Löschen Sie einen HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	string	Löschen Sie einen gelöschten HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	string	Lesen Sie den gelöschten HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	string	Stellen Sie den gelöschten HSM-Schlüssel wieder her.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	string	Verschlüsseln sie mithilfe eines HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/keys/export/action	string	Exportieren eines HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/keys/import/action	string	Importieren Sie einen HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/read/action	string	Lesen Sie HSM-Schlüsselmetadaten.
Microsoft.KeyVault/managedHsm/keys/release/action	string	Geben Sie einen HSM-Schlüssel mithilfe von Secure Key Release frei.
Microsoft.KeyVault/managedHsm/keys/restore/action	string	Wiederherstellen von HSM-Schlüsseln
Microsoft.KeyVault/managedHsm/keys/sign/action	string	Signieren Sie mit einem HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	string	Entpacken Sie mit einem HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/keys/verify/action	string	Überprüfen Sie mithilfe eines HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/keys/wrap/action	string	Umschließen mithilfe eines HSM-Schlüssels.
Microsoft.KeyVault/managedHsm/keys/write/action	string	Aktualisieren Sie einen HSM-Schlüssel.
Microsoft.KeyVault/managedHsm/restore/start/action	string	Starten Sie eine HSM-Wiederherstellung.
Microsoft.KeyVault/managedHsm/restore/status/action	string	Lesen Sie eine HSM-wiederherstellung status.
Microsoft.KeyVault/managedHsm/rng/action	string	Generieren von Zufallszahlen
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	string	Lösche die Rollenzuweisung.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	string	Abrufen der Rollenzuweisung.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	string	Erstellen oder Aktualisieren der Rollenzuweisung
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	string	Löschen Sie die Rollendefinition.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	string	Rufen Sie die Rollendefinition ab.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	string	Erstellen oder Aktualisieren der Rollendefinition.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	string	Laden Sie eine HSM-Sicherheitsdomäne herunter.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	string	Überprüfen Sie status des HSM-Sicherheitsdomänendownloads.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	string	Laden Sie einen HSM-Sicherheitsdomänenübertragungsschlüssel herunter.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	string	Laden Sie eine HSM-Sicherheitsdomäne hoch.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	string	Überprüfen Sie die status der HSM-Sicherheitsdomänenaustauschdatei.

Error

Der Schlüsseltresorserverfehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
innererror	Error	Der Schlüsseltresorserverfehler.
message	string	Die Fehlermeldung.

KeyVaultError

Die Schlüsseltresorfehler-Ausnahme.

Name	Typ	Beschreibung
error	Error	Der Schlüsseltresorserverfehler.

Permission

Rollendefinitionsberechtigungen.

Name	Typ	Beschreibung
actions	string[]	Aktionsberechtigungen, die gewährt werden.
dataActions	DataAction[]	Berechtigungen für Datenaktionen, die gewährt werden.
notActions	string[]	Aktionsberechtigungen, die ausgeschlossen, aber nicht verweigert werden. Sie können von anderen Rollendefinitionen gewährt werden, die einem Prinzipal zugewiesen sind.
notDataActions	DataAction[]	Datenaktionsberechtigungen, die ausgeschlossen, aber nicht verweigert werden. Sie können von anderen Rollendefinitionen gewährt werden, die einem Prinzipal zugewiesen sind.

RoleDefinition

Rollendefinition.

Name	Typ	Beschreibung
id	string	Hierbei handelt es sich um die Rollendefinitions-ID.
name	string	Der Rollendefinitionsname.
properties.assignableScopes	RoleScope[]	Zuweisbare Bereiche für Rollendefinitionen.
properties.description	string	Die Beschreibung der Rollendefinition.
properties.permissions	Permission[]	Rollendefinitionsberechtigungen.
properties.roleName	string	Der Name der Rolle.
properties.type	RoleType	Der Rollentyp.
type	RoleDefinitionType	Der Rollendefinitionstyp.

RoleDefinitionCreateParameters

Rollendefinition: Erstellen von Parametern.

Name	Typ	Beschreibung
properties	RoleDefinitionProperties	Rollendefinitionseigenschaften.

RoleDefinitionProperties

Rollendefinitionseigenschaften.

Name	Typ	Beschreibung
assignableScopes	RoleScope[]	Zuweisbare Bereiche für Rollendefinitionen.
description	string	Die Beschreibung der Rollendefinition.
permissions	Permission[]	Rollendefinitionsberechtigungen.
roleName	string	Der Name der Rolle.
type	RoleType	Der Rollentyp.

RoleDefinitionType

Der Rollendefinitionstyp.

Name	Typ	Beschreibung
Microsoft.Authorization/roleDefinitions	string

RoleScope

Der Rollenbereich.

Name	Typ	Beschreibung
/	string	Globaler Bereich
/keys	string	Schlüsselbereich

RoleType

Der Rollentyp.

Name	Typ	Beschreibung
AKVBuiltInRole	string	Integrierte Rolle.
CustomRole	string	Benutzerdefinierte Rolle.

Freigeben über