Items - List Items

Usługa:
Admin
Wersja interfejsu API:
v1

Zwraca listę aktywnych elementów Fabric i Power BI.

Note

Ten interfejs API jest częścią wersji zapoznawczej i jest dostarczany tylko do celów ewaluacyjnych i programistycznych. Może ona ulec zmianie na podstawie opinii i nie jest zalecana do użytku produkcyjnego.

Ten interfejs API obsługuje stronicowanie. Na żądanie można zwrócić maksymalnie 10 000 rekordów. Dzięki tokenowi ciągłego podanego w odpowiedzi możesz uzyskać kolejne 10 000 rekordów.

Kolejność stron:

  1. Fabric elementów
  2. Datamarts
  3. Reports
  4. Dashboards
  5. SemanticModels
  6. Apps
  7. Dataflows

Permissions

Obiekt wywołujący musi być administratorem Fabric lub uwierzytelniać się przy użyciu jednostki usługi.

Wymagane zakresy delegowane

Tenant.Read.All lub Tenant.ReadWrite.All

Limitations

Maksymalna liczba żądań na godzinę wynosi 200.

Microsoft Entra obsługiwane tożsamości

Ten interfejs API obsługuje Microsoft identities wymienione w tej sekcji.

Identity Support
User Yes
Główne usługi i Tożsamości zarządzane Yes

Interface

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
capacityId
 query

string (uuid)

Identyfikator pojemności obszaru roboczego.
continuationToken
 query

string

Token ciągły używany do pobierania kolejnych elementów strony.
state
 query

string

Stan elementu. Obsługiwane stany są aktywne.
type
 query

string

Typ elementu.
workspaceId
 query

string (uuid)

Identyfikator obszaru roboczego.

Odpowiedzi

Nazwa Typ Opis
200 OK

Items

Operacja zakończyła się pomyślnie.
429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • ItemNotFound — identyfikator elementu nie istnieje.

  • InvalidItemType — typ elementu jest nieprawidłowy.

  • InvalidItemState — stan elementu jest nieprawidłowy.

Przykłady

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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"
        }
      },
      "defaultIdentity": {
        "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"
        }
      },
      "defaultIdentity": {
        "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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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
}

Definicje

Nazwa Opis
EntireTenantPrincipal

Reprezentuje podmiot zabezpieczeń dzierżawy
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
GroupDetails

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość Group.
GroupPrincipal

Reprezentuje grupę zabezpieczeń.
GroupType

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.
Item

Szczegóły elementu.
Items

Lista elementów.
ItemState

Stan elementu. Dodatkowe stany elementów można dodawać w czasie.
ItemTag

Reprezentuje tag zastosowany w elemencie.
ItemType

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.
PrincipalType

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
ServicePrincipalDetails

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipal.
ServicePrincipalPrincipal

Reprezentuje Microsoft Entra jednostkę usługi.
ServicePrincipalProfileDetails

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Reprezentuje profil jednostki usługi.
UserDetails

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość User.
UserPrincipal

Reprezentuje Microsoft Entra podmiot zabezpieczeń użytkownika.

EntireTenantPrincipal

Objekt

Reprezentuje podmiot zabezpieczeń dzierżawy

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
type string:

EntireTenant

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable

boolean

Jeśli to prawda, żądanie można ponowić. Użyj nagłówka Retry-After odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string (uuid)

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

GroupDetails

Objekt

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość Group.

Nazwa Typ Opis
groupType

GroupType

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

GroupPrincipal

Objekt

Reprezentuje grupę zabezpieczeń.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
groupDetails

GroupDetails

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość Group.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
type string:

Group

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

GroupType

Wyliczenie

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

Wartość Opis
Unknown

Typ grupy podmiotu zabezpieczeń jest nieznany.
SecurityGroup

Podmiot zabezpieczeń jest grupą zabezpieczeń.
DistributionList

Podmiot zabezpieczeń jest listą dystrybucyjną.

Item

Objekt

Szczegóły elementu.

Nazwa Typ Opis
capacityId

string (uuid)

Identyfikator pojemności obszaru roboczego.
creatorPrincipal Principal:

Właściciel elementu.
defaultIdentity Principal:

Tożsamość domyślna elementu.
description

string

Szczegóły elementu, w tym typ elementu i użycie elementu.
folderId

string (uuid)

Identyfikator folderu elementu.
id

string (uuid)

Identyfikator elementu.
lastUpdatedDate

string (date-time)

Data i godzina ostatniej aktualizacji.
name

string

Nazwa elementu.
state

ItemState

Stan elementu.
tags

ItemTag[]

Lista zastosowanych tagów.
type

ItemType

Typ elementu. Zawiera wartości, takie jak Synapse, Notebook, Kqldatabase i SynapseWorkbook.
workspaceId

string (uuid)

Identyfikator obszaru roboczego elementu.

Items

Objekt

Lista elementów.

Nazwa Typ Opis
continuationToken

string

Token dla następnej partii zestawu wyników. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
continuationUri

string

Identyfikator URI następnego zestawu wyników wsadowy. Jeśli nie ma więcej rekordów, zostanie on usunięty z odpowiedzi.
itemEntities

Item[]

Lista elementów dla danej dzierżawy.

ItemState

Wyliczenie

Stan elementu. Dodatkowe stany elementów można dodawać w czasie.

Wartość Opis
Active

Aktywny element.

ItemTag

Objekt

Reprezentuje tag zastosowany w elemencie.

Nazwa Typ Opis
displayName

string

Nazwa znacznika.
id

string (uuid)

Identyfikator tagu.

ItemType

Wyliczenie

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

Wartość Opis
Dashboard

Pulpit nawigacyjny usługi Power BI.
Report

Raport usługi Power BI.
SemanticModel

Model semantyczny usługi PowerBI.
PaginatedReport

Raport podzielony na strony usługi PowerBI.
Datamart

Datamart usługi Power BI.
Lakehouse

Jezioro.
Eventhouse

Magazyn zdarzeń.
Environment

Środowisko.
KQLDatabase

Baza danych KQL.
KQLQueryset

Zestaw zapytań KQL.
KQLDashboard

Pulpit nawigacyjny KQL.
DataPipeline

Potok danych.
Notebook

Zeszyt.
SparkJobDefinition

Definicja zadania platformy Spark.
MLExperiment

Eksperyment uczenia maszynowego.
MLModel

Model uczenia maszynowego.
Warehouse

Magazyn.
Eventstream

Strumień zdarzeń.
SQLEndpoint

Punkt końcowy SQL.
MirroredWarehouse

Dublowany magazyn.
MirroredDatabase

Dublowana baza danych.
Reflex

Refleks.
GraphQLApi

Interfejs API dla elementu GraphQL.
MountedDataFactory

A MountedDataFactory.
SQLDatabase

Baza danych SQLDatabase.
CopyJob

Zadanie kopiowania.
VariableLibrary

ZmiennaLibrary.
Dataflow

Przepływ danych.
ApacheAirflowJob

Zadanie ApacheAirflowJob.
WarehouseSnapshot

Migawka magazynu.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Przepływ usługi Digital Twin Builder.
MirroredAzureDatabricksCatalog

Dublowany wykaz usługi Azure Databricks.
Map

Mapa.
AnomalyDetector

Wykrywacz anomalii.
UserDataFunction

Funkcja danych użytkownika.
GraphModel

Model programu Graph.
GraphQuerySet

Zestaw zapytań programu Graph.
SnowflakeDatabase

Baza danych Snowflake do przechowywania tabel góry lodowej utworzonych na podstawie konta Snowflake.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

Baza danych usługi Cosmos DB.
Ontology

Ontologia.
EventSchemaSet

An EventSchemaSet.
DataAgent

A DataAgent.
MirroredCatalog

A MirroredCatalog.
AppBackend

Element AppBackend.
OrgApp

Aplikacja organizacji.
OrgAppAudience

Odbiorcy aplikacji organizacji.
DataBuildToolJob

Obiekt DataBuildToolJob.
AzureDatabricksStorage

Element magazynu oparty na usłudze OneLake dla Azure Databricks.

PrincipalType

Wyliczenie

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

Wartość Opis
User

Podmiot zabezpieczeń jest podmiotem zabezpieczeń Microsoft Entra użytkownika.
ServicePrincipal

Jednostka jest jednostką usługi Microsoft Entra.
Group

Podmiot zabezpieczeń jest grupą zabezpieczeń.
ServicePrincipalProfile

Jednostka jest profilem jednostki usługi.
EntireTenant

Podmiot zabezpieczeń reprezentuje wszystkich użytkowników dzierżawy.

ServicePrincipalDetails

Objekt

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipal.

Nazwa Typ Opis
aadAppId

string (uuid)

Microsoft Entra AppId jednostki usługi.

ServicePrincipalPrincipal

Objekt

Reprezentuje Microsoft Entra jednostkę usługi.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
servicePrincipalDetails

ServicePrincipalDetails

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipal.
type string:

ServicePrincipal

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

ServicePrincipalProfileDetails

Objekt

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipalProfile.

Nazwa Typ Opis
parentPrincipal Principal:

Jednostka nadrzędna profilu jednostki usługi.

ServicePrincipalProfilePrincipal

Objekt

Reprezentuje profil jednostki usługi.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipalProfile.
type string:

ServicePrincipalProfile

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

UserDetails

Objekt

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość User.

Nazwa Typ Opis
userPrincipalName

string

Główna nazwa użytkownika.

UserPrincipal

Objekt

Reprezentuje Microsoft Entra podmiot zabezpieczeń użytkownika.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
type string:

User

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
userDetails

UserDetails

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość User.