Role Definitions - Create Or Update

Serviço:: Key Vault

Versão da API:: 2025-07-01

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

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

Parâmetros do URI

Name	Em	Necessá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 suporta apenas '/'.
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties	True	RoleDefinitionProperties	Propriedades de definição de função.

Respostas

Name	Tipo	Description
201 Created	RoleDefinition	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.
Other Status Codes	KeyVaultError	Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
https://vault.azure.net/.default

Exemplos

Create or update a custom role definition

Pedido de amostra

HTTP

PUT https://myvault.vault.azure.net//keys/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000?api-version=2025-07-01

{
  "properties": {
    "roleName": "My custom role",
    "type": "CustomRole",
    "description": "Role description",
    "permissions": [
      {
        "dataActions": [
          "Microsoft.KeyVault/managedHsm/keys/sign/action"
        ]
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 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

Name	Description
DataAction	Permissões suportadas para ações de dados.
Error
KeyVaultError	A exceção de erro do cofre de chaves.
Permission	Permissões de definição de função.
RoleDefinition	Definição de funções.
RoleDefinitionCreateParameters	Definição de função criar parâmetros.
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

Enumeração

Permissões suportadas para ações de dados.

Valor	Description
Microsoft.KeyVault/managedHsm/keys/read/action	Leia os metadados da chave HSM.
Microsoft.KeyVault/managedHsm/keys/write/action	Atualize uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	Leia a chave HSM excluída.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	Recupere a chave HSM excluída.
Microsoft.KeyVault/managedHsm/keys/backup/action	Backup de chaves HSM.
Microsoft.KeyVault/managedHsm/keys/restore/action	Restaure chaves HSM.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	Excluir atribuição de função.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	Obter atribuição de função.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	Crie ou atualize a atribuição de função.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	Obter definição de função.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	Crie ou atualize a definição de função.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	Excluir definição de função.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	Criptografe usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	Desencriptar usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action	Envolva usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	Desembrulhe usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action	Assine usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action	Verifique usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/create	Crie uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/delete	Exclua uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/export/action	Exporte uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/release/action	Libere uma chave HSM usando o Secure Key Release.
Microsoft.KeyVault/managedHsm/keys/import/action	Importe uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	Limpe uma chave HSM excluída.
Microsoft.KeyVault/managedHsm/securitydomain/download/action	Faça o download de um domínio de segurança do HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read	Verifique o status do download do domínio de segurança do HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	Carregue um domínio de segurança HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	Verifique o status do arquivo de troca de domínio de segurança do HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	Faça o download de uma chave de transferência de domínio de segurança HSM.
Microsoft.KeyVault/managedHsm/backup/start/action	Inicie um backup do HSM.
Microsoft.KeyVault/managedHsm/restore/start/action	Inicie uma restauração do HSM.
Microsoft.KeyVault/managedHsm/backup/status/action	Leia um status de backup do HSM.
Microsoft.KeyVault/managedHsm/restore/status/action	Leia um status de restauração do HSM.
Microsoft.KeyVault/managedHsm/rng/action	Gere números aleatórios.

Error

Object

Name	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

Object

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

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

Permission

Object

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

Name	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. Podem ser concedidas por outras definições de função atribuídas a um comitente.
notDataActions	DataAction[]	Permissões de ação de dados excluídas, mas não negadas. Podem ser concedidas por outras definições de função atribuídas a um comitente.

RoleDefinition

Object

Definição de funções.

Name	Tipo	Description
id	string	O ID de definição de função.
name	string	O nome da definição de função.
properties.assignableScopes	RoleScope[]	Escopos atribuíveis de 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

Object

Definição de função criar parâmetros.

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

RoleDefinitionProperties

Object

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

Name	Tipo	Description
assignableScopes	RoleScope[]	Escopos atribuíveis de 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

Enumeração

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

Valor	Description
Microsoft.Authorization/roleDefinitions	Definições de função definidas pela Microsoft.

RoleScope

Enumeração

O escopo da função.

Valor	Description
/	Âmbito global
/keys	Escopo das chaves

RoleType

Enumeração

O tipo de função.

Valor	Description
AKVBuiltInRole	Construído na função.
CustomRole	Função personalizada.

Partilhar via

Role Definitions - Create Or Update

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

OAuth2Auth

Âmbitos

Exemplos

Create or update a custom role definition

Pedido de amostra

Resposta da amostra

Definições

DataAction

Error

KeyVaultError

Permission

RoleDefinition

RoleDefinitionCreateParameters

RoleDefinitionProperties

RoleDefinitionType

RoleScope

RoleType