Compartilhar via


Role Assignments - List For Scope

Obtém atribuições de função para um escopo.

GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleAssignments?api-version=7.4
GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleAssignments?$filter={$filter}&api-version=7.4

Parâmetros de URI

Nome Em Obrigatório Tipo Description
scope
path True

string

O escopo das atribuições de função.

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.

$filter
query

string

O filtro a ser aplicado na operação. Use $filter=atScope() para retornar todas as atribuições de função no escopo ou acima dela. Use $filter=principalId eq {id} para retornar todas as atribuições de função em, acima ou abaixo do escopo da entidade de segurança especificada.

Respostas

Nome Tipo Description
200 OK

RoleAssignmentListResult

OK – retorna uma matriz de atribuições de função.

Other Status Codes

KeyVaultError

Key Vault resposta de erro que descreve por que a operação falhou.

Exemplos

ListRoleAssignments

Solicitação de exemplo

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

Resposta de exemplo

{
  "value": [
    {
      "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

RoleAssignmentListResult

Resultado da operação da lista 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.

RoleAssignmentListResult

Resultado da operação da lista de atribuição de função.

Nome Tipo Description
nextLink

string

A URL a ser usada para obter o próximo conjunto de resultados.

value

RoleAssignment[]

Lista de 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 de chaves