Role Assignments - Create

Referência

Serviço:: Key Vault

Versão da API:: 7.4

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

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

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	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	RoleAssignmentProperties	Propriedades de atribuição de função.

Respostas

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

Exemplos

PutRoleAssignments

Solicitação de exemplo

HTTP

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

{
  "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	O erro do servidor do cofre de chaves.
KeyVaultError	A exceção de erro do cofre de chaves.
RoleAssignment	Atribuições de Funções
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

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.

RoleAssignment

Atribuições de Funções

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

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

Nome	Tipo	Description
properties	RoleAssignmentProperties	Propriedades de atribuição de função.

RoleAssignmentProperties

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

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 de definição de função.
scope	RoleScope	O escopo da função.

RoleScope

O escopo da função.

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

Compartilhar via