Partilhar via

OneLake Data Access Security - List Data Access Roles

  • Referência
Serviço:
Core
Versão da API:
v1

Observação

Esta API está em pré-visualização.

Retorna uma lista de funções OneLake.

Escopos delegados necessários

OneLake.Read.All ou OneLake.ReadWrite.All

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Suporte
Utilizador Sim
da entidade de serviço e identidades gerenciadas Sim

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/dataAccessRoles
Com parâmetros opcionais: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/dataAccessRoles?continuationToken={continuationToken}

Parâmetros do URI

Name Em Necessário Tipo Description
itemId
 path True

string

uuid

A ID do item Malha para colocar as funções.
workspaceId
 path True

string

uuid

O ID do espaço de trabalho.
continuationToken
 query

string

Um token para recuperar a próxima página de resultados.

Respostas

Name Tipo Description
200 OK

DataAccessRoles

Pedido concluído com sucesso.

Cabeçalhos

Etag: string
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • ItemNotFound - Indica que o servidor não consegue localizar o item solicitado.

Exemplos

List data access roles multiple pages example
List data access roles single page example
List default data access roles example

List data access roles multiple pages example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/dataAccessRoles

Resposta da amostra

Código de estado:
200 
ETag: 33a64df551425fcc55e4d42a148795d9f25f89d4
{
  "value": [
    {
      "name": "default_role_1",
      "decisionRules": [
        {
          "effect": "Permit",
          "permission": [
            {
              "attributeName": "Path",
              "attributeValueIncludedIn": [
                "*"
              ]
            },
            {
              "attributeName": "Action",
              "attributeValueIncludedIn": [
                "Read"
              ]
            }
          ]
        }
      ],
      "members": {
        "fabricItemMembers": [
          {
            "itemAccess": [
              "ReadAll"
            ],
            "sourcePath": "cfafbeb1-8037-4d0c-896e-a46fb27ff222/25bac802-080d-4f73-8a42-1b406eb1fceb"
          }
        ]
      }
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/dataAccessRoles?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List data access roles single page example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/dataAccessRoles

Resposta da amostra

Código de estado:
200 
ETag: 33a64df551425fcc55e4d42a148795d9f25f89d4
{
  "value": [
    {
      "name": "default_role_1",
      "decisionRules": [
        {
          "effect": "Permit",
          "permission": [
            {
              "attributeName": "Path",
              "attributeValueIncludedIn": [
                "*"
              ]
            },
            {
              "attributeName": "Action",
              "attributeValueIncludedIn": [
                "Read"
              ]
            }
          ]
        }
      ],
      "members": {
        "fabricItemMembers": [
          {
            "itemAccess": [
              "ReadAll"
            ],
            "sourcePath": "cfafbeb1-8037-4d0c-896e-a46fb27ff222/25bac802-080d-4f73-8a42-1b406eb1fceb"
          }
        ]
      }
    }
  ]
}

List default data access roles example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff222/items/25bac802-080d-4f73-8a42-1b406eb1fceb/dataAccessRoles

Resposta da amostra

Código de estado:
200 
ETag: 33a64df551425fcc55e4d42a148795d9f25f89d4
{
  "value": [
    {
      "name": "DefaultReader",
      "decisionRules": [
        {
          "effect": "Permit",
          "permission": [
            {
              "attributeName": "Path",
              "attributeValueIncludedIn": [
                "*"
              ]
            },
            {
              "attributeName": "Action",
              "attributeValueIncludedIn": [
                "Read"
              ]
            }
          ]
        }
      ],
      "members": {
        "fabricItemMembers": [
          {
            "itemAccess": [
              "ReadAll"
            ],
            "sourcePath": "cfafbeb1-8037-4d0c-896e-a46fb27ff222/25bac802-080d-4f73-8a42-1b406eb1fceb"
          }
        ]
      }
    }
  ]
}

Definições

Name Description
AttributeName

Especifica o nome do atributo que está sendo avaliado para permissões de acesso. AttributeName pode ser Path ou Action. Tipos adicionais de attributeName podem ser adicionados ao longo do tempo.
DataAccessRole

Uma função de acesso a dados representa um conjunto de permissões e escopos de permissão que definem quais ações seus membros têm permissão para executar para os dados no escopo. As funções de acesso a dados são usadas para gerenciar a segurança de acesso a dados e garantir que apenas usuários autorizados possam visualizar, editar ou excluir determinados dados. Os membros são usuários ou grupos aos quais foi concedida a função e podem ler os dados com base nas permissões atribuídas à função. Por exemplo, um membro pode ser um grupo de ID do Microsoft Entra e o escopo de permissão pode ser uma Ação de Leitura aplicada no Caminho para Arquivo, Pasta(s) ou Tabela(s) no OneLake.
DataAccessRoles
DecisionRule

Especifica uma regra para corresponder à ação solicitada. Contém efeito (Permit) e Permission que determinam se um usuário ou entidade está autorizado a executar uma ação específica (por exemplo, ler) em um recurso. Permissão é um conjunto de escopos, definidos por atributos, que devem corresponder à ação solicitada para que a regra seja aplicada.
Effect

O efeito que uma função tem no acesso ao recurso de dados. Atualmente, o único tipo de efeito suportado é o Permit, que concede acesso ao recurso. Podem ser adicionados tipos de efeitos adicionais ao longo do tempo.
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
FabricItemMember

Membro do item de malha.
ItemAccess

Uma lista especificando as permissões de acesso para o usuário do Fabric que devem ser incluídas automaticamente nos membros da função. Tipos adicionais de itemAccess podem ser adicionados ao longo do tempo.
Members

O objeto members, que contém os membros da função como matrizes de diferentes tipos de membros.
MicrosoftEntraMember

Membro do ID do Microsoft Entra atribuído à função.
ObjectType

O tipo de objeto ID do Microsoft Entra. Tipos de objectType adicionais podem ser adicionados ao longo do tempo.
PermissionScope

Define um conjunto de atributos (propriedades) que determinam o escopo e o nível de acesso a um recurso. Quando attributeName propriedade é definida como Path, a propriedade attributeValueIncludedIn deve especificar o local do recurso que está sendo acessado, como "Tabelas/Tabela1". Quando a propriedade attributeName é definida como Action, a propriedade attributeValueIncludedIn deve especificar o tipo de acesso que está sendo concedido, como Read.

AttributeName

Enumeração

Especifica o nome do atributo que está sendo avaliado para permissões de acesso. AttributeName pode ser Path ou Action. Tipos adicionais de attributeName podem ser adicionados ao longo do tempo.

Valor Description
Action

Nome do atributo Ação
Path

Nome do atributo Caminho

DataAccessRole

Object

Uma função de acesso a dados representa um conjunto de permissões e escopos de permissão que definem quais ações seus membros têm permissão para executar para os dados no escopo. As funções de acesso a dados são usadas para gerenciar a segurança de acesso a dados e garantir que apenas usuários autorizados possam visualizar, editar ou excluir determinados dados. Os membros são usuários ou grupos aos quais foi concedida a função e podem ler os dados com base nas permissões atribuídas à função. Por exemplo, um membro pode ser um grupo de ID do Microsoft Entra e o escopo de permissão pode ser uma Ação de Leitura aplicada no Caminho para Arquivo, Pasta(s) ou Tabela(s) no OneLake.

Name Tipo Description
decisionRules

DecisionRule[]

A matriz de permissões que compõem a função de acesso a dados.
id

string

uuid

A ID exclusiva para a função de acesso a dados.
members

Members

O objeto members, que contém os membros da função como matrizes de diferentes tipos de membros.
name

string

O nome da função de acesso a dados.

DataAccessRoles

Object
Name Tipo Description
continuationToken

string

O token para o próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri

string

O URI do próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
value

DataAccessRole[]

Uma lista de funções que são usadas para gerenciar a segurança de acesso a dados e garantir que apenas usuários autorizados possam exibir determinados dados. Uma função representa um conjunto de permissões e escopos de permissão que definem quais ações seus membros têm permissão para executar para os dados no escopo. Os membros são usuários ou grupos aos quais foi concedida a função e podem ler os dados com base nas permissões atribuídas à função. Por exemplo, um membro pode ser um grupo de ID do Microsoft Entra e o escopo de permissão pode ser uma Ação de Leitura aplicada no Caminho para Arquivo, Pasta(s) ou Tabela(s) no OneLake.

DecisionRule

Object

Especifica uma regra para corresponder à ação solicitada. Contém efeito (Permit) e Permission que determinam se um usuário ou entidade está autorizado a executar uma ação específica (por exemplo, ler) em um recurso. Permissão é um conjunto de escopos, definidos por atributos, que devem corresponder à ação solicitada para que a regra seja aplicada.

Name Tipo Description
effect

Effect

O efeito que uma função tem no acesso ao recurso de dados. Atualmente, o único tipo de efeito suportado é o Permit, que concede acesso ao recurso. Podem ser adicionados tipos de efeitos adicionais ao longo do tempo.
permission

PermissionScope[]

A propriedade permission é uma matriz que especifica o escopo e o nível de acesso para uma ação solicitada. A matriz deve conter exatamente dois objetos PermissionScope: Path e Action. O scope é definido usando o objeto PermissionScope, com attributeValueIncludedIn especificando o local do recurso que está sendo acessado ou o tipo de ação que está sendo concedida. O access refere-se ao nível de acesso que está sendo concedido, como Read.

Effect

Enumeração

O efeito que uma função tem no acesso ao recurso de dados. Atualmente, o único tipo de efeito suportado é o Permit, que concede acesso ao recurso. Podem ser adicionados tipos de efeitos adicionais ao longo do tempo.

Valor Description
Permit

o tipo de efeito Licença

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

FabricItemMember

Object

Membro do item de malha.

Name Tipo Description
itemAccess

ItemAccess[]

Uma lista especificando as permissões de acesso para o usuário do Fabric que devem ser incluídas automaticamente nos membros da função. Tipos adicionais de itemAccess podem ser adicionados ao longo do tempo.
sourcePath

string

O caminho para o item de malha com acesso ao item especificado.

ItemAccess

Enumeração

Uma lista especificando as permissões de acesso para o usuário do Fabric que devem ser incluídas automaticamente nos membros da função. Tipos adicionais de itemAccess podem ser adicionados ao longo do tempo.

Valor Description
Execute

Acesso ao item Executar.
Explore

Acesso ao Item Explorar.
Read

Acesso ao item Leitura.
ReadAll

Acesso ao item ReadAll.
Reshare

Recompartilhamento de acesso ao item.
Write

Gravação de acesso ao item.

Members

Object

O objeto members, que contém os membros da função como matrizes de diferentes tipos de membros.

Name Tipo Description
fabricItemMembers

FabricItemMember[]

Uma lista de membros que têm um determinado conjunto de permissões no Microsoft Fabric. Todos os membros com esse conjunto de permissões são adicionados como membros desta Função de Acesso a Dados.
microsoftEntraMembers

MicrosoftEntraMember[]

A lista de membros do Microsoft Entra ID.

MicrosoftEntraMember

Object

Membro do ID do Microsoft Entra atribuído à função.

Name Tipo Description
objectId

string

uuid

A id do objeto.
objectType

ObjectType

O tipo de objeto ID do Microsoft Entra. Tipos de objectType adicionais podem ser adicionados ao longo do tempo.
tenantId

string

uuid

O ID do inquilino.

ObjectType

Enumeração

O tipo de objeto ID do Microsoft Entra. Tipos de objectType adicionais podem ser adicionados ao longo do tempo.

Valor Description
Group

Grupo de nomes de atributos
ManagedIdentity

Nome do atributo ManagedIdentity
ServicePrincipal

Nome do atributo ServicePrincipal
User

Nome do atributo Usuário

PermissionScope

Object

Define um conjunto de atributos (propriedades) que determinam o escopo e o nível de acesso a um recurso. Quando attributeName propriedade é definida como Path, a propriedade attributeValueIncludedIn deve especificar o local do recurso que está sendo acessado, como "Tabelas/Tabela1". Quando a propriedade attributeName é definida como Action, a propriedade attributeValueIncludedIn deve especificar o tipo de acesso que está sendo concedido, como Read.

Name Tipo Description
attributeName

AttributeName

Especifica o nome do atributo que está sendo avaliado para permissões de acesso. AttributeName pode ser Path ou Action. Tipos adicionais de attributeName podem ser adicionados ao longo do tempo.
attributeValueIncludedIn

string[]

Especifica uma lista de valores para o attributeName definir o escopo e o nível de acesso a um recurso. Quando attributeName é Path, attributeValueIncludedIn deve especificar o local do recurso que está sendo acessado, como "Tabelas/Tabela1". Quando attributeName é Action, o attributeValueIncludedIn deve especificar o tipo de acesso que está sendo concedido, como Read.