Items - List Items

Serviço:: Admin

Versão da API:: v1

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

Nota

Essa API faz parte de uma versão prévia e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base nos comentários e não é recomendado para uso em produção.

Essa API dá suporte a de paginação. Um máximo de 10.000 registros pode ser retornado por solicitação. Com o token contínuo fornecido na resposta, você pode obter os próximos 10.000 registros.

Ordem da página:

Itens de malha
Datamarts
Relatórios
Painéis
SemanticModels
Aplicativos
Fluxos de dados

Permissões

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

Escopos delegados necessários

Tenant.Read.All ou Tenant.ReadWrite.All

Limitações

Máximo de 200 solicitações por hora.

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Apoio
Utilizador	Sim
entidade de serviço e identidades gerenciadas	Sim

Interfase

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 de URI

Nome	Em	Tipo	Description
capacityId	query	string (uuid)	A ID de capacidade do workspace.
continuationToken	query	string	Token contínuo usado para obter os itens da próxima página.
state	query	string	O estado do item. Os estados com suporte estão ativos.
type	query	string	O tipo de item.
workspaceId	query	string (uuid)	A ID do workspace.

Respostas

Nome	Tipo	Description
200 OK	Items	A operação foi bem-sucedida.
Other Status Codes	ErrorResponse	Códigos de erro comuns: ItemNotFound – A 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

Description

200 OK

Items

A operação foi bem-sucedida.

Other Status Codes

ErrorResponse

Códigos de erro comuns:

ItemNotFound – A 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

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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	Description
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 item adicionais podem ser adicionados ao longo do tempo.
ItemTag	Representa uma marca aplicada em um item.
ItemType	O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
Principal	Representa uma identidade ou um grupo do Microsoft Entra.
PrincipalType	O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.
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 da entidade de usuário. Aplicável quando o tipo principal é `User`.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

GroupDetails

Objeto

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

Nome	Tipo	Description
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	Description
Unknown	O tipo de grupo principal é desconhecido.
SecurityGroup	A entidade de segurança é um grupo de segurança.
DistributionList	Principal é uma lista de distribuição.

Item

Objeto

Detalhes do item.

Nome	Tipo	Description
capacityId	string (uuid)	A ID de capacidade do workspace.
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)	A ID do item.
lastUpdatedDate	string (date-time)	A última data e hora atualizadas.
name	string	O nome do item.
state	ItemState	O status do item.
tags	ItemTag[]	Lista de marcas aplicadas.
type	ItemType	O tipo de item. Inclui valores como Synapse, Notebook, Kqldatabase e SynapseWorkbook.
workspaceId	string (uuid)	A ID do workspace do item.

Items

Objeto

Uma lista de itens.

Nome	Tipo	Description
continuationToken	string	O token do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri	string	O URI do próximo lote do 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 item adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Active	Um item ativo.

ItemTag

Objeto

Representa uma marca aplicada em um item.

Nome	Tipo	Description
displayName	string	O nome da marca.
id	string (uuid)	A ID da marca.

ItemType

Enumeração

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

Valor	Description
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 bloco de anotações.
SparkJobDefinition	Uma definição de trabalho do Spark.
MLExperiment	Um experimento de aprendizado de máquina.
MLModel	Um modelo de machine learning.
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	Um item de API para GraphQL.
MountedDataFactory	Um MountedDataFactory.
SQLDatabase	Um SQLDatabase.
CopyJob	Um trabalho de cópia.
VariableLibrary	Um VariableLibrary.
Dataflow	Um fluxo de dados.
ApacheAirflowJob	Um ApacheAirflowJob.
WarehouseSnapshot	Um instantâneo do Warehouse.
DigitalTwinBuilder	Um DigitalTwinBuilder.
DigitalTwinBuilderFlow	Um fluxo do Construtor de Gêmeos Digitais.
MirroredAzureDatabricksCatalog	Um catálogo espelhado do Azure Databricks.
Map	Um mapa.
AnomalyDetector	Um Detector de Anomalias.
UserDataFunction	Uma função de dados do usuário.
GraphModel	Um GraphModel.
GraphQuerySet	Um Graph QuerySet.
SnowflakeDatabase	Um Banco de Dados Snowflake para armazenar tabelas iceberg criadas a partir da conta snowflake.
OperationsAgent	Um OperationsAgent.
CosmosDBDatabase	Um banco de dados do Cosmos DB.
Ontology	Uma ontologia.
EventSchemaSet	Um EventSchemaSet.

Principal

Objeto

Representa uma identidade ou um grupo do Microsoft Entra.

Nome	Tipo	Description
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)	A 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 da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.
userDetails	UserDetails	Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é `User`.

PrincipalType

Enumeração

O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.

Valor	Description
User	Principal é uma entidade de usuário do Microsoft Entra.
ServicePrincipal	A entidade de segurança é uma entidade de serviço do Microsoft Entra.
Group	A entidade de segurança é um grupo de segurança.
ServicePrincipalProfile	Principal é um perfil de entidade de serviço.
EntireTenant	A entidade de segurança representa todos os usuários do locatário.

ServicePrincipalDetails

Objeto

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

Nome	Tipo	Description
aadAppId	string (uuid)	O Microsoft Entra AppId da entidade de serviço.

ServicePrincipalProfileDetails

Objeto

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

Nome	Tipo	Description
parentPrincipal	Principal	A entidade pai do perfil da entidade de serviço.

UserDetails

Objeto

Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é User.

Nome	Tipo	Description
userPrincipalName	string	O nome da entidade de usuário.

Compartilhar via

Items - List Items

Permissões

Escopos delegados necessários

Limitações

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Respostas

Exemplos

Get a list of items using type query parameter example

Solicitação de exemplo

Resposta de exemplo

Get all items in the tenant example

Solicitação de exemplo

Resposta de exemplo

Get list of datamarts using type query parameter example

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

Items

ItemState

ItemTag

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails