Catalog - Search

Service:: Core

Version d'API:: v1

L’API Recherche de catalogue permet la découverte programmatique des entrées de catalogue OneLake dans les espaces de travail. Il prend en charge la recherche inter-espaces de travail sur les métadonnées du catalogue et retourne les résultats filtrés sur les entrées que le principal appelant est autorisé à accéder. Les résultats de la recherche incluent des identificateurs stables destinés à être utilisés avec des API Fabric complémentaires pour récupérer des détails supplémentaires ou effectuer des actions prises en charge.

Note

La recherche de catalogue est actuellement en préversion (en savoir plus).

Un CatalogEntry est une représentation de métadonnées détectable d’une entité Microsoft Fabric, actuellement étendue aux éléments de l’espace de travail. Les entrées de catalogue sont destinées uniquement à la découverte de métadonnées et n’accordent pas l’accès aux données sous-jacentes ou au contenu d’élément.

Étendues déléguées requises

Catalog.Read.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Support
Utilisateur	Oui
Service principal et identités gérées	Oui

Limites

La fonctionnalité de recherche est actuellement étendue à des types d’éléments Fabric spécifiques. Les types d’éléments suivants ne sont pas pris en charge : Tableau de bord, Dataflow (Gen1), Dataflow (Gen2).

Interface

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

Corps de la demande

Nom	Type	Description
continuationToken	string	ContinuationToken pour la page suivante.
filter	string	Filtre de la recherche. Actuellement, le filtre prend en charge le filtre par type d’entrées. Des options de filtre supplémentaires peuvent être ajoutées au fil du temps. Le paramètre de filtre prend en charge les opérateurs suivants pour affiner les résultats : eq : Égal ; correspond à la valeur exacte. ne : Non égal ; exclut la valeur spécifiée. ou : OR logique ; correspond si l’une des conditions est vraie. ( ) : parenthèses ; regroupe des expressions pour définir une hiérarchie logique.
pageSize	integer	Taille de page à renvoyer. La taille de page doit être comprise entre 1 et 1 000.
search	string	Requête de texte pour la recherche. Ce champ prend en charge la recherche dans le nom d’affichage, le nom d’affichage de l’espace de travail et la description de CatalogEntry.

Réponses

Nom Type Description

200 OK

Nom	Type	Description
200 OK	CatalogQueryResponse	Ok
429 Too Many Requests	ErrorResponse	La limite de débit de service a été dépassée. Le serveur retourne un `Retry-After` en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires. En-têtes Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : Non autorisé - Authentification manquante ou non valide Erreur interne du serveur : échec inattendu du service.

CatalogQueryResponse

429 Too Many Requests

ErrorResponse

La limite de débit de service a été dépassée. Le serveur retourne un Retry-After en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires.

En-têtes

Retry-After: integer

Other Status Codes

ErrorResponse

Codes d’erreur courants :

Non autorisé - Authentification manquante ou non valide
Erreur interne du serveur : échec inattendu du service.

Exemples

Search example

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:: 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..."
}

Définitions

Nom	Description
CatalogEntryType	Type d’entrée de catalogue. Des types `CatalogEntryType` supplémentaires peuvent être ajoutés au fil du temps.
CatalogQueryRequest	Requête pour la recherche.
CatalogQueryResponse	Résultats de la recherche.
CatalogWorkspace	Espace de travail pour l’entrée de catalogue.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
ItemCatalogEntry	Type d’élément Fabric d’entrée de catalogue.
ItemCatalogEntryHierarchy	Ancêtres immédiats de l'élément dans l'architecture de données de Fabric. Seuls les niveaux applicables sont retournés.
ItemType	Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

CatalogEntryType

Énumération

Type d’entrée de catalogue. Des types CatalogEntryType supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
FabricItem	Type d’entrée de catalogue d’éléments de structure.

CatalogQueryRequest

Objet

Requête pour la recherche.

