Role Definitions - Create Or Update

Riferimento

Servizio:: Key Vault

Versione API:: 7.4

Crea o aggiorna una definizione di ruolo personalizzata.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
roleDefinitionName	path	True	string	Nome della definizione del ruolo da creare o aggiornare. Può essere qualsiasi GUID valido.
scope	path	True	string	Ambito della definizione del ruolo da creare o aggiornare. Il modulo di protezione hardware gestito supporta solo '/'.
vaultBaseUrl	path	True	string	Nome dell'insieme di credenziali, ad esempio https://myvault.vault.azure.net.
api-version	query	True	string	Versione API client.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties	True	RoleDefinitionProperties	Proprietà di definizione del ruolo.

Risposte

Nome	Tipo	Descrizione
201 Created	RoleDefinition	Created : restituisce informazioni sulla definizione del ruolo.
Other Status Codes	KeyVaultError	Key Vault risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

PutRoleDefinition

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
}

Definizioni

Nome	Descrizione
DataAction	Autorizzazioni supportate per le azioni dei dati.
Error	Errore del server dell'insieme di credenziali delle chiavi.
KeyVaultError	Eccezione di errore dell'insieme di credenziali delle chiavi.
Permission	Autorizzazioni di definizione del ruolo.
RoleDefinition	Definizione del ruolo.
RoleDefinitionCreateParameters	La definizione del ruolo crea parametri.
RoleDefinitionProperties	Proprietà di definizione del ruolo.
RoleDefinitionType	Tipo di definizione del ruolo.
RoleScope	Ambito del ruolo.
RoleType	Tipo di ruolo.

DataAction

Autorizzazioni supportate per le azioni dei dati.

Nome	Tipo	Descrizione
Microsoft.KeyVault/managedHsm/backup/start/action	string	Avviare un backup del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/backup/status/action	string	Leggere lo stato di un backup del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/keys/backup/action	string	Eseguire il backup delle chiavi HSM.
Microsoft.KeyVault/managedHsm/keys/create	string	Creare una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	string	Decrittografare usando una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/delete	string	Eliminare una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	string	Ripulire una chiave HSM eliminata.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	string	Leggere la chiave HSM eliminata.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	string	Ripristinare la chiave HSM eliminata.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	string	Crittografare usando una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/export/action	string	Esportare una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/import/action	string	Importare una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/read/action	string	Leggere i metadati della chiave HSM.
Microsoft.KeyVault/managedHsm/keys/release/action	string	Rilasciare una chiave HSM usando secure key release.
Microsoft.KeyVault/managedHsm/keys/restore/action	string	Ripristinare le chiavi HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action	string	Firmare usando una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	string	Annullare il wrapping usando una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action	string	Verificare l'uso di una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action	string	Eseguire il wrapping usando una chiave HSM.
Microsoft.KeyVault/managedHsm/keys/write/action	string	Aggiornare una chiave HSM.
Microsoft.KeyVault/managedHsm/restore/start/action	string	Avviare un ripristino del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/restore/status/action	string	Leggere lo stato di ripristino del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/rng/action	string	Generare numeri casuali.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	string	Eliminare l'assegnazione di ruolo.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	string	Ottiene l'assegnazione di ruolo.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	string	Creare o aggiornare l'assegnazione di ruolo.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	string	Eliminare la definizione del ruolo.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	string	Ottenere la definizione del ruolo.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	string	Creare o aggiornare la definizione del ruolo.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	string	Scaricare un dominio di sicurezza del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	string	Controllare lo stato del download del dominio di sicurezza del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	string	Scaricare una chiave di trasferimento del dominio di sicurezza del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	string	Caricare un dominio di sicurezza del modulo di protezione hardware.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	string	Controllare lo stato del file di scambio del dominio di sicurezza del modulo di protezione hardware.

Error

Errore del server dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
code	string	Codice di errore.
innererror	Error	Errore del server dell'insieme di credenziali delle chiavi.
message	string	Messaggio di errore.

KeyVaultError

Eccezione di errore dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
error	Error	Errore del server dell'insieme di credenziali delle chiavi.

Permission

Autorizzazioni di definizione del ruolo.

Nome	Tipo	Descrizione
actions	string[]	Autorizzazioni di azione concesse.
dataActions	DataAction[]	Autorizzazioni per l'azione dati concesse.
notActions	string[]	Autorizzazioni di azione escluse ma non negate. Possono essere concesse da altre definizioni di ruolo assegnate a un'entità.
notDataActions	DataAction[]	Autorizzazioni per l'azione dati escluse ma non negate. Possono essere concesse da altre definizioni di ruolo assegnate a un'entità.

RoleDefinition

Definizione del ruolo.

Nome	Tipo	Descrizione
id	string	ID definizione del ruolo.
name	string	Nome della definizione del ruolo.
properties.assignableScopes	RoleScope[]	Ambiti assegnabili per la definizione del ruolo.
properties.description	string	Descrizione della definizione del ruolo.
properties.permissions	Permission[]	Autorizzazioni di definizione del ruolo.
properties.roleName	string	Nome del ruolo.
properties.type	RoleType	Tipo di ruolo.
type	RoleDefinitionType	Tipo di definizione del ruolo.

RoleDefinitionCreateParameters

La definizione del ruolo crea parametri.

Nome	Tipo	Descrizione
properties	RoleDefinitionProperties	Proprietà di definizione del ruolo.

RoleDefinitionProperties

Proprietà di definizione del ruolo.

Nome	Tipo	Descrizione
assignableScopes	RoleScope[]	Ambiti assegnabili per la definizione del ruolo.
description	string	Descrizione della definizione del ruolo.
permissions	Permission[]	Autorizzazioni di definizione del ruolo.
roleName	string	Nome del ruolo.
type	RoleType	Tipo di ruolo.

RoleDefinitionType

Tipo di definizione del ruolo.

Nome	Tipo	Descrizione
Microsoft.Authorization/roleDefinitions	string

RoleScope

Ambito del ruolo.

Nome	Tipo	Descrizione
/	string	Ambito globale
/keys	string	Ambito chiavi

RoleType

Tipo di ruolo.

Nome	Tipo	Descrizione
AKVBuiltInRole	string	Ruolo predefinito.
CustomRole	string	Ruolo personalizzato.

Condividi tramite