Partilhar via


Items - List Item Access Details

Retorna uma lista de usuários (incluindo grupos e entidades de serviço) e lista suas funções de espaço de trabalho.

Note

Esta API faz parte de uma versão de pré-visualização e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base no feedback e não é recomendado para uso em produção.

Permissions

O chamador deve ser um administrador de malha ou autenticar usando uma entidade de serviço.

Escopos delegados necessários

Tenant.Read.All ou Tenant.ReadWrite.All

Limitations

Máximo de 200 pedidos por hora.

Identidades suportadas pelo Microsoft Entra

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

Identity Support
User Yes
Entidade de serviço e identidades geridas Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}/users
GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}/users?type={type}

Parâmetros URI

Nome Em Necessário Tipo Descrição
itemId
path True

string (uuid)

O ID do item.

workspaceId
path True

string (uuid)

O ID do espaço de trabalho.

type
query

string

O tipo do item. Ao consultar os seguintes tipos, esse parâmetro é necessário:

  • Relatório

  • Dashboard

  • SemanticModel

  • App

  • Dataflow

Respostas

Nome Tipo Descrição
200 OK

ItemAccessDetailsResponse

A operação foi bem sucedida.

Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • ItemNotFound - ID do item não existe.

  • InvalidItemType - O tipo de item não é válido.

Exemplos

List of users for given item ID and type example
List of users for given item ID example

List of users for given item ID and type example

Pedido de exemplo

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48/users?type=Report

Resposta de exemplo

{
  "accessDetails": [
    {
      "principal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      },
      "itemAccessDetails": {
        "type": "Report",
        "permissions": [
          "Read",
          "Reshare"
        ],
        "additionalPermissions": [
          "ReadAll"
        ]
      }
    }
  ]
}

List of users for given item ID example

Pedido de exemplo

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48/users

Resposta de exemplo

{
  "accessDetails": [
    {
      "principal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      },
      "itemAccessDetails": {
        "type": "Notebook",
        "permissions": [
          "Read",
          "Reshare"
        ],
        "additionalPermissions": [
          "ReadAll",
          "viewOutput"
        ]
      }
    },
    {
      "principal": {
        "id": "c7db8e03-c8cb-4d4c-9f64-1dcd327c9d3c",
        "displayName": "Eric Solomon",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "eric@example.com"
        }
      },
      "itemAccessDetails": {
        "type": "Notebook",
        "permissions": [
          "Read",
          "Reshare",
          "Explore"
        ],
        "additionalPermissions": [
          "ReadAll"
        ]
      }
    },
    {
      "principal": {
        "id": "f51b705f-a409-4d40-9197-c5d5f349e2f0",
        "displayName": "TestSecurityGroup",
        "type": "Group",
        "groupDetails": {
          "groupType": "SecurityGroup"
        }
      },
      "itemAccessDetails": {
        "type": "Notebook",
        "permissions": [
          "Read",
          "Reshare"
        ],
        "additionalPermissions": []
      }
    }
  ]
}

Definições

Nome Descrição
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.

ErrorResponse

A resposta de erro.

ErrorResponseDetails

Os detalhes da resposta de erro.

GroupDetails

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.

GroupType

O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

ItemAccessDetail

Detalhes da permissão do item, como ler e compartilhar novamente.

ItemAccessDetails

Detalhes de acesso do usuário para um item.

ItemAccessDetailsResponse

Uma lista de usuários com acesso a uma determinada entidade.

ItemPermissions

Permissões de item. Permissões de item adicionais podem ser adicionadas ao longo do tempo.

ItemType

O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.

Principal

Representa uma identidade ou um grupo do Microsoft Entra.

PrincipalType

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

ServicePrincipalDetails

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.

ServicePrincipalProfileDetails

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.

UserDetails

Detalhes específicos principais do usuário. Aplicável quando o tipo principal é User.

ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Descrição
resourceId

string

A ID do recurso envolvida no erro.

resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

A resposta de erro.

Nome Tipo Descrição
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

Os detalhes da resposta de erro.

Nome Tipo Descrição
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.

GroupDetails

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.

Nome Tipo Descrição
groupType

GroupType

O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

GroupType

O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

Valor Descrição
Unknown

O tipo de grupo principal é desconhecido.

SecurityGroup

Principal é um grupo de segurança.

DistributionList

Principal é uma lista de distribuição.

ItemAccessDetail

Detalhes da permissão do item, como ler e compartilhar novamente.

Nome Tipo Descrição
additionalPermissions

string[]

Permissões de carga de trabalho, como readAll e viewOutput.

permissions

ItemPermissions[]