Nom	Type	Description
continuationToken	string	ContinuationToken pour la page suivante.
filter	string	Filtre de la recherche. Actuellement, le filtre prend en charge le filtre par type d’entrées. Des options de filtre supplémentaires peuvent être ajoutées au fil du temps. Le paramètre de filtre prend en charge les opérateurs suivants pour affiner les résultats : eq : Égal ; correspond à la valeur exacte. ne : Non égal ; exclut la valeur spécifiée. ou : OR logique ; correspond si l’une des conditions est vraie. ( ) : parenthèses ; regroupe des expressions pour définir une hiérarchie logique.
pageSize	integer	Taille de page à renvoyer. La taille de page doit être comprise entre 1 et 1 000.
search	string	Requête de texte pour la recherche. Ce champ prend en charge la recherche dans le nom d’affichage, le nom d’affichage de l’espace de travail et la description de CatalogEntry.

CatalogQueryResponse

Objet

Résultats de la recherche.

Nom	Type	Description
continuationToken	string	ContinuationToken pour la page suivante.
value	CatalogEntry[]: ItemCatalogEntry[]	Liste des entrées de catalogue

CatalogWorkspace

Objet

Espace de travail pour l’entrée de catalogue.

Nom	Type	Description
displayName	string	Nom d'affichage de l’espace de travail.
id	string (uuid)	L'identifiant de l’espace de travail.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string (uuid)	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

ItemCatalogEntry

Objet

Type d’élément Fabric d’entrée de catalogue.

Nom	Type	Description
catalogEntryType	string: FabricItem	Type d’entrée de catalogue.
description	string	Description de l’entrée de catalogue.
displayName	string	Nom complet de l’entrée de catalogue.
hierarchy	ItemCatalogEntryHierarchy	Hiérarchie de l’entrée de catalogue.
id	string (uuid)	ObjectId de l’entrée de catalogue.
type	ItemType	Type d’élément Fabric.

ItemCatalogEntryHierarchy

Objet

Ancêtres immédiats de l'élément dans l'architecture de données de Fabric. Seuls les niveaux applicables sont retournés.

Nom	Type	Description
workspace	CatalogWorkspace	Espace de travail qui contient l’élément.

ItemType

Énumération

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Dashboard	Tableau de bord PowerBI.
Report	Rapport PowerBI.
SemanticModel	Modèle sémantique PowerBI.
PaginatedReport	Rapport paginé PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Un lac.
Eventhouse	Un eventhouse.
Environment	Environnement.
KQLDatabase	Base de données KQL.
KQLQueryset	Ensemble de requêtes KQL.
KQLDashboard	Tableau de bord KQL.
DataPipeline	Un pipeline de données.
Notebook	Un notebook.
SparkJobDefinition	Définition d’un travail Spark.
MLExperiment	Une expérience de Machine Learning.
MLModel	Modèle Machine Learning.
Warehouse	Un entrepôt.
Eventstream	Flux d’événements.
SQLEndpoint	Point de terminaison SQL.
MirroredWarehouse	Un entrepôt mis en miroir.
MirroredDatabase	Une base de données mise en miroir.
Reflex	Un réflexe.
GraphQLApi	API pour l’élément GraphQL.
MountedDataFactory	Un MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Tâche de copie.
VariableLibrary	A VariableLibrary.
Dataflow	Flux de données.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Capture instantanée de l’entrepôt.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Flux de générateur de jumeaux numériques.
MirroredAzureDatabricksCatalog	Catalogue Azure databricks mis en miroir.
Map	Carte.
AnomalyDetector	Détecteur d’anomalies.
UserDataFunction	Fonction de données utilisateur.
GraphModel	A GraphModel.
GraphQuerySet	Ensemble de requêtes Graph.
SnowflakeDatabase	Une base de données Snowflake pour stocker les tables Iceberg créées à partir du compte Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Base de données Cosmos DB.
Ontology	Une ontologie.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	A MirroredCatalog.