Items - List Items

Serviço:: Admin

Versão API:: v1

Retorna uma lista de itens ativos do Fabric e do PowerBI.

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.

Esta API suporta paginação. Um máximo de 10.000 registros podem ser devolvidos por solicitação. Com o token contínuo fornecido na resposta, você pode obter os próximos 10.000 registros.

Ordem das páginas:

Artigos de tecido
Datamarts
Reports
Dashboards
SemanticModels
Apps
Dataflows

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/items

Com parâmetros opcionais:

GET https://api.fabric.microsoft.com/v1/admin/items?workspaceId={workspaceId}&capacityId={capacityId}&state={state}&type={type}&continuationToken={continuationToken}

Parâmetros URI

Nome	Em	Tipo	Descrição
capacityId	query	string (uuid)	O ID de capacidade do espaço de trabalho.
continuationToken	query	string	Token contínuo usado para obter os próximos itens da página.
state	query	string	O estado do item. Os estados suportados estão ativos.
type	query	string	O tipo de item.
workspaceId	query	string (uuid)	O ID do espaço de trabalho.

Respostas

Nome	Tipo	Descrição
200 OK	Items	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. InvalidItemState - O estado do item não é válido.

Nome

Tipo

Descrição

200 OK

Items

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.
InvalidItemState - O estado do item não é válido.

Exemplos

Get a list of items using type query parameter example

Get all items in the tenant example

Get list of datamarts using type query parameter example

Get a list of items using type query parameter example

Pedido de exemplo

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items?type=Report

Resposta de exemplo

Código de estado:: 200

{
  "itemEntities": [
    {
      "id": "b1a7e572-2585-4650-98ae-b92356f4460b",
      "type": "Report",
      "name": "Test Report",
      "state": "Active",
      "lastUpdatedDate": "2022-06-27T16:55:04.893",
      "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "Jacob@example.com"
        }
      },
      "tags": [
        {
          "displayName": "Tag 1",
          "id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
        },
        {
          "displayName": "Tag 2",
          "id": "62d18d7e-3878-478a-b89b-2f38b73c18a4"
        }
      ]
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Get all items in the tenant example

Pedido de exemplo

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items

Resposta de exemplo

Código de estado:: 200

{
  "itemEntities": [
    {
      "id": "17d8929d-ab32-46d1-858b-fdea74e93bff",
      "type": "Notebook",
      "name": "Test",
      "description": "Test notebook.",
      "state": "Active",
      "lastUpdatedDate": "2022-04-29T17:47:29.98673",
      "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a95",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Caleb Foster",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "caleb@example.com"
        }
      },
      "tags": [
        {
          "displayName": "Tag 1",
          "id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
        },
        {
          "displayName": "Tag 2",
          "id": "62d18d7e-3878-478a-b89b-2f38b73c18a4"
        }
      ]
    },
    {
      "id": "37d8929d-ab32-46d1-858b-fdea74e93bff",
      "type": "KQLDatabase",
      "name": "TestKusto",
      "description": "Test KQL database.",
      "state": "Active",
      "lastUpdatedDate": "2022-06-30T17:47:29.98673",
      "workspaceId": "8f4496db-9929-47bd-89c0-d7eb2f517a95",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F881A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/items?continuationToken=MSwxMDAwMCww",
  "continuationToken": "MSwxMDAwMCww"
}

Get list of datamarts using type query parameter example

Pedido de exemplo

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items?type=Lakehouse

Resposta de exemplo

Código de estado:: 200

{
  "itemEntities": [
    {
      "id": "b1a7e572-2585-4650-98ae-b92356f4460b",
      "type": "Lakehouse",
      "name": "Lakehouse 2022-03-16T21:42:38.442Z",
      "state": "Active",
      "lastUpdatedDate": "2022-06-27T16:55:04.893",
      "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      },
      "tags": [
        {
          "displayName": "Tag 1",
          "id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
        }
      ]
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

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.
Item	Detalhes do item.
Items	Uma lista de itens.
ItemState	O estado do item. Estados de itens adicionais podem ser adicionados ao longo do tempo.
ItemTag	Representa uma tag aplicada em um item.
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

Objetivo

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

Objetivo

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

Objetivo

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

Objetivo

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

Enumeração

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.

Item

Objetivo

Detalhes do item.

Nome	Tipo	Descrição
capacityId	string (uuid)	O ID de capacidade do espaço de trabalho.
creatorPrincipal	Principal	O proprietário do item.
description	string	Detalhes do item, incluindo o tipo de item e o uso do item.
folderId	string (uuid)	A ID da pasta do item.
id	string (uuid)	O ID do item.
lastUpdatedDate	string (date-time)	A data e hora da última atualização.
name	string	O nome do item.
state	ItemState	O status do item.
tags	ItemTag[]	Lista de tags aplicadas.
type	ItemType	O tipo de item. Inclui valores como Synapse, Notebook, Kqldatabase e SynapseWorkbook.
workspaceId	string (uuid)	A ID do espaço de trabalho do item.

Items

Objetivo

Uma lista de itens.

Nome	Tipo	Descrição
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.
itemEntities	Item[]	A lista de itens para um determinado locatário.

ItemState

Enumeração

O estado do item. Estados de itens adicionais podem ser adicionados ao longo do tempo.

Valor	Descrição
Active	Um item ativo.

ItemTag

Objetivo

Representa uma tag aplicada em um item.

Nome	Tipo	Descrição
displayName	string	O nome da tag.
id	string (uuid)	O ID da tag.

ItemType

Enumeração

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

Objetivo

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

Enumeração

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

Objetivo

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

Objetivo

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

Objetivo

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.

Partilhar via

Items - List Items

Permissions

Escopos delegados necessários

Limitations

Identidades suportadas pelo Microsoft Entra

Interface

Parâmetros URI

Respostas

Exemplos

Get a list of items using type query parameter example

Pedido de exemplo

Resposta de exemplo

Get all items in the tenant example

Pedido de exemplo

Resposta de exemplo

Get list of datamarts using type query parameter example

Pedido de exemplo

Resposta de exemplo

Definições

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

Items

ItemState

ItemTag

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails