Catalog - Search

Dienst:: Core

API-Version:: v1

Die Katalogsuch-API ermöglicht die programmgesteuerte Ermittlung von OneLake-Katalogeinträgen über Arbeitsbereiche hinweg. Sie unterstützt die Arbeitsbereichssuche über Katalogmetadaten und gibt Ergebnisse zurück, die auf Einträge gefiltert sind, auf die der aufrufende Prinzipal zugreifen darf. Zu den Suchergebnissen gehören stabile Bezeichner, die mit ergänzenden Fabric-APIs verwendet werden sollen, um zusätzliche Details abzurufen oder unterstützte Aktionen auszuführen.

Hinweis

Die Katalogsuche befindet sich derzeit in der Vorschau (weitere Informationen).

Ein CatalogEntry ist eine auffindbare Metadatendarstellung einer Microsoft Fabric-Entität, die derzeit auf Arbeitsbereichselemente festgelegt ist. Katalogeinträge sind nur für die Metadatenermittlung vorgesehen und gewähren keinen Zugriff auf zugrunde liegende Daten oder Elementinhalte.

Erforderliche delegierte Zugriffsbereiche

Catalog.Read.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Support
Benutzer	Ja
Service Principal und Verwaltete Identitäten	Ja

Einschränkungen

Die Suchfunktion ist derzeit auf bestimmte Fabric-Elementtypen festgelegt. Die folgenden Elementtypen werden nicht unterstützt: Dashboard, Dataflow (Gen1), Dataflow (Gen2).

Schnittstelle

POST https://api.fabric.microsoft.com/v1/catalog/search

Anforderungstext

Name	Typ	Beschreibung
continuationToken	string	Das continuationToken für die nächste Seite.
filter	string	Der Filter für die Suche. Derzeit unterstützt der Filter Filter nach Typ von Einträgen. Im Laufe der Zeit können zusätzliche Filteroptionen hinzugefügt werden. Der Filterparameter unterstützt die folgenden Operatoren zum Verfeinern von Ergebnissen: eq : Gleich; entspricht dem exakten Wert. ne : Ungleich; schließt den angegebenen Wert aus. oder : LogischeS ODER; stimmt zu, wenn eine der Bedingungen erfüllt ist. ( ) : Klammern; gruppiert Ausdrücke zum Definieren der logischen Hierarchie.
pageSize	integer	Die Seitengröße, die zurückgegeben werden muss. Die Seitengröße muss zwischen 1 und 1000 sein.
search	string	Die Textabfrage für die Suche. Dieses Feld unterstützt die Suche über den Anzeigenamen, den Arbeitsbereichsanzeigenamen und die Beschreibung des CatalogEntry.This field supports searching across the display name, workspace display name and description of the CatalogEntry.

Antworten

Name Typ Beschreibung

200 OK

Name	Typ	Beschreibung
200 OK	CatalogQueryResponse	OKAY
429 Too Many Requests	ErrorResponse	Der Dienstratenlimit wurde überschritten. Der Server gibt einen `Retry-After` Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden. Header Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: Nicht autorisiert – Fehlende oder ungültige Authentifizierung Interner Serverfehler – Unerwarteter Dienstfehler.

CatalogQueryResponse

OKAY

429 Too Many Requests

ErrorResponse

Der Dienstratenlimit wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

Nicht autorisiert – Fehlende oder ungültige Authentifizierung
Interner Serverfehler – Unerwarteter Dienstfehler.

Beispiele

Search example

Beispielanforderung

HTTP

POST https://api.fabric.microsoft.com/v1/catalog/search

{
  "search": "Sales Revenue",
  "pageSize": 2,
  "filter": "Type eq 'Report' or Type eq 'Lakehouse'"
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "id": "0acd697c-1550-43cd-b998-91bfb12347c6",
      "type": "Report",
      "catalogEntryType": "FabricItem",
      "displayName": "Monthly Sales Revenue",
      "description": "Consolidated revenue report for the current fiscal year.",
      "hierarchy": {
        "workspace": {
          "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
          "displayName": "Sales Analytics"
        }
      }
    },
    {
      "id": "5e8f2a1b-9c3d-4e7f-b6a5-d4c3b2a1e0f9",
      "type": "Lakehouse",
      "catalogEntryType": "FabricItem",
      "displayName": "Sales Revenue Lakehouse",
      "description": "Central lakehouse for sales transaction data.",
      "hierarchy": {
        "workspace": {
          "id": "a2b3c4d5-e6f7-4a8b-9c0d-1e2f3a4b5c6d",
          "displayName": "Finance Platform"
        }
      }
    }
  ],
  "continuationToken": "eyJza2lwIjoyLCJ0YWtl..."
}

Definitionen

Name	Beschreibung
CatalogEntryType	Der Katalogeintragstyp. Zusätzliche `CatalogEntryType` Typen können im Laufe der Zeit hinzugefügt werden.
CatalogQueryRequest	Die Abfrage für die Suche.
CatalogQueryResponse	Die Ergebnisse der Suche.
CatalogWorkspace	Der Arbeitsbereich für den Katalogeintrag.
ErrorRelatedResource	Das Objekt der fehlerbezogenen Ressourcendetails.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
ItemCatalogEntry	Ein Fabric-Elementtyp des Katalogeintrags.
ItemCatalogEntryHierarchy	Die unmittelbaren Vorgänger des Elements in Fabric Datenarchitektur. Es werden nur anwendbare Ebenen zurückgegeben.
ItemType	Der Typ des Elements Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

