Role Definitions - Create Or Update

Service:

Key Vault

API Version:

7.4

Cria ou atualiza uma definição de função personalizada.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
roleDefinitionName	path	True	string	O nome da definição de função a ser criada ou atualizada. Pode ser qualquer GUID válido.
scope	path	True	string	O escopo da definição de função a ser criada ou atualizada. O HSM gerenciado só dá suporte a '/'.
vaultBaseUrl	path	True	string	O nome do cofre, por exemplo https://myvault.vault.azure.net, .
api-version	query	True	string	Versão de API do cliente.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties	True	RoleDefinitionProperties	Propriedades de definição de função.

Respostas

Nome	Tipo	Description
201 Created	RoleDefinition	Criado – retorna informações sobre a definição de função.
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve por que a operação falhou.

Exemplos

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

Definições

Nome	Description
DataAction	Permissões com suporte para ações de dados.
Error	O erro do servidor do cofre de chaves.
KeyVaultError	A exceção de erro do cofre de chaves.
Permission	Permissões de definição de função.
RoleDefinition	Definição de função.
RoleDefinitionCreateParameters	Parâmetros de criação de definição de função.
RoleDefinitionProperties	Propriedades de definição de função.
RoleDefinitionType	O tipo de definição de função.
RoleScope	O escopo da função.
RoleType	O tipo de função.

DataAction

Permissões com suporte para ações de dados.

Nome	Tipo	Description
Microsoft.KeyVault/managedHsm/backup/start/action	string	Inicie um backup do HSM.
Microsoft.KeyVault/managedHsm/backup/status/action	string	Leia um status de backup do HSM.
Microsoft.KeyVault/managedHsm/keys/backup/action	string	Backup de chaves HSM.
Microsoft.KeyVault/managedHsm/keys/create	string	Crie uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	string	Descriptografe usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/delete	string	Exclua uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	string	Limpe uma chave HSM excluída.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	string	Ler a chave HSM excluída.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	string	Recuperar a chave HSM excluída.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	string	Criptografar usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/export/action	string	Exportar uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/import/action	string	Importar uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/read/action	string	Leia metadados de chave HSM.
Microsoft.KeyVault/managedHsm/keys/release/action	string	Libere uma chave HSM usando a Versão de Chave Segura.
Microsoft.KeyVault/managedHsm/keys/restore/action	string	Restaurar chaves HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action	string	Assine usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	string	Desembrulhar usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action	string	Verifique o uso de uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action	string	Encapsular usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/write/action	string	Atualizar uma chave HSM.
Microsoft.KeyVault/managedHsm/restore/start/action	string	Inicie uma restauração de HSM.
Microsoft.KeyVault/managedHsm/restore/status/action	string	Leia uma status de restauração do HSM.
Microsoft.KeyVault/managedHsm/rng/action	string	Gerar números aleatórios.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	string	Excluir atribuição de função.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	string	Obter atribuição de função.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	string	Criar ou atualizar a atribuição de função.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	string	Excluir definição de função.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	string	Obter definição de função.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	string	Criar ou atualizar a definição de função.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	string	Baixe um domínio de segurança do HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	string	Verifique status de download de domínio de segurança do HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	string	Baixe uma chave de transferência de domínio de segurança do HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	string	Carregue um domínio de segurança do HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	string	Verifique o status do arquivo de troca de domínio de segurança do HSM.

Error

O erro do servidor do cofre de chaves.

Nome	Tipo	Description
code	string	O código de erro.
innererror	Error	O erro do servidor do cofre de chaves.
message	string	A mensagem de erro.

KeyVaultError

A exceção de erro do cofre de chaves.

Nome	Tipo	Description
error	Error	O erro do servidor do cofre de chaves.

Permission

Permissões de definição de função.

Nome	Tipo	Description
actions	string[]	Permissões de ação concedidas.
dataActions	DataAction[]	Permissões de ação de dados concedidas.
notActions	string[]	Permissões de ação excluídas, mas não negadas. Eles podem ser concedidos por outras definições de função atribuídas a uma entidade de segurança.
notDataActions	DataAction[]	Permissões de ação de dados excluídas, mas não negadas. Eles podem ser concedidos por outras definições de função atribuídas a uma entidade de segurança.

RoleDefinition

Definição de função.

Nome	Tipo	Description
id	string	A ID de definição de função.
name	string	O nome da definição da função.
properties.assignableScopes	RoleScope[]	Escopos atribuíveis à definição de função.
properties.description	string	A descrição da definição de função.
properties.permissions	Permission[]	Permissões de definição de função.
properties.roleName	string	O nome da função.
properties.type	RoleType	O tipo de função.
type	RoleDefinitionType	O tipo de definição de função.

RoleDefinitionCreateParameters

Parâmetros de criação de definição de função.

Nome	Tipo	Description
properties	RoleDefinitionProperties	Propriedades de definição de função.

RoleDefinitionProperties

Propriedades de definição de função.

Nome	Tipo	Description
assignableScopes	RoleScope[]	Escopos atribuíveis à definição de função.
description	string	A descrição da definição de função.
permissions	Permission[]	Permissões de definição de função.
roleName	string	O nome da função.
type	RoleType	O tipo de função.

RoleDefinitionType

O tipo de definição de função.

Nome	Tipo	Description
Microsoft.Authorization/roleDefinitions	string

RoleScope

O escopo da função.

Nome	Tipo	Description
/	string	Escopo global
/keys	string	Escopo das chaves

RoleType

O tipo de função.

Nome	Tipo	Description
AKVBuiltInRole	string	Função interna.
CustomRole	string	Função personalizada.