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.

Tilladelser

Den person, der ringer op, kan kun finde katalogposter for arbejdsområder og elementer, som den person, der ringer op, har tilladelse til at få adgang til.

Påkrævede delegerede områder

Catalog.Read.All

Begrænsninger

• continuationToken må ikke kombineres med search eller filter. Tokenet indeholder allerede disse værdier fra den oprindelige anmodning.

• pageSize skal være mellem 1 og 1000.

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

Brugerflade

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

Brødtekst for anmodning

Navn	Type	Beskrivelse
continuationToken	string	Fortsættelsestokenet for næste side. Et fortsættelsestoken videresender search, filterog pageSize for den oprindelige anmodning, så den kan sendes alene. Den må ikke kombineres med search eller filter i den samme anmodning. Hvis du gør det, returneres der en fejl.
filter	string	Filteret til søgningen. Der kan tilføjes flere filterindstillinger over tid. Filterparameteren understøtter følgende egenskaber: Type: Matcher egenskaben type for en katalogpost, f.eks Report. , Lakehouseeller Workspace. Et enkelt filter kan højst angive 500 typeværdier, hver op til 50 tegn lang. WorkspaceId: Id'et for det arbejdsområde, der indeholder katalogposten. Et enkelt filter kan højst angive 12 WorkspaceId-værdier, som hver især skal være et gyldigt GUID. Filterparameteren understøtter følgende operatorer for at afgrænse resultaterne: eq: lig med; svarer til den nøjagtige værdi. ne: Not Equals; udelader den angivne værdi. og: Logisk AND; matcher kun, hvis alle betingelserne er sande. 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. Som standard 50.
search	string	Tekstforespørgslen for søgningen. Dette felt understøtter søgning på tværs af det viste navn, arbejdsområdets viste navn og beskrivelse af CatalogEntry. Søgefeltet understøtter følgende operatorer: " : Dobbelte anførselstegn; matche de omsluttede ord som et nøjagtigt udtryk. * : Stjerne; jokertegn, der svarer til nul eller flere tegn. ? : Spørgsmålstegn; jokertegn, der svarer til et enkelt tegn. & Dobbelt-og-tegn; kræver hvert søgeord. Understregningstegn behandles som en del af et søgeord. der kræves ingen escaping. Andre specialtegn ignoreres og behandles som separatorer.

Svar

Navn	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: InvalidRequest – Anmodningens brødtekst blev ikke angivet, eller den er på anden måde ugyldig. InvalidSearch – Værdien search kunne ikke fortolkes. InvalidFilter – Den filter kunne ikke parses, eller en filterværdi er forkert udformet eller overskrider den maksimale længde. InvalidFilterProperty – Henviser filter til en egenskab, der ikke understøttes. FilterTooManyValues – Angiver filter flere værdier for en egenskab, end denne egenskab tillader. FilterNotSupported – Filtrering understøttes ikke. ConflictingFilterParameters – continuationToken blev kombineret med search eller filter. InvalidPageSize – pageSize er uden for intervallet 1 til 1000. InvalidContinuationToken – er continuationToken ikke gyldig. ContinuationTokenTooLong – overskrider continuationToken den maksimale længde. TypeNotFound – filter Refererer til en elementtype, der ikke findes. Uautoriseret - Manglende eller ugyldig godkendelse Intern serverfejl - Uventet tjenestefejl.

Eksempler

Search example

Search within a workspace example

Search example

Eksempelanmodning

HTTP

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

{
  "search": "sales",
  "pageSize": 3,
  "filter": "Type eq 'Report' or Type eq 'Lakehouse' or Type eq 'Workspace'"
}

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.",
      "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"
        }
      }
    },
    {
      "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
      "type": "Workspace",
      "catalogEntryType": "Workspace",
      "displayName": "Sales Analytics",
      "description": "Workspace for the sales analytics team."
    }
  ],
  "continuationToken": "eyJza2lwIjozLCJ0YWtl..."
}

Search within a workspace example

Eksempelanmodning

HTTP

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

{
  "search": "revenue",
  "filter": "(Type eq 'Report' or Type eq 'SemanticModel') and WorkspaceId eq '7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3'",
  "pageSize": 2
}

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.",
      "hierarchy": {
        "workspace": {
          "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
          "displayName": "Sales Analytics"
        }
      }
    },
    {
      "id": "c41d9f2e-7b60-4a15-8d3c-2f6e9a0b7c48",
      "type": "SemanticModel",
      "catalogEntryType": "FabricItem",
      "displayName": "Revenue Semantic Model",
      "description": "Shared revenue model backing the sales reports.",
      "hierarchy": {
        "workspace": {
          "id": "7f2c8a91-3b4d-4e5f-a6b7-c8d9e0f1a2b3",
          "displayName": "Sales Analytics"
        }
      }
    }
  ],
  "continuationToken": "eyJza2lwIjoyLCJ0YWtl..."
}

Definitioner