CatalogEntryType

Enumeration

Der Katalogeintragstyp. Zusätzliche CatalogEntryType Typen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
FabricItem	Ein Fabric-Elementkatalogeintragstyp.

CatalogQueryRequest

Objekt

Die Abfrage für die Suche.

Name	Typ	Beschreibung
continuationToken	string	Das continuationToken für die nächste Seite.
filter	string	Der Filter für die Suche. Derzeit unterstützt der Filter Filter nach Typ von Einträgen. Im Laufe der Zeit können zusätzliche Filteroptionen hinzugefügt werden. Der Filterparameter unterstützt die folgenden Operatoren zum Verfeinern von Ergebnissen: eq : Gleich; entspricht dem exakten Wert. ne : Ungleich; schließt den angegebenen Wert aus. oder : LogischeS ODER; stimmt zu, wenn eine der Bedingungen erfüllt ist. ( ) : Klammern; gruppiert Ausdrücke zum Definieren der logischen Hierarchie.
pageSize	integer	Die Seitengröße, die zurückgegeben werden muss. Die Seitengröße muss zwischen 1 und 1000 sein.
search	string	Die Textabfrage für die Suche. Dieses Feld unterstützt die Suche über den Anzeigenamen, den Arbeitsbereichsanzeigenamen und die Beschreibung des CatalogEntry.This field supports searching across the display name, workspace display name and description of the CatalogEntry.

CatalogQueryResponse

Objekt

Die Ergebnisse der Suche.

Name	Typ	Beschreibung
continuationToken	string	Das continuationToken für die nächste Seite.
value	CatalogEntry[]: ItemCatalogEntry[]	Eine Liste der Katalogeinträge

CatalogWorkspace

Objekt

Der Arbeitsbereich für den Katalogeintrag.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Arbeitsbereichs.
id	string (uuid)	Die ID des Arbeitsbereichs.

ErrorRelatedResource

Objekt

Das Objekt der fehlerbezogenen Ressourcendetails.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
isRetriable	boolean	Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den `Retry-After` Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.
message	string	Eine menschenlesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string (uuid)	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine menschenlesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

ItemCatalogEntry

Objekt

Ein Fabric-Elementtyp des Katalogeintrags.

Name	Typ	Beschreibung
catalogEntryType	string: FabricItem	Der Katalogeintragstyp.
description	string	Die Beschreibung des Katalogeintrags.
displayName	string	Der Anzeigename des Katalogeintrags.
hierarchy	ItemCatalogEntryHierarchy	Die Hierarchie des Katalogeintrags.
id	string (uuid)	Die objectId des Katalogeintrags.
type	ItemType	Der Fabric-Elementtyp.

ItemCatalogEntryHierarchy

Objekt

Die unmittelbaren Vorgänger des Elements in Fabric Datenarchitektur. Es werden nur anwendbare Ebenen zurückgegeben.

Name	Typ	Beschreibung
workspace	CatalogWorkspace	Der Arbeitsbereich, der das Element enthält.

ItemType

Enumeration

Der Typ des Elements Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Dashboard	PowerBI-Dashboard.
Report	PowerBI-Bericht.
SemanticModel	PowerBI-Semantikmodell.
PaginatedReport	PowerBI-Paginated-Bericht.
Datamart	PowerBI datamart.
Lakehouse	Ein Seehaus.
Eventhouse	Ein Eventhouse.
Environment	Eine Umgebung.
KQLDatabase	Eine KQL-Datenbank.
KQLQueryset	Ein KQL-Abfrageset.
KQLDashboard	Ein KQL-Dashboard.
DataPipeline	Eine Datenpipeline.
Notebook	Ein Notebook
SparkJobDefinition	Eine Sparkauftragsdefinition.
MLExperiment	Ein Machine Learning-Experiment.
MLModel	Ein Machine Learning-Modell.
Warehouse	Ein Lagerhaus.
Eventstream	Ein Event-Stream.
SQLEndpoint	Ein SQL-Endpunkt.
MirroredWarehouse	Ein gespiegeltes Lager.
MirroredDatabase	Eine gespiegelte Datenbank.
Reflex	Ein Reflex.
GraphQLApi	Eine API für GraphQL-Element.
MountedDataFactory	Eine MountedDataFactory.
SQLDatabase	Eine SQLDatabase.
CopyJob	Ein Kopierauftrag.
VariableLibrary	Eine VariableLibrary.
Dataflow	Ein Datenfluss.
ApacheAirflowJob	Ein ApacheAirflowJob.
WarehouseSnapshot	Eine Warehouse-Momentaufnahme.
DigitalTwinBuilder	Ein DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ein Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	Ein gespiegelter Azure Databricks-Katalog.
Map	Eine Karte.
AnomalyDetector	Anomaliedetektor.
UserDataFunction	Eine Benutzerdatenfunktion.
GraphModel	Ein GraphModel.
GraphQuerySet	Ein Graph QuerySet.
SnowflakeDatabase	Eine Snowflake-Datenbank zum Speichern von Iceberg-Tabellen, die aus dem Snowflake-Konto erstellt wurden.
OperationsAgent	Ein OperationsAgent.
CosmosDBDatabase	Eine Cosmos DB-Datenbank.
Ontology	Eine Ontologie.
EventSchemaSet	Ein EventSchemaSet.
DataAgent	Ein DataAgent.
MirroredCatalog	A MirroredCatalog.