Catalog - Search

Katalog Arama API'si, çalışma alanları arasında OneLake katalog girdilerinin program aracılığıyla bulunmasını sağlar. Katalog meta verileri üzerinde çalışma alanları arası aramayı destekler ve arama sorumlusunun erişim yetkisine sahip olduğu girişlere filtrelenmiş sonuçları döndürür. Arama sonuçları, ek ayrıntıları almak veya desteklenen eylemleri gerçekleştirmek için tamamlayıcı Doku API'leriyle birlikte kullanılması amaçlanan kararlı tanımlayıcıları içerir.

Uyarı

Katalog araması şu anda Önizleme aşamasındadır (daha fazla bilgi edinin).

CatalogEntry, kapsamı şu anda çalışma alanı öğeleri olarak belirlenmiş bir Microsoft Fabric varlığının bulunabilir meta veri gösterimidir. Katalog girdileri yalnızca meta veri bulmaya yöneliktir ve temel alınan verilere veya öğe içeriğine erişim izni vermez.

Permissions

Arayan yalnızca çalışma alanlarının ve çağıranın erişim yetkisine sahip olduğu öğelerin katalog girişlerini bulabilir.

Gerekli Devredilen Kapsamlar

Catalog.Read.All

Sınırlamalar

  • continuationTokenveya filterile search birleştirilmemelidir. Belirteç, bu değerleri kaynak istekten zaten taşır.

  • pageSize 1 ile 1000 arasında olmalıdır.

Kısıtlama limitleri

Sınır Türü Değer
Platform API'leri için Birleşik Kota 500 arama/dk
API sınırı 50 arama/dk

Microsoft Entra destekli kimlikler

Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.

Identity Support
User Evet
Hizmet sorumlusu ve yönetilen kimlikler Evet

Arayüz

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

İstek Gövdesi

Veri Akışı Adı Tür Description
continuationToken

string

Sonraki sayfa için devamlılık belirteci.

Devam belirteci özgün isteğin search, filterve pageSize iletimini taşır, bu nedenle kendi başına gönderilebilir. Aynı istekle search veya filter aynı istekte birleştirilmemelidir; bunu yapmak bir hata döndürür.

filter

string

Arama filtresi. Zaman içinde ek filtre seçenekleri eklenebilir.

Filtre parametresi aşağıdaki özellikleri destekler:

  • Tür: Katalog girdisinin özelliğiyle eşleşir type ; örneğin Report, , Lakehouseveya Workspace. Tek bir filtre en fazla 500 Tür değeri belirtebilir ve her birinin en çok 50 karakter uzunluğunda olmasını sağlayabilir.

  • WorkspaceId: Katalog girdisini içeren çalışma alanının kimliği. Tek bir filtre, her biri geçerli bir GUID olması gereken en fazla 12 WorkspaceId değeri belirtebilir.

Filtre parametresi, sonuçları daraltmak için aşağıdaki işleçleri destekler:

  • eq: Eşittir; tam değerle eşleşir.

  • ne: Eşit Değil; belirtilen değeri dışlar.

  • ve: Mantıksal AND; yalnızca tüm koşullar doğruysa eşleşir.

  • veya: Mantıksal VEYA; , koşullardan herhangi biri doğruysa eşleşir.

  • ( ): Parantez; mantıksal hiyerarşiyi tanımlamak için ifadeleri gruplandırıyor.

pageSize

integer

Döndürülmesi gereken sayfa boyutu. Sayfa boyutu 1 ile 1000 arasında olmalıdır. Varsayılan değer 50'dir.

search

string

Arama için metin sorgusu. Bu alan, CatalogEntry'nin görünen adı, çalışma alanı görünen adı ve açıklaması arasında aramayı destekler.

Arama alanı aşağıdaki işleçleri destekler:

  • " " : Çift tırnak; kapalı sözcükleri tam bir tümcecik olarak eşleştirin.

  • * : Yıldız; sıfır veya daha fazla karakterle eşleşen joker karakter.

  • ? : Soru işareti; tek bir karakterle eşleşen joker karakter.

  • & : Çift ve işareti; her arama terimini gerektirir.

  • Alt çizgiler bir arama teriminin parçası olarak değerlendirilir; kaçış gerekmez.

  • Diğer özel karakterler yoksayılır ve ayırıcı olarak değerlendirilir.

