Catalog - Search

Tjeneste:

Core

API-versjon:

v1

API-en for katalogsøk muliggjør programmatisk oppdagelse av OneLake-katalogoppføringer på tvers av arbeidsområder. Den støtter søk på tvers av arbeidsområder over katalogmetadata og returnerer resultater filtrert til oppføringer som anropskontohaveren har tillatelse til å få tilgang til. Søkeresultatene inkluderer stabile identifikatorer som er ment å brukes med komplementære fabric-API-er for å hente flere detaljer eller utføre støttede handlinger.

Bemerkning

Katalogsøk er for øyeblikket i forhåndsvisning (finn ut mer).

En CatalogEntry er en synlig metadatarepresentasjon av en Microsoft Fabric-enhet, som for øyeblikket er begrenset til arbeidsområdeelementer. Katalogoppføringer er bare ment for metadataoppdagelse og gir ikke tilgang til underliggende data eller elementinnhold.

Tillatelser

Innringeren kan bare oppdage katalogoppføringer for arbeidsområder og elementer som innringeren har tillatelse til å få tilgang til.

Nødvendige delegerte omfang

Catalog.Read.All

Begrensninger

• continuationToken kan ikke kombineres med search eller filter. Tokenet bærer allerede disse verdiene fra den opprinnelige forespørselen.

• pageSize må være mellom 1 og 1000.

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Kundestøtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

Brødtekst for forespørsel

Name	Type	Beskrivelse
continuationToken	string	Fortsettelsestokenet for neste side. Et fortsettelsestoken viderefører search, filterog pageSize den opprinnelige forespørselen, slik at den kan sendes på egen hånd. Den kan ikke kombineres med search eller filter i samme forespørsel. Dette returnerer en feil.
filter	string	Filteret for søket. Flere filteralternativer kan legges til over tid. Filterparameteren støtter følgende egenskaper: Type: Samsvarer med type egenskapen for en katalogoppføring, for eksempel Report, Lakehouseeller Workspace. Et enkelt filter kan angi maksimalt 500 typeverdier, hver på opptil 50 tegn. WorkspaceId: ID-en for arbeidsområdet som inneholder katalogoppføringen. Et enkelt filter kan angi maksimalt 12 WorkspaceId-verdier, som hver må være en gyldig GUID. Filterparameteren støtter følgende operatorer for å begrense resultatene: eq: Er lik; samsvarer med den nøyaktige verdien. ne: Ikke lik; utelater den angitte verdien. og: Logisk OG; samsvarer bare hvis alle betingelsene er sanne. eller: Logisk ELLER; samsvarer hvis noen av betingelsene er sanne. ( ): Parenteser; grupperer uttrykk for å definere logisk hierarki.
pageSize	integer	Sidestørrelsen som må returneres. Sidestørrelsen må være mellom 1 og 1000. Standarder til 50.
search	string	Tekstspørringen for søket. Dette feltet støtter søk på tvers av visningsnavnet, visningsnavnet for arbeidsområdet og beskrivelsen av CatalogEntry. Søkefeltet støtter følgende operatorer: " " : Doble anførselstegn; samsvarer med de omsluttede ordene som et nøyaktig uttrykk. * : Stjerne; jokertegn som samsvarer med null eller flere tegn. ? : Spørsmålstegn; jokertegn som samsvarer med ett enkelt tegn. && Doble & ampersand; krever hvert søkeord. Understrekingstegn behandles som en del av et søkeord. ingen rømmer er nødvendig. Andre spesialtegn ignoreres og behandles som skilletegn.

Svar

Name	Type	Beskrivelse
200 OK	CatalogQueryResponse	OK
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: InvalidRequest – Forespørselsteksten ble ikke angitt, eller er ellers ugyldig. InvalidSearch – Verdien search kan ikke analyseres. InvalidFilter – Kan filter ikke analyseres, eller en filterverdi er feilformet eller overskrider maksimumslengden. InvalidFilterProperty – filter Refererer til en egenskap som ikke støttes. FilterTooManyValues – filter angir flere verdier for en egenskap enn den egenskapen tillater. FilterNotSupported – filtrering støttes ikke. ConflictingFilterParameters – continuationToken ble kombinert med search eller filter. InvalidPageSize – pageSize er utenfor området fra 1 til 1000. InvalidContinuationToken – er continuationToken ugyldig. ContinuationTokenTooLong – continuationToken overskrider maksimumslengden. TypeNotFound – Refererer filter til en elementtype som ikke finnes. Uautorisert – manglende eller ugyldig godkjenning Intern serverfeil – uventet tjenestefeil.

Eksempler

Search example

Search within a workspace example

Search example

Eksempelforespørsel

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

Eksempelforespørsel

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

Definisjoner

Name	Beskrivelse
CatalogEntryType	Katalogoppføringstypen. Flere CatalogEntryType typer kan legges til over tid.
CatalogQueryRequest	Spørringen for søket.
CatalogQueryResponse	Resultatene av søket.
CatalogWorkspace	Arbeidsområdet for katalogoppføringen.
ErrorParameter	En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
ItemCatalogEntry	Representasjonen av katalogmetadata for et Fabric element.
ItemCatalogEntryHierarchy	De umiddelbare overordnede for elementet i Fabric dataarkitektur. Bare gjeldende nivåer returneres.
ItemType	Typen element. Flere elementtyper kan legges til over tid.
WorkspaceCatalogEntry	Representasjonen av katalogmetadata for et Fabric arbeidsområde.
WorkspaceCatalogEntryType	Typen som rapporteres på en oppføring i arbeidsområdet. Flere WorkspaceCatalogEntryType typer kan legges til over tid.

CatalogEntryType

Opplisting

Katalogoppføringstypen. Flere CatalogEntryType typer kan legges til over tid.

Verdi	Beskrivelse
FabricItem	En oppføringstype for fabric-elementkatalog.
Workspace	En oppføringstype for arbeidsområdekatalog.

CatalogQueryRequest

Objekt

Spørringen for søket.

Name	Type	Beskrivelse
continuationToken	string	Fortsettelsestokenet for neste side. Et fortsettelsestoken viderefører search, filterog pageSize den opprinnelige forespørselen, slik at den kan sendes på egen hånd. Den kan ikke kombineres med search eller filter i samme forespørsel. Dette returnerer en feil.
filter	string	Filteret for søket. Flere filteralternativer kan legges til over tid. Filterparameteren støtter følgende egenskaper: Type: Samsvarer med type egenskapen for en katalogoppføring, for eksempel Report, Lakehouseeller Workspace. Et enkelt filter kan angi maksimalt 500 typeverdier, hver på opptil 50 tegn. WorkspaceId: ID-en for arbeidsområdet som inneholder katalogoppføringen. Et enkelt filter kan angi maksimalt 12 WorkspaceId-verdier, som hver må være en gyldig GUID. Filterparameteren støtter følgende operatorer for å begrense resultatene: eq: Er lik; samsvarer med den nøyaktige verdien. ne: Ikke lik; utelater den angitte verdien. og: Logisk OG; samsvarer bare hvis alle betingelsene er sanne. eller: Logisk ELLER; samsvarer hvis noen av betingelsene er sanne. ( ): Parenteser; grupperer uttrykk for å definere logisk hierarki.
pageSize	integer	Sidestørrelsen som må returneres. Sidestørrelsen må være mellom 1 og 1000. Standarder til 50.
search	string	Tekstspørringen for søket. Dette feltet støtter søk på tvers av visningsnavnet, visningsnavnet for arbeidsområdet og beskrivelsen av CatalogEntry. Søkefeltet støtter følgende operatorer: " " : Doble anførselstegn; samsvarer med de omsluttede ordene som et nøyaktig uttrykk. * : Stjerne; jokertegn som samsvarer med null eller flere tegn. ? : Spørsmålstegn; jokertegn som samsvarer med ett enkelt tegn. && Doble & ampersand; krever hvert søkeord. Understrekingstegn behandles som en del av et søkeord. ingen rømmer er nødvendig. Andre spesialtegn ignoreres og behandles som skilletegn.

CatalogQueryResponse

Objekt

Resultatene av søket.

Name	Type	Beskrivelse
continuationToken	string	Fortsettelsestokenet for neste side.
value	CatalogEntry[]: ItemCatalogEntry[] WorkspaceCatalogEntry[]	En liste over katalogoppføringer