Permissões de item, como ler e compartilhar novamente.

type

ItemType

Tipo de entidade.

ItemAccessDetails

Detalhes de acesso do usuário para um item.

Nome Tipo Descrição
itemAccessDetails

ItemAccessDetail

Permissões de item para o usuário.

principal

Principal

Informação relativa ao utilizador que tem acesso à entidade.

ItemAccessDetailsResponse

Uma lista de usuários com acesso a uma determinada entidade.

Nome Tipo Descrição
accessDetails

ItemAccessDetails[]

Uma lista de usuários com acesso a uma entidade.

ItemPermissions

Permissões de item. Permissões de item adicionais podem ser adicionadas ao longo do tempo.

Valor Descrição
Read

O usuário pode ler os metadados sobre um item.

Write

O usuário pode executar operações de gravação em um item.

Reshare

O usuário pode compartilhar um item com outros usuários.

Explore

O usuário pode criar itens em outros itens.

Execute

O usuário pode executar e cancelar trabalhos de item.

ItemType

O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.

Valor Descrição
Dashboard

Painel do PowerBI.

Report

Relatório do PowerBI.

SemanticModel

Modelo semântico do PowerBI.

PaginatedReport

Relatório paginado do PowerBI.

Datamart

Datamart do PowerBI.

Lakehouse

Uma casa no lago.

Eventhouse

Uma casa de eventos.

Environment

Um ambiente.

KQLDatabase

Um banco de dados KQL.

KQLQueryset

Um conjunto de consultas KQL.

KQLDashboard

Um painel KQL.

DataPipeline

Um pipeline de dados.

Notebook

Um caderno.

SparkJobDefinition

Uma definição de trabalho de faísca.

MLExperiment

Uma experiência de aprendizagem automática.

MLModel

Um modelo de aprendizagem automática.

Warehouse

Um armazém.

Eventstream

Um fluxo de eventos.

SQLEndpoint

Um ponto de extremidade SQL.

MirroredWarehouse

Um armazém espelhado.

MirroredDatabase

Um banco de dados espelhado.

Reflex

Um reflexo.

GraphQLApi

Uma API para o item GraphQL.

MountedDataFactory

Um MountedDataFactory.

SQLDatabase

Um SQLDatabase.

CopyJob

Um trabalho de cópia.

VariableLibrary

Uma VariableLibrary.

Dataflow

Um fluxo de dados.

ApacheAirflowJob

Um ApacheAirflowJob.

WarehouseSnapshot

Um instantâneo do Warehouse.

DigitalTwinBuilder

Um DigitalTwinBuilder.

DigitalTwinBuilderFlow

Um fluxo de construtor de gêmeos digitais.

MirroredAzureDatabricksCatalog

Um catálogo de databricks azure espelhado.

Map

Um mapa.

AnomalyDetector

Um detetor de anomalias.

UserDataFunction

Uma função de dados do usuário.

GraphModel

Um GraphModel.

GraphQuerySet

Um Graph QuerySet.

SnowflakeDatabase

Uma base de dados Snowflake para armazenar tabelas Iceberg criadas a partir da conta Snowflake.

OperationsAgent

Um Agente de Operações.

CosmosDBDatabase

Uma base de dados Cosmos DB.

Ontology

Uma ontologia.

EventSchemaSet

Um EventoSchemaSet.

Principal

Representa uma identidade ou um grupo do Microsoft Entra.

Nome Tipo Descrição
displayName

string

O nome de exibição da entidade de segurança.

groupDetails

GroupDetails

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.

id

string (uuid)

O ID da entidade de segurança.

servicePrincipalDetails

ServicePrincipalDetails

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.

servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.

type

PrincipalType

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

userDetails

UserDetails

Detalhes específicos principais do usuário. Aplicável quando o tipo principal é User.

PrincipalType

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

Valor Descrição
User

Principal é uma entidade de usuário do Microsoft Entra.

ServicePrincipal

Principal é uma entidade de serviço do Microsoft Entra.

Group

Principal é um grupo de segurança.

ServicePrincipalProfile

Principal é um perfil de entidade de serviço.

EntireTenant

Principal representa todos os usuários locatários.

ServicePrincipalDetails

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.

Nome Tipo Descrição
aadAppId

string (uuid)

O Microsoft Entra AppId da entidade de serviço.

ServicePrincipalProfileDetails

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.

Nome Tipo Descrição
parentPrincipal

Principal

A entidade principal do perfil da entidade de serviço.

UserDetails

Detalhes específicos principais do usuário. Aplicável quando o tipo principal é User.

Nome Tipo Descrição
userPrincipalName

string

O nome principal do usuário.