Role Definitions - Create Or Update

Service:

Key Vault

API Version:

7.4

Vytvoří nebo aktualizuje definici vlastní role.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
roleDefinitionName	path	True	string	Název definice role, která se má vytvořit nebo aktualizovat. Může to být libovolný platný identifikátor GUID.
scope	path	True	string	Obor definice role, která se má vytvořit nebo aktualizovat. Spravovaný HSM podporuje pouze /.
vaultBaseUrl	path	True	string	Název trezoru, například https://myvault.vault.azure.net.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Vyžadováno	Typ	Description
properties	True	RoleDefinitionProperties	Vlastnosti definice role.

Odpovědi

Name	Typ	Description
201 Created	RoleDefinition	Vytvořeno – vrátí informace o definici role.
Other Status Codes	KeyVaultError	Key Vault chybovou odpověď popisující, proč operace selhala.

Příklady

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

Definice

Name	Description
DataAction	Podporovaná oprávnění pro akce dat
Error	Chyba serveru trezoru klíčů.
KeyVaultError	Výjimka chyby trezoru klíčů
Permission	Oprávnění k definici role.
RoleDefinition	Definice role.
RoleDefinitionCreateParameters	Definice role vytvoří parametry.
RoleDefinitionProperties	Vlastnosti definice role.
RoleDefinitionType	Typ definice role.
RoleScope	Obor role.
RoleType	Typ role.

DataAction

Podporovaná oprávnění pro akce dat

Name	Typ	Description
Microsoft.KeyVault/managedHsm/backup/start/action	string	Spusťte zálohování HSM.
Microsoft.KeyVault/managedHsm/backup/status/action	string	Přečtěte si stav zálohování HSM.
Microsoft.KeyVault/managedHsm/keys/backup/action	string	Zálohujte klíče HSM.
Microsoft.KeyVault/managedHsm/keys/create	string	Vytvořte klíč HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	string	Dešifrování pomocí klíče HSM.
Microsoft.KeyVault/managedHsm/keys/delete	string	Odstraňte klíč HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	string	Vymazání odstraněného klíče HSM
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	string	Čtení odstraněného klíče HSM
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	string	Obnovení odstraněného klíče HSM
Microsoft.KeyVault/managedHsm/keys/encrypt/action	string	Šifrování pomocí klíče HSM
Microsoft.KeyVault/managedHsm/keys/export/action	string	Export klíče HSM
Microsoft.KeyVault/managedHsm/keys/import/action	string	Importujte klíč HSM.
Microsoft.KeyVault/managedHsm/keys/read/action	string	Přečtěte si metadata klíče HSM.
Microsoft.KeyVault/managedHsm/keys/release/action	string	Uvolněte klíč HSM pomocí zabezpečeného klíče.
Microsoft.KeyVault/managedHsm/keys/restore/action	string	Obnovte klíče HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action	string	Podepište se pomocí klíče HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	string	Rozbalení pomocí klíče HSM
Microsoft.KeyVault/managedHsm/keys/verify/action	string	Ověřte použití klíče HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action	string	Zabalení pomocí klíče HSM
Microsoft.KeyVault/managedHsm/keys/write/action	string	Aktualizujte klíč HSM.
Microsoft.KeyVault/managedHsm/restore/start/action	string	Spusťte obnovení HSM.
Microsoft.KeyVault/managedHsm/restore/status/action	string	Přečtěte si stav obnovení HSM.
Microsoft.KeyVault/managedHsm/rng/action	string	Generování náhodných čísel
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	string	Odstraňte přiřazení role.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	string	Získejte přiřazení role.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	string	Vytvořte nebo aktualizujte přiřazení role.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	string	Odstraňte definici role.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	string	Získání definice role
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	string	Vytvoření nebo aktualizace definice role
Microsoft.KeyVault/managedHsm/securitydomain/download/action	string	Stáhněte doménu zabezpečení HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	string	Zkontrolujte stav stahování domény zabezpečení HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	string	Stáhněte si klíč pro přenos domény zabezpečení HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	string	Nahrajte doménu zabezpečení HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	string	Zkontrolujte stav souboru exchange domény zabezpečení HSM.

Error

Chyba serveru trezoru klíčů.

Name	Typ	Description
code	string	Kód chyby
innererror	Error	Chyba serveru trezoru klíčů.
message	string	Chybová zpráva

KeyVaultError

Výjimka chyby trezoru klíčů

Name	Typ	Description
error	Error	Chyba serveru trezoru klíčů.

Permission

Oprávnění k definici role.

Name	Typ	Description
actions	string[]	Oprávnění k akcím, která jsou udělena.
dataActions	DataAction[]	Udělená oprávnění k akcím dat.
notActions	string[]	Oprávnění k akcím, která jsou vyloučena, ale nejsou odepřena. Mohou být uděleny jinými definicemi rolí přiřazenými k objektu zabezpečení.
notDataActions	DataAction[]	Oprávnění k akcím dat, která jsou vyloučena, ale nejsou odepřena. Mohou být uděleny jinými definicemi rolí přiřazenými k objektu zabezpečení.

RoleDefinition

Definice role.

Name	Typ	Description
id	string	ID definice role.
name	string	Název definice role.
properties.assignableScopes	RoleScope[]	Přiřaditelné obory definice role
properties.description	string	Popis definice role
properties.permissions	Permission[]	Oprávnění k definici role.
properties.roleName	string	Název role.
properties.type	RoleType	Typ role.
type	RoleDefinitionType	Typ definice role.

RoleDefinitionCreateParameters

Definice role vytvoří parametry.

Name	Typ	Description
properties	RoleDefinitionProperties	Vlastnosti definice role.

RoleDefinitionProperties

Vlastnosti definice role.

Name	Typ	Description
assignableScopes	RoleScope[]	Přiřaditelné obory definice role
description	string	Popis definice role
permissions	Permission[]	Oprávnění k definici role.
roleName	string	Název role.
type	RoleType	Typ role.

RoleDefinitionType

Typ definice role.

Name	Typ	Description
Microsoft.Authorization/roleDefinitions	string

RoleScope

Obor role.

Name	Typ	Description
/	string	Globální rozsah
/keys	string	Rozsah klíčů

RoleType

Typ role.

Name	Typ	Description
AKVBuiltInRole	string	Předdefinované role.
CustomRole	string	Vlastní role.