Role Assignments - Create

Service:

Key Vault

API Version:

7.4

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

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
roleAssignmentName	path	True	string	O nome da atribuição de função a criar. Pode ser qualquer GUID válido.
scope	path	True	string	O âmbito da atribuição de função a criar.
vaultBaseUrl	path	True	string	O nome do cofre, por exemplo https://myvault.vault.azure.net.
api-version	query	True	string	Versão da API de Cliente.

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	Criado – devolve informações sobre a atribuição de função.
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

PutRoleAssignments

Sample Request

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"
  }
}

Sample Response

Status code:

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	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	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 âmbito.
RoleScope	O âmbito da função.

Error

O erro do servidor do cofre de chaves.

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

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

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

RoleAssignment

Atribuições de Funções

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

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

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

RoleAssignmentProperties

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

Name	Tipo	Description
principalId	string	O ID principal atribuído à função. Esta ação mapeia para o ID no Active Directory. Pode apontar para um utilizador, principal de serviço ou grupo de segurança.
roleDefinitionId	string	O ID de definição de função utilizado na atribuição de função.

RoleAssignmentPropertiesWithScope

Propriedades de atribuição de função com âmbito.

Name	Tipo	Description
principalId	string	O ID principal.
roleDefinitionId	string	O ID da definição de função.
scope	RoleScope	O âmbito da função.

RoleScope

O âmbito da função.

Name	Tipo	Description
/	string	Âmbito global
/keys	string	Âmbito das chaves