Partilhar via

Items - List Items

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

Observação

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

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

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:

  1. Artigos de tecido
  2. Datamarts
  3. Relatórios
  4. Painéis
  5. Modelos Semânticos
  6. Aplicativos
  7. Fluxos de dados

Permissões

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

Limitações

Máximo de 200 pedidos por hora.

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/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 do URI

Name Em Necessário Tipo Description
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

Name Tipo Description
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 amostra

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

Resposta da amostra

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"
        }
      }
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Get all items in the tenant example

Pedido de amostra

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

Resposta da amostra

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"
        }
      }
    },
    {
      "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 amostra

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

Resposta da amostra

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"
        }
      }
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Definições

Name 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 itens adicionais podem ser adicionados 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

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.

GroupDetails

Object

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

Name 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
DistributionList

Principal é uma lista de distribuição.
SecurityGroup

Principal é um grupo de segurança.
Unknown

O tipo de grupo principal é desconhecido.

Item

Object

Detalhes do item.

Name Tipo Description
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.
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.
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

Object

Uma lista de itens.

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.
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 Description
Active

Um item ativo.

ItemType

Enumeração

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

Valor Description
Dashboard

Painel do PowerBI.
DataPipeline

Um pipeline de dados.
Datamart

Datamart do PowerBI.
Environment

Um ambiente.
Eventhouse

Uma casa de eventos.
Eventstream

Um fluxo de eventos.
GraphQLApi

Uma API para o item GraphQL.
KQLDashboard

Um painel KQL.
KQLDatabase

Um banco de dados KQL.
KQLQueryset

Um conjunto de consultas KQL.
Lakehouse

Uma casa no lago.
MLExperiment

Uma experiência de aprendizagem automática.
MLModel

Um modelo de aprendizagem automática.
MirroredDatabase

Um banco de dados espelhado.
MirroredWarehouse

Um armazém espelhado.
MountedDataFactory

Um MountedDataFactory.
Notebook

Um caderno.
PaginatedReport

Relatório paginado do PowerBI.
Reflex

Um reflexo.
Report

Relatório do PowerBI.
SQLDatabase

Um SQLDatabase.
SQLEndpoint

Um ponto de extremidade SQL.
SemanticModel

Modelo semântico do PowerBI.
SparkJobDefinition

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

Um armazém.

Principal

Object

Representa uma identidade ou um grupo do Microsoft Entra.

Name 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

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 Description
Group

Principal é um grupo de segurança.
ServicePrincipal

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

Principal é um perfil de entidade de serviço.
User

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

ServicePrincipalDetails

Object

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

Name Tipo Description
aadAppId

string

uuid

O Microsoft Entra AppId da entidade de serviço.

ServicePrincipalProfileDetails

Object

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

Name Tipo Description
parentPrincipal

Principal

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

UserDetails

Object

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

Name Tipo Description
userPrincipalName

string

O nome principal do usuário.