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

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	A solicitação foi bem-sucedida e um novo recurso foi criado como resultado.
Other Status Codes	KeyVaultError	Uma resposta de erro inesperada.

Segurança

OAuth2Auth

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

Escopos

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

Exemplos

Create or update a custom role definition

Solicitação de exemplo

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 de exemplo

Código de status:: 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
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	Definição de função cria 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 com suporte para ações de dados.

Valor	Description
Microsoft.KeyVault/managedHsm/keys/read/action	Leia os metadados principais do 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	Faça backup das chaves HSM.
Microsoft.KeyVault/managedHsm/keys/restore/action	Restaure as 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	Criar ou atualizar 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	Exclua a definição de função.
Microsoft.KeyVault/managedHsm/keys/encrypt/action	Criptografe usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action	Descriptografar usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action	Encapsule usando uma chave HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action	Desencapsule 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 a Liberação de Chave Segura.
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	Baixe 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	Baixe uma chave de transferência de domínio de segurança do 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

Objeto

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

Objeto

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

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

Permission

Objeto

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 que sã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 que sã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.

RoleDefinition

Objeto

Definição de função.

Nome	Tipo	Description
id	string	A ID da 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

Objeto

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

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

RoleDefinitionProperties

Objeto

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

Nome	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
/	Abrangência global
/keys	Escopo das chaves

RoleType

Enumeração

O tipo de função.

Valor	Description
AKVBuiltInRole	Função integrada.
CustomRole	Função personalizada.

Compartilhar via

Role Definitions - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

OAuth2Auth

Escopos

Exemplos

Create or update a custom role definition

Solicitação de exemplo

Resposta de exemplo

Definições

DataAction

Error

KeyVaultError

Permission

RoleDefinition

RoleDefinitionCreateParameters

RoleDefinitionProperties

RoleDefinitionType

RoleScope

RoleType