Yanıtlar

Veri Akışı Adı Tür Description
200 OK

CatalogQueryResponse

Tamam

429 Too Many Requests

ErrorResponse

Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir Retry-After üst bilgi döndürür.

Üst Bilgiler

Retry-After: integer

Other Status Codes

ErrorResponse

Yaygın hata kodları:

  • InvalidRequest - İstek gövdesi sağlanmadı veya başka bir şekilde geçersiz.

  • InvalidSearch - Değer search ayrıştırılamadı.

  • InvalidFilter - filter Ayrıştırılamadı veya filtre değeri hatalı biçimlendirilmiş veya uzunluk üst sınırını aşıyor.

  • InvalidFilterProperty - filter Desteklenmeyen bir özelliğe başvurur.

  • FilterTooManyValues - Özelliğin filter izin verdiğinden daha fazla değer belirtir.

  • FilterNotSupported - Filtreleme desteklenmez.

  • ConflictingFilterParameters - continuationToken veya filterile search birleştirildi.

  • InvalidPageSize - pageSize 1 - 1000 aralığının dışında.

  • InvalidContinuationToken - geçerli continuationToken değil.

  • ContinuationTokenTooLong - Uzunluk continuationToken üst sınırını aşıyor.

  • TypeNotFound - Var filter olmayan bir öğe türüne başvurur.

  • Yetkisiz - Eksik veya geçersiz kimlik doğrulaması

  • İç Sunucu Hatası - Beklenmeyen hizmet hatası.

Örnekler

Search example
Search within a workspace example

Search example

Örnek isteği

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

Örnek yanıt

{
  "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

Örnek isteği

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
}

Örnek yanıt

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

Tanımlar

Veri Akışı Adı Description
CatalogEntryType

Katalog giriş türü. Zaman içinde ek CatalogEntryType türleri eklenebilir.

CatalogQueryRequest

Arama sorgusu.

CatalogQueryResponse

Aramanın sonuçları.

CatalogWorkspace

Katalog girdisinin çalışma alanı.

ErrorParameter

Bir hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametre.

ErrorRelatedResource

Hata ile ilişkili kaynak ayrıntıları nesnesi.

ErrorResponse

Hata yanıtı.

ErrorResponseDetails

Hata yanıtı ayrıntıları.

ItemCatalogEntry

bir Fabric öğesinin katalog meta veri gösterimi.

ItemCatalogEntryHierarchy

Fabric veri mimarisindeki öğenin hemen ataları. Yalnızca geçerli düzeyler döndürülür.

ItemType

Öğenin türü. Zaman içinde ek öğe türleri eklenebilir.

WorkspaceCatalogEntry

Fabric çalışma alanının katalog meta veri gösterimi.

WorkspaceCatalogEntryType

Çalışma alanı kataloğu girdisinde bildirilen tür. Zaman içinde ek WorkspaceCatalogEntryType türleri eklenebilir.

CatalogEntryType

Katalog giriş türü. Zaman içinde ek CatalogEntryType türleri eklenebilir.

Değer Description
FabricItem

Doku öğesi kataloğu giriş türü.

Workspace

Çalışma alanı kataloğu giriş türü.

CatalogQueryRequest

Arama sorgusu.

Veri Akışı Adı Tür Description
continuationToken

string

Sonraki sayfa için devamlılık belirteci.

Devam belirteci özgün isteğin search, filterve pageSize iletimini taşır, bu nedenle kendi başına gönderilebilir. Aynı istekle search veya filter aynı istekte birleştirilmemelidir; bunu yapmak bir hata döndürür.

filter

string

Arama filtresi. Zaman içinde ek filtre seçenekleri eklenebilir.

Filtre parametresi aşağıdaki özellikleri destekler:

  • Tür: Katalog girdisinin özelliğiyle eşleşir type ; örneğin Report, , Lakehouseveya Workspace. Tek bir filtre en fazla 500 Tür değeri belirtebilir ve her birinin en çok 50 karakter uzunluğunda olmasını sağlayabilir.

  • WorkspaceId: Katalog girdisini içeren çalışma alanının kimliği. Tek bir filtre, her biri geçerli bir GUID olması gereken en fazla 12 WorkspaceId değeri belirtebilir.

