Catalog - Search

Service:
Core
API-versie:
v1

De Cataloguszoekopdrachten-API maakt programmatische detectie mogelijk van OneLake-catalogusvermeldingen in werkruimten. Het ondersteunt zoeken tussen werkruimten via catalogusmetagegevens en retourneert resultaten die zijn gefilterd op vermeldingen die de aanroepende principal is gemachtigd voor toegang. Zoekresultaten bevatten stabiele id's die zijn bedoeld om te worden gebruikt met aanvullende Fabric-API's om aanvullende details op te halen of ondersteunde acties uit te voeren.

Opmerking

Cataloguszoekopdrachten zijn momenteel beschikbaar in preview (meer informatie).

Een CatalogEntry is een detecteerbare metagegevensweergave van een Microsoft Fabric-entiteit, die momenteel is gericht op werkruimte-items. Catalogusvermeldingen zijn alleen bedoeld voor detectie van metagegevens en verlenen geen toegang tot onderliggende gegevens of iteminhoud.

Vereiste gedelegeerde bevoegdheden

Catalog.Read.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit Support
Gebruiker Ja
serviceprincipal en beheerde identiteiten Ja

Beperkingen

  • De zoekfunctionaliteit is momenteel gericht op specifieke Fabric-itemtypen. De volgende itemtypen worden niet ondersteund: Dashboard, Gegevensstroom (Gen1), Gegevensstroom (Gen2).

Interface

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

Aanvraagbody

Name Type Description
continuationToken

string

Het vervolgtoken voor de volgende pagina.
filter

string

Het filter voor de zoekopdracht. Het filter ondersteunt momenteel filteren op type vermeldingen. Er kunnen in de loop van de tijd extra filteropties worden toegevoegd.

De filterparameter ondersteunt de volgende operators om resultaten te verfijnen:

  • eq : is gelijk aan; komt overeen met de exacte waarde.

  • ne : Niet gelijk aan; sluit de opgegeven waarde uit.

  • of: logische OR; komt overeen als aan een van de voorwaarden wordt voldaan.

  • ( ) : haakjes; groepen expressies om logische hiërarchie te definiëren.
pageSize

integer

Het paginaformaat dat moet worden geretourneerd. Het paginaformaat moet tussen 1 en 1000 zijn.
search

string

De tekstquery voor de zoekopdracht. Dit veld ondersteunt zoeken in de weergavenaam, de weergavenaam van de werkruimte en de beschrijving van CatalogEntry.

Antwoorden

Name Type Description
200 OK

CatalogQueryResponse

OK
429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • Niet geautoriseerd - Ontbrekende of ongeldige verificatie

  • Interne serverfout: onverwachte servicefout.

Voorbeelden

Search example

Voorbeeldaanvraag

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

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

Voorbeeldrespons

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..."
}

Definities

Name Description
CatalogEntryType

Het catalogusitemtype. Er kunnen in de loop van de tijd extra CatalogEntryType typen worden toegevoegd.
CatalogQueryRequest

De query voor de zoekopdracht.
CatalogQueryResponse

De resultaten van de zoekopdracht.
CatalogWorkspace

De werkruimte voor de catalogusvermelding.
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

De foutreactie.
ErrorResponseDetails

De details van het foutbericht.
ItemCatalogEntry

Een fabricitemtype van catalogusvermelding.
ItemCatalogEntryHierarchy

De directe voorouders van het item in de gegevensarchitectuur van Fabric. Alleen toepasselijke niveaus worden geretourneerd.
ItemType

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

CatalogEntryType

Opsomming

Het catalogusitemtype. Er kunnen in de loop van de tijd extra CatalogEntryType typen worden toegevoegd.

Waarde Description
FabricItem

Een itemcatalogustype voor fabricitems.

CatalogQueryRequest

Object

De query voor de zoekopdracht.

Name Type Description
continuationToken

string

Het vervolgtoken voor de volgende pagina.
filter

string

Het filter voor de zoekopdracht. Het filter ondersteunt momenteel filteren op type vermeldingen. Er kunnen in de loop van de tijd extra filteropties worden toegevoegd.