Navn	Beskrivelse
CatalogEntryType	Katalogposttypen. Der kan tilføjes flere CatalogEntryType typer over tid.
CatalogQueryRequest	Forespørgslen til søgningen.
CatalogQueryResponse	Resultaterne af søgningen.
CatalogWorkspace	Arbejdsområdet for katalogposten.
ErrorParameter	En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
ItemCatalogEntry	Katalogmetadatarepræsentationen for et Fabric element.
ItemCatalogEntryHierarchy	De nærmeste overordnede elementer for elementet i Fabric dataarkitektur. Det er kun relevante niveauer, der returneres.
ItemType	Elementets type. Der kan tilføjes flere elementtyper over tid.
WorkspaceCatalogEntry	Katalogmetadatarepræsentationen for et Fabric arbejdsområde.
WorkspaceCatalogEntryType	Den type, der er rapporteret for en post i arbejdsområdekataloget. Der kan tilføjes flere WorkspaceCatalogEntryType typer 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.
Workspace	En posttype for arbejdsområdekataloget.

CatalogQueryRequest

Objekt

Forespørgslen til søgningen.

Navn	Type	Beskrivelse
continuationToken	string	Fortsættelsestokenet for næste side. Et fortsættelsestoken videresender search, filterog pageSize for den oprindelige anmodning, så den kan sendes alene. Den må ikke kombineres med search eller filter i den samme anmodning. Hvis du gør det, returneres der en fejl.
filter	string	Filteret til søgningen. Der kan tilføjes flere filterindstillinger over tid. Filterparameteren understøtter følgende egenskaber: Type: Matcher egenskaben type for en katalogpost, f.eks Report. , Lakehouseeller Workspace. Et enkelt filter kan højst angive 500 typeværdier, hver op til 50 tegn lang. WorkspaceId: Id'et for det arbejdsområde, der indeholder katalogposten. Et enkelt filter kan højst angive 12 WorkspaceId-værdier, som hver især skal være et gyldigt GUID. Filterparameteren understøtter følgende operatorer for at afgrænse resultaterne: eq: lig med; svarer til den nøjagtige værdi. ne: Not Equals; udelader den angivne værdi. og: Logisk AND; matcher kun, hvis alle betingelserne er sande. 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. Som standard 50.
search	string	Tekstforespørgslen for søgningen. Dette felt understøtter søgning på tværs af det viste navn, arbejdsområdets viste navn og beskrivelse af CatalogEntry. Søgefeltet understøtter følgende operatorer: " : Dobbelte anførselstegn; matche de omsluttede ord som et nøjagtigt udtryk. * : Stjerne; jokertegn, der svarer til nul eller flere tegn. ? : Spørgsmålstegn; jokertegn, der svarer til et enkelt tegn. & Dobbelt-og-tegn; kræver hvert søgeord. Understregningstegn behandles som en del af et søgeord. der kræves ingen escaping. Andre specialtegn ignoreres og behandles som separatorer.

CatalogQueryResponse

Objekt

Resultaterne af søgningen.

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

CatalogWorkspace

Objekt

Arbejdsområdet for katalogposten.

Navn	Type	Beskrivelse
displayName	string	Visningsnavnet på arbejdsområdet.
id	string (uuid)	Id'et for arbejdsområdet.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn	Type	Beskrivelse
message	string	En læsevenlig beskrivelse af parameterens betydning.
name	string	Parameter-id'et.
value	string	Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn	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.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen Retry-After til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn	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.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

ItemCatalogEntry

Objekt

Katalogmetadatarepræsentationen for et Fabric element.

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

ItemCatalogEntryHierarchy

Objekt

De nærmeste overordnede elementer for elementet i Fabric dataarkitektur. Det er kun relevante niveauer, der returneres.

Navn	Type	Beskrivelse
workspace	CatalogWorkspace	Det arbejdsområde, der indeholder elementet.

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.
AppBackend	En AppBackend.
OrgApp	En organisationsapp.
OrgAppAudience	En målgruppe for organisationsapps.
DataBuildToolJob	Et DataBuildToolJob.
AzureDatabricksStorage	Et OneLake-understøttet lagerelement til Azure Databricks.
Plan	En plan.

WorkspaceCatalogEntry

Objekt

Katalogmetadatarepræsentationen for et Fabric arbejdsområde.

Navn	Type	Beskrivelse
catalogEntryType	string: Workspace	Katalogposttypen.
description	string	Beskrivelsen af katalogposten.
displayName	string	Det viste navn på katalogposten.
id	string (uuid)	objectId for katalogposten.
type	WorkspaceCatalogEntryType	Katalogposttypen. Altid Workspace for poster i arbejdsområdekataloget.

WorkspaceCatalogEntryType

Optælling

Den type, der er rapporteret for en post i arbejdsområdekataloget. Der kan tilføjes flere WorkspaceCatalogEntryType typer over tid.

Værdi	Beskrivelse
Workspace	Et arbejdsområde.