Filtre parametresi, sonuçları daraltmak için aşağıdaki işleçleri destekler:

  • eq: Eşittir; tam değerle eşleşir.

  • ne: Eşit Değil; belirtilen değeri dışlar.

  • ve: Mantıksal AND; yalnızca tüm koşullar doğruysa eşleşir.

  • veya: Mantıksal VEYA; , koşullardan herhangi biri doğruysa eşleşir.

  • ( ): Parantez; mantıksal hiyerarşiyi tanımlamak için ifadeleri gruplandırıyor.

pageSize

integer

Döndürülmesi gereken sayfa boyutu. Sayfa boyutu 1 ile 1000 arasında olmalıdır. Varsayılan değer 50'dir.

search

string

Arama için metin sorgusu. Bu alan, CatalogEntry'nin görünen adı, çalışma alanı görünen adı ve açıklaması arasında aramayı destekler.

Arama alanı aşağıdaki işleçleri destekler:

  • " " : Çift tırnak; kapalı sözcükleri tam bir tümcecik olarak eşleştirin.

  • * : Yıldız; sıfır veya daha fazla karakterle eşleşen joker karakter.

  • ? : Soru işareti; tek bir karakterle eşleşen joker karakter.

  • & : Çift ve işareti; her arama terimini gerektirir.

  • Alt çizgiler bir arama teriminin parçası olarak değerlendirilir; kaçış gerekmez.

  • Diğer özel karakterler yoksayılır ve ayırıcı olarak değerlendirilir.

CatalogQueryResponse

Aramanın sonuçları.

Veri Akışı Adı Tür Description
continuationToken

string

Sonraki sayfa için continuationToken.

value CatalogEntry[]:

Katalog girdilerinin listesi

CatalogWorkspace

Katalog girdisinin çalışma alanı.

Veri Akışı Adı Tür Description
displayName

string

Çalışma alanının görünen adı.

id

string (uuid)

Çalışma alanının kimliği.

ErrorParameter

Bir hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametre.

Veri Akışı Adı Tür Description
message

string

Parametrenin anlamının insan tarafından okunabilen açıklaması.

name

string

Parametre tanımlayıcısı.

value

string

Parametre değeridir.

ErrorRelatedResource

Hata ile ilişkili kaynak ayrıntıları nesnesi.

Veri Akışı Adı Tür Description
resourceId

string

Hataya dahil olan kaynak kimliği.

resourceType

string

Hataya dahil olan kaynağın türü.

ErrorResponse

Hata yanıtı.

Veri Akışı Adı Tür Description
errorCode

string

Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.

isRetriable

boolean

True olduğunda istek yeniden denenebilir. Varsa gecikmeyi Retry-After belirlemek için yanıt üst bilgisini kullanın.

message

string

Hatanın insan tarafından okunabilir bir temsilidir.

moreDetails

ErrorResponseDetails[]

Ek hata ayrıntılarının listesi.

parameters

ErrorParameter[]

Hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametreler.

relatedResource

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları.

requestId

string (uuid)

Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Hata yanıtı ayrıntıları.

Veri Akışı Adı Tür Description
errorCode

string

Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.

message

string

Hatanın insan tarafından okunabilir bir temsilidir.

parameters

ErrorParameter[]

Hata hakkında makine tarafından okunabilir ek bağlam sağlayan yapılandırılmış parametreler.

relatedResource

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları.

ItemCatalogEntry

bir Fabric öğesinin katalog meta veri gösterimi.

Veri Akışı Adı Tür Description
catalogEntryType string:

FabricItem

Katalog giriş türü.

description

string

Katalog girdisinin açıklaması.

displayName

string

Katalog girdisi görünen adı.

hierarchy

ItemCatalogEntryHierarchy

Katalog girdisinin hiyerarşisi.

id

string (uuid)

Katalog girdisinin objectId değeri.

type

ItemType

Doku öğesi türü.

ItemCatalogEntryHierarchy

Fabric veri mimarisindeki öğenin hemen ataları. Yalnızca geçerli düzeyler döndürülür.

