Catalog - Search

Tjeneste:: Core

API-version:: v1

Api'en til katalogsøgning muliggør programmatisk registrering af OneLake-katalogposter på tværs af arbejdsområder. Den understøtter søgning på tværs af arbejdsområder via katalogmetadata og returnerer resultater, der er filtreret til poster, som den kaldende hovedkonto har tilladelse til at få adgang til. Søgeresultater omfatter stabile id'er, der er beregnet til at blive brugt sammen med komplementære Fabric-API'er til at hente yderligere oplysninger eller udføre understøttede handlinger.

Bemærkning

Katalogsøgning findes i øjeblikket som prøveversion (få mere at vide).

En CatalogEntry er en synlig metadatarepræsentation af et Microsoft Fabric-objekt, der i øjeblikket er begrænset til arbejdsområdeelementer. Katalogposter er kun beregnet til registrering af metadata og giver ikke adgang til underliggende data eller elementindhold.

Påkrævede delegerede områder

Catalog.Read.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Begrænsninger

Søgefunktionen er i øjeblikket begrænset til bestemte Fabric-elementtyper. Følgende elementtyper understøttes ikke: Dashboard, Dataflow (Gen1), Dataflow (Gen2).

Brugerflade

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

Brødtekst for anmodning

Name	Type	Beskrivelse
continuationToken	string	Fortsættelsestokenet for den næste side.
filter	string	Filteret til søgningen. Filteret understøtter i øjeblikket filter efter posttype. Der kan tilføjes flere filterindstillinger over tid. Filterparameteren understøtter følgende operatorer for at afgrænse resultaterne: eq : Lig med; svarer til den nøjagtige værdi. ne : Ikke lig med; udelader den angivne værdi. eller : Logisk OR; matcher, hvis nogen af betingelserne er sande. ( ) : Parenteser; grupperingsudtryk for at definere et logisk hierarki.
pageSize	integer	Den sidestørrelse, der skal returneres. Sidestørrelsen skal være mellem 1 og 1000.
search	string	Tekstforespørgslen for søgningen. Dette felt understøtter søgning på tværs af det viste navn og beskrivelsen af CatalogEntry.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	CatalogQueryResponse	OK
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: Uautoriseret - Manglende eller ugyldig godkendelse Intern serverfejl - Uventet tjenestefejl.

CatalogQueryResponse

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

Uautoriseret - Manglende eller ugyldig godkendelse
Intern serverfejl - Uventet tjenestefejl.

Eksempler

Search example

Eksempelanmodning

HTTP

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

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

Eksempelsvar

Statuskode:: 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."
    },
    {
      "id": "123d697c-7848-77cd-b887-91bfb12347cc",
      "type": "Lakehouse",
      "catalogEntryType": "FabricItem",
      "displayName": "Yeartly Sales Revenue",
      "description": "Consolidated revenue report for the current fiscal year."
    }
  ],
  "continuationToken": "lyJ1257lksfdfG=="
}

Definitioner

Name	Beskrivelse
CatalogEntryType	Katalogposttypen. Der kan tilføjes flere `CatalogEntryType` typer over tid.
CatalogQueryRequest	Forespørgslen til søgningen.
CatalogQueryResponse	Resultaterne af søgningen.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
ItemCatalogEntry	En Fabric-elementtype for katalogposten.
ItemType	Elementets type. Der kan tilføjes flere elementtyper over tid.

CatalogEntryType

Optælling

Katalogposttypen. Der kan tilføjes flere CatalogEntryType typer over tid.

Værdi	Beskrivelse
FabricItem	En posttype for et Fabric-varekatalog.

CatalogQueryRequest

Objekt

Forespørgslen til søgningen.

Name	Type	Beskrivelse
continuationToken	string	Fortsættelsestokenet for den næste side.
filter	string	Filteret til søgningen. Filteret understøtter i øjeblikket filter efter posttype. Der kan tilføjes flere filterindstillinger over tid. Filterparameteren understøtter følgende operatorer for at afgrænse resultaterne: eq : Lig med; svarer til den nøjagtige værdi. ne : Ikke lig med; udelader den angivne værdi. eller : Logisk OR; matcher, hvis nogen af betingelserne er sande. ( ) : Parenteser; grupperingsudtryk for at definere et logisk hierarki.
pageSize	integer	Den sidestørrelse, der skal returneres. Sidestørrelsen skal være mellem 1 og 1000.
search	string	Tekstforespørgslen for søgningen. Dette felt understøtter søgning på tværs af det viste navn og beskrivelsen af CatalogEntry.

CatalogQueryResponse

Objekt

Resultaterne af søgningen.

Name	Type	Beskrivelse
continuationToken	string	Fortsættelsestokenet for den næste side.
value	CatalogEntry[]: ItemCatalogEntry[]	En liste over katalogposter

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

ItemCatalogEntry

Objekt

En Fabric-elementtype for katalogposten.

Name	Type	Beskrivelse
catalogEntryType	string: FabricItem	Katalogposttypen.
description	string	Beskrivelsen af katalogposten.
displayName	string	Det viste navn på katalogposten.
id	string (uuid)	objectId for katalogposten.
type	ItemType	Elementtypen Fabric.

ItemType

Optælling

Elementets type. Der kan tilføjes flere elementtyper over tid.

Værdi	Beskrivelse
Dashboard	PowerBI-dashboard.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-model.
PaginatedReport	Sideinddelt PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et søhus.
Eventhouse	Et eventhouse.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-forespørgselssæt.
KQLDashboard	Et KQL-dashboard.
DataPipeline	En datapipeline.
Notebook	En notesbog.
SparkJobDefinition	En spark jobdefinition.
MLExperiment	Et maskinel indlæringseksperiment.
MLModel	En model til maskinel indlæring.
Warehouse	Et lager.
Eventstream	En hændelsesstream.
SQLEndpoint	Et SQL-slutpunkt.
MirroredWarehouse	Et spejlvendt lager.
MirroredDatabase	En spejlet database.
Reflex	En refleks.
GraphQLApi	En API til GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Et kopijob.
VariableLibrary	En VariabelLibrary.
Dataflow	Et dataflow.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et lagersnapshot.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Et Digital Twin Builder-flow.
MirroredAzureDatabricksCatalog	Et spejlet Azure Databricks-katalog.
Map	Et kort.
AnomalyDetector	En uregelmæssighedsregistrering.
UserDataFunction	En brugerdatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	Et Graph QuerySet.
SnowflakeDatabase	En Snowflake-database til lagring af Iceberg-tabeller, der er oprettet fra Snowflake-konto.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.
Ontology	En ontologi.
EventSchemaSet	Et EventSchemaSet.
DataAgent	En DataAgent.
MirroredCatalog	En MirroredCatalog.