De filterparameter ondersteunt de volgende operators om resultaten te verfijnen:

  • eq : is gelijk aan; komt overeen met de exacte waarde.

  • ne : Niet gelijk aan; sluit de opgegeven waarde uit.

  • of: logische OR; komt overeen als aan een van de voorwaarden wordt voldaan.

  • ( ) : haakjes; groepen expressies om logische hiërarchie te definiëren.
pageSize

integer

Het paginaformaat dat moet worden geretourneerd. Het paginaformaat moet tussen 1 en 1000 zijn.
search

string

De tekstquery voor de zoekopdracht. Dit veld ondersteunt zoeken in de weergavenaam, de weergavenaam van de werkruimte en de beschrijving van CatalogEntry.

CatalogQueryResponse

Object

De resultaten van de zoekopdracht.

Name Type Description
continuationToken

string

Het vervolgtoken voor de volgende pagina.
value CatalogEntry[]:

ItemCatalogEntry[]

Een lijst met catalogusvermeldingen

CatalogWorkspace

Object

De werkruimte voor de catalogusvermelding.

Name Type Description
displayName

string

De weergavenaam van de werkruimte.
id

string (uuid)

De ID van de werkruimte.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-ID die betrokken is bij het probleem.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

De foutreactie.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

Details van de foutgerelateerde resource.
requestId

string (uuid)

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

Details van de foutgerelateerde resource.

ItemCatalogEntry

Object

Een fabricitemtype van catalogusvermelding.

Name Type Description
catalogEntryType string:

FabricItem

Het catalogusitemtype.
description

string

De beschrijving van de catalogusvermelding.
displayName

string

De weergavenaam van de catalogusvermelding.
hierarchy

ItemCatalogEntryHierarchy

De hiërarchie van de catalogusvermelding.
id

string (uuid)

De object-id van de catalogusvermelding.
type

ItemType

Het itemtype Fabric.

ItemCatalogEntryHierarchy

Object

De directe voorouders van het item in de gegevensarchitectuur van Fabric. Alleen toepasselijke niveaus worden geretourneerd.

Name Type Description
workspace

CatalogWorkspace

De werkruimte die het item bevat.

ItemType

Opsomming

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

Waarde Description
Dashboard

PowerBI-dashboard.
Report

PowerBI-rapport.
SemanticModel

Semantisch Power BI-model.
PaginatedReport

Gepagineerd Power BI-rapport.
Datamart

PowerBI-datamart.
Lakehouse

Een lakehouse.
Eventhouse

Een eventhouse.
Environment

Een omgeving.
KQLDatabase

Een KQL-database.
KQLQueryset

Een KQL-queryset.
KQLDashboard

Een KQL-dashboard.
DataPipeline

Een gegevenspijplijn.
Notebook

Een notitieblok.
SparkJobDefinition

Een Spark-taakdefinitie.
MLExperiment

Een machine learning-experiment.
MLModel

Een machine learning-model.
Warehouse

Een magazijn.
Eventstream

Een eventstream.
SQLEndpoint

Een SQL-eindpunt.
MirroredWarehouse

Een gespiegeld magazijn.
MirroredDatabase

Een gespiegelde database.
Reflex

Een reflex.
GraphQLApi

Een API voor GraphQL-item.
MountedDataFactory

Een MountedDataFactory.
SQLDatabase

Een SQLDatabase.
CopyJob

Een kopieertaak.
VariableLibrary

Een VariableLibrary.
Dataflow

Een gegevensstroom.
ApacheAirflowJob

Een ApacheAirflowJob.
WarehouseSnapshot

Een momentopname van een magazijn.
DigitalTwinBuilder

Een DigitalTwinBuilder.
DigitalTwinBuilderFlow

Een Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog

Een gespiegelde Azure Databricks-catalogus.
Map

Een kaart.
AnomalyDetector

Een Anomaly Detector.
UserDataFunction

Een gebruikersgegevensfunctie.
GraphModel

Een GraphModel.
GraphQuerySet

Een Graph QuerySet.
SnowflakeDatabase

Een Snowflake-database voor het opslaan van Iceberg-tabellen die zijn gemaakt op basis van het Snowflake-account.
OperationsAgent

Een OperationsAgent.
CosmosDBDatabase

Een Cosmos DB-database.
Ontology

Een Ontologie.
EventSchemaSet

Een EventSchemaSet.
DataAgent

Een DataAgent.
MirroredCatalog

Een mirroredCatalog.