Role Assignments - List For Scope

Serviço:

Key Vault

Versão da API:

2025-07-01

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

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
scope	path	True	string	O escopo das atribuições de função.
vaultBaseUrl	path	True	string (uri)	A URL base da instância do Key Vault (por exemplo, https://myvault.vault.azure.net/)
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
$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 dele. 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

Name	Tipo	Description
200 OK	RoleAssignmentListResult	O pedido foi bem-sucedido.
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

Get role assignments for a scope

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

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

Name	Description
Error
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

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.

RoleAssignmentListResult

Object

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

Name	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ções.

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