Partilhar via

Role Assignments - Create

Serviço:
Key Vault
Versão da API:
2025-07-01

Cria uma atribuição de função.

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

Parâmetros do URI

Name Em Necessário Tipo Description
roleAssignmentName
 path True

string

O nome da atribuição de função a ser criada. Pode ser qualquer GUID válido.
scope
 path True

string

O escopo da atribuição de função a ser criada.
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

RoleAssignmentProperties

Propriedades de atribuição de função.

Respostas

Name Tipo Description
201 Created

RoleAssignment

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 a role assignment

Pedido de amostra

PUT https://myvault.vault.azure.net//keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentName?api-version=2025-07-01

{
  "properties": {
    "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId",
    "principalId": "principalId"
  }
}

Resposta da amostra

Código de estado:
201 
{
  "properties": {
    "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId",
    "principalId": "principalId",
    "scope": "/keys"
  },
  "id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId",
  "type": "Microsoft.Authorization/roleAssignments",
  "name": "roleAssignmentId"
}

Definições

Name Description
Error
KeyVaultError

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

Atribuições de Funções
RoleAssignmentCreateParameters

A atribuição de função cria parâmetros.
RoleAssignmentProperties

Propriedades de atribuição de função.
RoleAssignmentPropertiesWithScope

Propriedades de atribuição de função com escopo.
RoleScope

O escopo da função.

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.

RoleAssignment

Object

Atribuições de Funções

Name Tipo Description
id

string

A ID da atribuição de função.
name

string

O nome da atribuição de função.
properties

RoleAssignmentPropertiesWithScope

Propriedades de atribuição de função.
type

string

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

RoleAssignmentCreateParameters

Object

A atribuição de função cria parâmetros.

Name Tipo Description
properties

RoleAssignmentProperties

Propriedades de atribuição de função.

RoleAssignmentProperties

Object

Propriedades de atribuição de função.

Name Tipo Description
principalId

string

O ID principal atribuído à função. Isso mapeia para a ID dentro do Ative Directory. Ele pode apontar para um usuário, entidade de serviço ou grupo de segurança.
roleDefinitionId

string

O ID de definição de função usado na atribuição de função.

RoleAssignmentPropertiesWithScope

Object

Propriedades de atribuição de função com escopo.

Name Tipo Description
principalId

string

O ID principal.
roleDefinitionId

string

O ID de definição de função.
scope

RoleScope

O escopo da função.

RoleScope

Enumeração

O escopo da função.

Valor Description
/

Âmbito global
/keys

Escopo das chaves