Items - List Items

Usługa:: Admin

Wersja API:: v1

Zwraca listę elementów active Fabric i PowerBI.

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:

Elementy sieci szkieletowej
Datamarts
Reports
Dashboards
SemanticModels
Apps
Dataflows

Permissions

Obiekt wywołujący musi być administratorem sieci szkieletowej 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.

Tożsamości obsługiwane przez firmę Microsoft

To API obsługuje tożsamości Microsoft 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 opcjonalnymi parametrami:

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

Parametry URI

Nazwa	W	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.
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.

Nazwa

Typ

Opis

200 OK

Items

Operacja zakończyła się pomyślnie.

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ładowa prośba

HTTP

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

Przykładowa odpowiedź

Kod statusu:: 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ładowa prośba

HTTP

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

Przykładowa odpowiedź

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

Przykładowa prośba

HTTP

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

Przykładowa odpowiedź

Kod statusu:: 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
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`.
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.
Principal	Reprezentuje tożsamość lub grupę firmy Microsoft Entra.
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`.
ServicePrincipalProfileDetails	Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipalProfile`.
UserDetails	Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `User`.

ErrorRelatedResource

Sprzeciwiać się

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

Sprzeciwiać się

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.
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	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Sprzeciwiać się

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

Sprzeciwiać się

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.

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

Sprzeciwiać się

Szczegóły elementu.

Nazwa	Typ	Opis
capacityId	string (uuid)	Identyfikator pojemności obszaru roboczego.
creatorPrincipal	Principal	Właściciel 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

Sprzeciwiać się

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

Sprzeciwiać się

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.

Principal

Sprzeciwiać się

Reprezentuje tożsamość lub grupę firmy Microsoft Entra.

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ń.
servicePrincipalDetails	ServicePrincipalDetails	Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość `ServicePrincipalProfile`.
type	PrincipalType	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`.

PrincipalType

Wyliczenie

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

Wartość	Opis
User	Podmiot zabezpieczeń jest podmiotem zabezpieczeń użytkownika firmy Microsoft Entra.
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

Sprzeciwiać się

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

Nazwa	Typ	Opis
aadAppId	string (uuid)	Jednostka usługi Firmy Microsoft Entra AppId.

ServicePrincipalProfileDetails

Sprzeciwiać się

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.

UserDetails

Sprzeciwiać się

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.

Udostępnij przez

Items - List Items

Permissions

Wymagane zakresy delegowane

Limitations

Tożsamości obsługiwane przez firmę Microsoft

Interface

Parametry URI

Odpowiedzi

Przykłady

Get a list of items using type query parameter example

Przykładowa prośba

Przykładowa odpowiedź

Get all items in the tenant example

Przykładowa prośba

Przykładowa odpowiedź

Get list of datamarts using type query parameter example

Przykładowa prośba

Przykładowa odpowiedź

Definicje

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

Items

ItemState

ItemTag

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails