Compartilhar 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 de URI

Nome Em Obrigató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 ser usada para esta operação.

Corpo da solicitação

Nome Obrigatório Tipo Description
properties True

RoleAssignmentProperties

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

Respostas

Nome Tipo Description
201 Created

RoleAssignment

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

Solicitação de exemplo

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

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

Nome Description
Error
KeyVaultError

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

Atribuições de função
RoleAssignmentCreateParameters

Parâmetros de criação de atribuição de função.
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

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.

RoleAssignment

Objeto

Atribuições de função

Nome Tipo Description
id

string

A ID de 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

Objeto

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

Nome Tipo Description
properties

RoleAssignmentProperties

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

RoleAssignmentProperties

Objeto

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

Nome Tipo Description
principalId

string

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

string

A ID de definição de função usada na atribuição de função.

RoleAssignmentPropertiesWithScope

Objeto

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

Nome Tipo Description
principalId

string

A ID da entidade de segurança.
roleDefinitionId

string

A ID da definição de função.
scope

RoleScope

O escopo da função.

RoleScope

Enumeração

O escopo da função.

Valor Description
/

Abrangência global
/keys

Escopo das chaves