CatalogWorkspace

Objekt

Arbeidsområdet for katalogoppføringen.

Name	Type	Beskrivelse
displayName	string	Visningsnavnet på arbeidsområdet.
id	string (uuid)	ID-en for arbeidsområdet.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name	Type	Beskrivelse
message	string	En lesbar beskrivelse av parameterens betydning.
name	string	Parameteridentifikatoren.
value	string	Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. Retry-After Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

ItemCatalogEntry

Objekt

Representasjonen av katalogmetadata for et Fabric element.

Name	Type	Beskrivelse
catalogEntryType	string: FabricItem	Katalogoppføringstypen.
description	string	Beskrivelsen av katalogoppføringen.
displayName	string	Visningsnavnet for katalogoppføringen.
hierarchy	ItemCatalogEntryHierarchy	Hierarkiet for katalogoppføringen.
id	string (uuid)	ObjectId for katalogoppføringen.
type	ItemType	Stoffelementtypen.

ItemCatalogEntryHierarchy

Objekt

De umiddelbare overordnede for elementet i Fabric dataarkitektur. Bare gjeldende nivåer returneres.

Name	Type	Beskrivelse
workspace	CatalogWorkspace	Arbeidsområdet som inneholder elementet.

ItemType

Opplisting

Typen element. Flere elementtyper kan legges til over tid.

Verdi	Beskrivelse
Dashboard	PowerBI-instrumentbord.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-modell.
PaginatedReport	Paginert powerbi-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et innsjøhus.
Eventhouse	Et arrangementshus.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-spørringssett.
KQLDashboard	Et KQL-instrumentbord.
DataPipeline	Et datasamlebånd.
Notebook	En notatblokk.
SparkJobDefinition	En spark-jobbdefinisjon.
MLExperiment	Et maskinlæringseksperiment.
MLModel	En maskinlæringsmodell.
Warehouse	Et lager.
Eventstream	En hendelsesstrøm.
SQLEndpoint	Et SQL-endepunkt.
MirroredWarehouse	Et speilvendt lager.
MirroredDatabase	En speilvendt database.
Reflex	En refleks.
GraphQLApi	En API for GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	En kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	En dataflyt.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et øyeblikksbilde av lageret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	En digital Twin Builder-flyt.
MirroredAzureDatabricksCatalog	En speilet azure databricks-katalog.
Map	Et kart.
AnomalyDetector	En avviksdetektor.
UserDataFunction	En brukerdatafunksjon.
GraphModel	En GraphModel.
GraphQuerySet	Et graph QuerySet.
SnowflakeDatabase	En Snowflake Database for å lagre Iceberg-tabeller opprettet fra Snowflake-kontoen.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.
Ontology	En ontologi.
EventSchemaSet	En EventSchemaset.
DataAgent	En DataAgent.
MirroredCatalog	En MirroredCatalog.
PolicySet	Et policysett.
AppBackend	En AppBackend.
OrgApp	En organisasjonsapp.
OrgAppAudience	En organisasjonsapp målgruppe.
DataBuildToolJob	En DataBuildToolJob.
AzureDatabricksStorage	Et OneLake-støttet lagringselement for Azure Databricks.
Plan	En plan.
Monitoring	Et overvåkingselement.
DeploymentPlan	En distribusjonsplan.
ShareSubscription	Et delabonnement.
Share	En del.

WorkspaceCatalogEntry

Objekt

Representasjonen av katalogmetadata for et Fabric arbeidsområde.

Name	Type	Beskrivelse
catalogEntryType	string: Workspace	Katalogoppføringstypen.
description	string	Beskrivelsen av katalogoppføringen.
displayName	string	Visningsnavnet for katalogoppføringen.
id	string (uuid)	ObjectId for katalogoppføringen.
type	WorkspaceCatalogEntryType	Katalogoppføringstypen. Alltid Workspace for oppføringer i arbeidsområdekatalogen.

WorkspaceCatalogEntryType

Opplisting

Typen som rapporteres på en oppføring i arbeidsområdet. Flere WorkspaceCatalogEntryType typer kan legges til over tid.

Verdi	Beskrivelse
Workspace	Et arbeidsområde.