Veri Akışı Adı Tür Description
workspace

CatalogWorkspace

Öğeyi içeren çalışma alanı.

ItemType

Öğenin türü. Zaman içinde ek öğe türleri eklenebilir.

Değer Description
Dashboard

PowerBI panosu.

Report

PowerBI raporu.

SemanticModel

PowerBI anlam modeli.

PaginatedReport

PowerBI sayfalandırılmış raporu.

Datamart

PowerBI datamart.

Lakehouse

Göl evi.

Eventhouse

Bir olay evi.

Environment

Bir ortam.

KQLDatabase

KQL veritabanı.

KQLQueryset

KQL sorgu kümesi.

KQLDashboard

KQL panosu.

DataPipeline

Veri işlem hattı.

Notebook

Bir not defteri.

SparkJobDefinition

Spark iş tanımı.

MLExperiment

Makine öğrenmesi denemesi.

MLModel

Makine öğrenmesi modeli.

Warehouse

Bir depo.

Eventstream

Bir olay akışı.

SQLEndpoint

Bir SQL uç noktası.

MirroredWarehouse

Aynalı bir depo.

MirroredDatabase

Yansıtılmış veritabanı.

Reflex

Bir refleks.

GraphQLApi

GraphQL öğesi için bir API.

MountedDataFactory

Bir MountedDataFactory.

SQLDatabase

A SQLDatabase.

CopyJob

Kopyalama işi.

VariableLibrary

Bir VariableLibrary.

Dataflow

Veri akışı.

ApacheAirflowJob

An ApacheAirflowJob.

WarehouseSnapshot

Ambar anlık görüntüsü.

DigitalTwinBuilder

A DigitalTwinBuilder.

DigitalTwinBuilderFlow

Dijital İkiz Oluşturucu Akışı.

MirroredAzureDatabricksCatalog

Yansıtılmış azure databricks kataloğu.

Map

Bir harita.

AnomalyDetector

Anomali Algılayıcısı.

UserDataFunction

Kullanıcı Verileri İşlevi.

GraphModel

A GraphModel.

GraphQuerySet

A Graph QuerySet.

SnowflakeDatabase

Snowflake hesabından oluşturulan Iceberg tablolarını depolamak için bir Snowflake Veritabanı.

OperationsAgent

A OperationsAgent.

CosmosDBDatabase

Cosmos DB Veritabanı.

Ontology

Bir Ontoloji.

EventSchemaSet

Bir EventSchemaSet.

DataAgent

A DataAgent.

MirroredCatalog

A MirroredCatalog.

PolicySet

İlke Kümesi.

AppBackend

An AppBackend.

OrgApp

Kuruluş uygulaması.

OrgAppAudience

Kuruluş Uygulaması Hedef Kitlesi.

DataBuildToolJob

A DataBuildToolJob.

AzureDatabricksStorage

Azure Databricks için OneLake destekli bir depolama öğesi.

Plan

Bir plan.

Monitoring

İzleme öğesi.

DeploymentPlan

Dağıtım planı.

ShareSubscription

Paylaşım aboneliği.

Share

Bir paylaşım.

Playbook

Bir Playbook.

MirroredOneLake

Yansıtılmış bir OneLake öğesi.

PostgreSQLDatabase

Microsoft Fabric bir PostgreSQL veritabanı öğesi.

CustomStreamConnector

Microsoft Fabric'da Özel Akış Bağlayıcısı öğesi.

WorkspaceCatalogEntry

Fabric çalışma alanının katalog meta veri gösterimi.

Veri Akışı Adı Tür Description
catalogEntryType string:

Workspace

Katalog giriş türü.

description

string

Katalog girdisinin açıklaması.

displayName

string

Katalog girdisi görünen adı.

id

string (uuid)

Katalog girdisinin objectId değeri.

type

WorkspaceCatalogEntryType

Katalog giriş türü. Çalışma alanı kataloğu girdileri için her zaman Workspace .

WorkspaceCatalogEntryType

Çalışma alanı kataloğu girdisinde bildirilen tür. Zaman içinde ek WorkspaceCatalogEntryType türleri eklenebilir.

Değer Description
Workspace

Çalışma alanı.