Catalog - Search

Služba:

Core

Verze rozhraní API:

v1

Rozhraní API pro vyhledávání katalogu umožňuje programové zjišťování položek katalogu OneLake napříč pracovními prostory. Podporuje vyhledávání mezi pracovními prostory přes metadata katalogu a vrací výsledky filtrované na položky, ke které má objekt zabezpečení volání oprávnění pro přístup. Výsledky hledání zahrnují stabilní identifikátory, které mají být použity s doplňkovými rozhraními API fabric k načtení dalších podrobností nebo provádění podporovaných akcí.

Poznámka:

Vyhledávání v katalogu je aktuálně ve verzi Preview (další informace).

CatalogEntry je zjistitelná metadata reprezentace entity Microsoft Fabric, která je aktuálně vymezena na položky pracovního prostoru. Položky katalogu jsou určeny pouze pro zjišťování metadat a neudělují přístup k podkladovým datům nebo obsahu položky.

Požadované delegované rozsahy

Catalog.Read.All

Podporované identity v Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita	Podpora
User	Ano
Hlavní služba a Spravované identity	Ano

Omezení

• Funkce vyhledávání je aktuálně vymezena na konkrétní typy položek infrastruktury. Následující typy položek se nepodporují: řídicí panel, tok dat (Gen1), tok dat (Gen2).

Rozhraní

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

Text požadavku

Name	Typ	Description
continuationToken	string	PokračováníToken pro další stránku.
filter	string	Filtr pro hledání. Filtr v současné době podporuje filtrování podle typu položek. V průběhu času se můžou přidat další možnosti filtru. Parametr filtru podporuje následující operátory pro upřesnění výsledků: eq : Rovná se; odpovídá přesné hodnotě. ne : Nerovná se; vyloučí zadanou hodnotu. nebo : Logická OR; odpovídá, pokud je některá z podmínek pravdivá. ( ) : závorky; seskupuje výrazy pro definování logické hierarchie.
pageSize	integer	Velikost stránky, kterou je potřeba vrátit. Velikost stránky musí být v rozsahu 1 až 1 000.
search	string	Textový dotaz pro hledání. Toto pole podporuje vyhledávání v zobrazovaném názvu a popisu CatalogEntry.

Odpovědi

Name	Typ	Description
200 OK	CatalogQueryResponse	OK
429 Too Many Requests	ErrorResponse	Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku Retry-After udávající, kolik sekund musí klient čekat před odesláním dalších požadavků. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: Neautorizováno – Chybějící nebo neplatné ověřování Vnitřní chyba serveru – Neočekávané selhání služby

Příklady

Search example

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
CatalogEntryType	Typ položky katalogu. V průběhu času je možné přidat další typy CatalogEntryType.
CatalogQueryRequest	Dotaz pro hledání.
CatalogQueryResponse	Výsledky hledání.
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
ItemCatalogEntry	Typ položky infrastruktury položky katalogu.
ItemType	Typ položky. V průběhu času je možné přidat další typy položek.

CatalogEntryType

Výčet

Typ položky katalogu. V průběhu času je možné přidat další typy CatalogEntryType.

Hodnota	Description
FabricItem	Typ položky katalogu prostředků infrastruktury.

CatalogQueryRequest

Objekt

Dotaz pro hledání.

Name	Typ	Description
continuationToken	string	PokračováníToken pro další stránku.
filter	string	Filtr pro hledání. Filtr v současné době podporuje filtrování podle typu položek. V průběhu času se můžou přidat další možnosti filtru. Parametr filtru podporuje následující operátory pro upřesnění výsledků: eq : Rovná se; odpovídá přesné hodnotě. ne : Nerovná se; vyloučí zadanou hodnotu. nebo : Logická OR; odpovídá, pokud je některá z podmínek pravdivá. ( ) : závorky; seskupuje výrazy pro definování logické hierarchie.
pageSize	integer	Velikost stránky, kterou je potřeba vrátit. Velikost stránky musí být v rozsahu 1 až 1 000.
search	string	Textový dotaz pro hledání. Toto pole podporuje vyhledávání v zobrazovaném názvu a popisu CatalogEntry.

CatalogQueryResponse

Objekt

Výsledky hledání.

Name	Typ	Description
continuationToken	string	PokračováníToken pro další stránku.
value	CatalogEntry[]: ItemCatalogEntry[]	Seznam položek katalogu

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který se podílí na chybě.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string (uuid)	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

ItemCatalogEntry

Objekt

Typ položky infrastruktury položky katalogu.

Name	Typ	Description
catalogEntryType	string: FabricItem	Typ položky katalogu.
description	string	Popis položky katalogu.
displayName	string	Zobrazovaný název položky katalogu.
id	string (uuid)	ObjectId položky katalogu.
type	ItemType	Typ položky Fabric.

ItemType

Výčet

Typ položky. V průběhu času je možné přidat další typy položek.

Hodnota	Description
Dashboard	Řídicí panel PowerBI
Report	Sestava PowerBI
SemanticModel	Sémantický model PowerBI
PaginatedReport	Stránkovaná sestava PowerBI
Datamart	Datový diagram PowerBI
Lakehouse	Jezero.
Eventhouse	Eventhouse.
Environment	Prostředí.
KQLDatabase	Databáze KQL.
KQLQueryset	Sada dotazů KQL.
KQLDashboard	Řídicí panel KQL.
DataPipeline	Datový kanál.
Notebook	Poznámkový blok.
SparkJobDefinition	Definice úlohy Sparku.
MLExperiment	Experiment strojového učení.
MLModel	Model strojového učení.
Warehouse	Sklad.
Eventstream	Eventstream.
SQLEndpoint	Koncový bod SQL.
MirroredWarehouse	Zrcadlený sklad.
MirroredDatabase	Zrcadlené databáze.
Reflex	A Reflex.
GraphQLApi	Rozhraní API pro položku GraphQL
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Databáze SQLDatabase.
CopyJob	Úloha kopírování.
VariableLibrary	ProměnnáLibrary.
Dataflow	Tok dat.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Snímek skladu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Tok digitálního dvojčete.
MirroredAzureDatabricksCatalog	Zrcadlený katalog Azure Databricks.
Map	Mapa.
AnomalyDetector	Detektor anomálií.
UserDataFunction	Funkce uživatelských dat.
GraphModel	A GraphModel.
GraphQuerySet	Sada dotazů grafu.
SnowflakeDatabase	Snowflake Database pro ukládání tabulek Iceberg vytvořených z účtu Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Databáze Cosmos DB.
Ontology	Ontologie.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.