Published - List Datasource Elements

Usługa:: DataAgent

Wersja interfejsu API:: v1

Zwraca elementy schematu na poziomie drzewa schematu dla opublikowanego źródła danych.

Note

Zarządzanie konfiguracją agenta danych jest obecnie dostępne w wersji zapoznawczej (dowiedz się więcej).

Elementy reprezentują drzewo schematu źródła danych (schematy, tabele, kolumny). Nawiguj po poziomie przy użyciu parametru rootId .

Ten interfejs API obsługuje stronicowanie.

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu dla agenta DataAgent.

Wymagane zakresy delegowane

Item.Read.All lub Item.ReadWrite.All lub DataAgent.Read.All lub DataAgent.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

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

Interfejs

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataAgents/{dataAgentId}/datasources/{datasourceId}/elements

Z parametrami opcjonalnymi:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataAgents/{dataAgentId}/datasources/{datasourceId}/elements?rootId={rootId}&continuationToken={continuationToken}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
dataAgentId	path	True	string (uuid)	Identyfikator agenta danych.
datasourceId	path	True	string (uuid)	Identyfikator źródła danych.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.
continuationToken	query		string	Token do pobierania następnej strony wyników.
rootId	query		string	Identyfikator elementu nadrzędnego. Pomiń, aby uzyskać poziom główny.

Odpowiedzi

Nazwa Typ Opis

200 OK

Nazwa	Typ	Opis
200 OK	DataSourceElements	Żądanie zostało ukończone 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 — żądany element nie został znaleziony.

DataSourceElements

Żądanie zostało ukończone 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 — żądany element nie został znaleziony.

Przykłady

List published DataAgent datasource elements example

Przykładowe żądanie

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataAgents/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/datasources/c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30/elements

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "id": "U2NoZW1hcw==",
      "isSelected": false,
      "displayName": "Schemas",
      "type": "Schemas",
      "hasSubElements": true,
      "state": "Available",
      "lastSyncDateTime": "2025-06-15T10:30:00Z"
    },
    {
      "id": "VGFibGVz",
      "isSelected": false,
      "displayName": "Tables",
      "type": "Tables",
      "hasSubElements": true,
      "state": "Available",
      "lastSyncDateTime": "2025-06-15T10:30:00Z"
    }
  ],
  "continuationToken": null,
  "continuationUri": null
}

Definicje

Nazwa	Opis
DataSourceElement	Element schematu źródła danych.
DataSourceElements	Lista elementów schematu źródła danych z podziałem na strony.
ElementState	Wskazuje bieżącą dostępność elementu w schemacie źródła danych. Dodatkowe typy ElementuState można dodawać w czasie.
ElementType	Publiczny typ elementu schematu źródła danych. Dodatkowe typy ElementType można dodawać z upływem czasu.
ErrorRelatedResource	Obiekt szczegółowych informacji o zasobie związanym z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
IndexState	Stan indeksu dla katalogów plików lakehouse. Dodatkowe typy IndexState można dodawać w czasie.

DataSourceElement

Objekt

Element schematu źródła danych.

Nazwa	Typ	Opis
dataType	string	Typ danych dla kolumn (np. int, string). Prezentuj tylko dla elementów kolumny.
description	string	Opis zestawu użytkowników elementu.
displayName	string	Czytelna dla człowieka nazwa elementu.
hasSubElements	boolean	Czy ten element ma elementy podrzędne do przechodzenia do szczegółów.
id	string	Identyfikator elementu. Użyj parametru rootId, aby przejść do szczegółów drzewa schematu.
indexState	IndexState	Stan indeksu dla katalogów plików lakehouse.
isSelected	boolean	Czy ten element jest wybrany do użycia przez element DataAgent.
lastSyncDateTime	string	Ostatni raz ten element został zsynchronizowany ze schematu źródła danych jako sygnatura czasowa ISO 8601 (np. 2025-06-15T10:30:00Z).
state	ElementState	Wskazuje, czy element istnieje w schemacie na żywo.
type	ElementType	Typ elementu schematu.

DataSourceElements

Objekt

Lista elementów schematu źródła danych z podziałem na strony.

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.
value	DataSourceElement[]	Lista elementów schematu.

ElementState

Wyliczenie

Wskazuje bieżącą dostępność elementu w schemacie źródła danych. Dodatkowe typy ElementuState można dodawać w czasie.

Wartość	Opis
Available	Element jest dostępny w schemacie źródła danych.
NotAvailable	Element został wcześniej skonfigurowany, ale nie jest już dostępny w schemacie źródła danych.
AccessDenied	Nie można odczytać schematu źródła danych, ponieważ nastąpiła odmowa dostępu.
AccessDeniedOap	Nie można odczytać schematu źródła danych, ponieważ dostęp jest blokowany przez zasady dostępu organizacji.
DatasourceNotFound	Nie można odnaleźć źródła danych.
SchemaUnavailable	Schemat źródła danych jest obecnie niedostępny.

ElementType

Wyliczenie

Publiczny typ elementu schematu źródła danych. Dodatkowe typy ElementType można dodawać z upływem czasu.

Wartość	Opis
Root	Element główny drzewa schematu źródła danych.
Files	Element kontenera plików.
Directory	Element katalogu.
Schemas	Kontener grupujący dla elementów schematu.
Tables	Kontener grupujący dla elementów tabeli.
Views	Kontener grupujący dla elementów widoku.
Functions	Kontener grupujący dla elementów funkcji.
ScalarFunctions	Kontener grupujący dla elementów funkcji skalarnych.
TableValuedFunctions	Kontener grupujący dla elementów funkcji o wartości tabeli.
Shortcuts	Kontener grupowania dla elementów skrótów.
MaterializedViews	Kontener grupowania dla zmaterializowanych elementów widoku.
Schema	Element schematu.
Table	Element tabeli.
ExternalTable	Zewnętrzny element tabeli.
MaterializedView	Zmaterializowany element widoku.
View	Element widoku.
Column	Element kolumny.
Measure	Element miary.
Function	Element funkcji.
FunctionParameter	Element parametru funkcji.
FunctionReturnValue	Element zwracanej wartości funkcji.
NodeType	Element typu węzła grafu.
EdgeType	Element typu krawędzi grafu.
Entity	Element jednostki ontologii.

ErrorRelatedResource

Objekt

Obiekt szczegółowych informacji o zasobie związanym z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu powiązany z błędem.
resourceType	string	Typ zasobu powiązanego z błędem.

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.

IndexState

Wyliczenie

Stan indeksu dla katalogów plików lakehouse. Dodatkowe typy IndexState można dodawać w czasie.

Wartość	Opis
Indexed	Katalog został zaindeksowany pod kątem wyszukiwania bez struktury.
Indexing	Katalog jest obecnie indeksowany.
NotIndexed	Katalog nie został indeksowany.