Catalog - Search

Serviço:
Core
Versão da API:
v1

A API de Pesquisa de Catálogo permite a descoberta programática de entradas de catálogo do OneLake em workspaces. Ele dá suporte à pesquisa entre workspaces por metadados de catálogo e retorna resultados filtrados para entradas que a entidade de chamada está autorizada a acessar. Os resultados da pesquisa incluem identificadores estáveis que devem ser usados com APIs complementares do Fabric para recuperar detalhes adicionais ou executar ações com suporte.

Observação

A pesquisa de catálogo está atualmente em versão prévia (saiba mais).

Um CatalogEntry é uma representação de metadados detectável de uma entidade do Microsoft Fabric, atualmente com escopo para itens de workspace. As entradas de catálogo destinam-se apenas à descoberta de metadados e não concedem acesso a dados subjacentes ou conteúdo de item.

Permissões

O chamador só pode descobrir entradas de catálogo para workspaces e itens que o chamador está autorizado a acessar.

Escopos delegados necessários

Catalog.Read.All

Limitações

  • continuationToken não deve ser combinado com search ou filter. O token já carrega esses valores da solicitação de origem.

  • pageSize deve estar entre 1 e 1000.

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identity Suporte
Usuário Sim
Entidade de serviço e identidades gerenciadas Sim

Interfase

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

Corpo da solicitação

Nome Tipo Description
continuationToken

string

O token de continuação para a próxima página.

Um token de continuação encaminha o search, filtere pageSize da solicitação original, para que ele possa ser enviado por conta própria. Ele não deve ser combinado com search ou filter na mesma solicitação; isso retorna um erro.
filter

string

O filtro para a pesquisa. Opções de filtro adicionais podem ser adicionadas ao longo do tempo.

O parâmetro de filtro dá suporte às seguintes propriedades:

  • Tipo: corresponde à type propriedade de uma entrada de catálogo, por exemplo Report, Lakehouseou Workspace. Um único filtro pode especificar no máximo 500 valores de tipo, cada um com até 50 caracteres de comprimento.

  • WorkspaceId: a ID do workspace que contém a entrada do catálogo. Um único filtro pode especificar no máximo 12 valores WorkspaceId, cada um deles deve ser um GUID válido.

O parâmetro de filtro dá suporte aos seguintes operadores para refinar os resultados:

  • eq: Igual a; corresponde ao valor exato.

  • ne: Não é igual a; exclui o valor especificado.

  • e: AND lógico; corresponde somente se todas as condições forem verdadeiras.

  • ou: OR lógico; corresponde se qualquer uma das condições for verdadeira.

  • ( ): Parênteses; agrupa expressões para definir hierarquia lógica.
pageSize

integer

O tamanho da página que precisa ser retornado. O tamanho da página deve estar entre 1 e 1000. O valor padrão é 50.
search

string

A consulta de texto para a pesquisa. Esse campo dá suporte à pesquisa entre o nome de exibição, o nome de exibição do workspace e a descrição do CatalogEntry.

O campo de pesquisa dá suporte aos seguintes operadores:

  • " " : aspas duplas; correspondem às palavras fechadas como uma frase exata.

  • * : Asterisco; caracteres curinga correspondentes a zero ou mais caracteres.

  • ? : ponto de interrogação; caractere curinga correspondente a um único caractere.

  • &&>>&> exigem cada termo de pesquisa.

  • Sublinhados são tratados como parte de um termo de pesquisa; nenhum escape é necessário.

  • Outros caracteres especiais são ignorados e tratados como separadores.

Respostas

Nome Tipo Description
200 OK

CatalogQueryResponse

OKEY
429 Too Many Requests

ErrorResponse

O limite de taxa de serviço foi excedido. O servidor retorna um Retry-After cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais.

Cabeçalhos

Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • InvalidRequest - O corpo da solicitação não foi fornecido ou é inválido.

  • InvalidSearch – O search valor não pôde ser analisado.

  • InvalidFilter – Não filter foi possível analisar ou um valor de filtro está malformado ou excede seu comprimento máximo.

  • InvalidFilterProperty – Faz filter referência a uma propriedade que não tem suporte.

  • FilterTooManyValues – Especifica filter mais valores para uma propriedade do que essa propriedade permite.

  • FilterNotSupported – Não há suporte para filtragem.

  • ConflictingFilterParameters - continuationToken foi combinado com search ou filter.

  • InvalidPageSize – pageSize está fora do intervalo de 1 a 1000.

  • InvalidContinuationToken – O continuationToken não é válido.

  • ContinuationTokenTooLong – continuationToken Excede o comprimento máximo.

  • TypeNotFound – Faz filter referência a um tipo de item que não existe.

  • Não autorizado – autenticação ausente ou inválida

  • Erro interno do servidor – falha inesperada do serviço.

Exemplos

Search example
Search within a workspace example

Search example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

Solicitação de exemplo

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
}

Resposta de exemplo

Código de status:
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..."
}

Definições

Nome Description
CatalogEntryType

O tipo de entrada do catálogo. Tipos de CatalogEntryType adicionais podem ser adicionados ao longo do tempo.
CatalogQueryRequest

A consulta para a pesquisa.
CatalogQueryResponse

Os resultados da pesquisa.
CatalogWorkspace

O workspace para a entrada do catálogo.
ErrorParameter

Um parâmetro estruturado que fornece contexto legível por computador adicional sobre um erro.
ErrorRelatedResource

O objeto relacionado ao erro nos detalhes do recurso.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
ItemCatalogEntry

A representação de metadados do catálogo de um item de Fabric.
ItemCatalogEntryHierarchy

Os ancestrais imediatos do item na arquitetura de dados do Fabric. Somente os níveis aplicáveis são retornados.
ItemType

O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
WorkspaceCatalogEntry

A representação de metadados de catálogo de um workspace Fabric.
WorkspaceCatalogEntryType

O tipo relatado em uma entrada de catálogo de workspace. Tipos de WorkspaceCatalogEntryType adicionais podem ser adicionados ao longo do tempo.

CatalogEntryType

Enumeração

O tipo de entrada do catálogo. Tipos de CatalogEntryType adicionais podem ser adicionados ao longo do tempo.

Valor Description
FabricItem

Um tipo de entrada de catálogo de itens do Fabric.
Workspace

Um tipo de entrada de catálogo de workspace.

CatalogQueryRequest

Objeto

A consulta para a pesquisa.

Nome Tipo Description
continuationToken

string

O token de continuação para a próxima página.

Um token de continuação encaminha o search, filtere pageSize da solicitação original, para que ele possa ser enviado por conta própria. Ele não deve ser combinado com search ou filter na mesma solicitação; isso retorna um erro.
filter

string

O filtro para a pesquisa. Opções de filtro adicionais podem ser adicionadas ao longo do tempo.

O parâmetro de filtro dá suporte às seguintes propriedades:

  • Tipo: corresponde à type propriedade de uma entrada de catálogo, por exemplo Report, Lakehouseou Workspace. Um único filtro pode especificar no máximo 500 valores de tipo, cada um com até 50 caracteres de comprimento.

  • WorkspaceId: a ID do workspace que contém a entrada do catálogo. Um único filtro pode especificar no máximo 12 valores WorkspaceId, cada um deles deve ser um GUID válido.

O parâmetro de filtro dá suporte aos seguintes operadores para refinar os resultados:

  • eq: Igual a; corresponde ao valor exato.

  • ne: Não é igual a; exclui o valor especificado.

  • e: AND lógico; corresponde somente se todas as condições forem verdadeiras.

  • ou: OR lógico; corresponde se qualquer uma das condições for verdadeira.

  • ( ): Parênteses; agrupa expressões para definir hierarquia lógica.
pageSize

integer

O tamanho da página que precisa ser retornado. O tamanho da página deve estar entre 1 e 1000. O valor padrão é 50.
search

string

A consulta de texto para a pesquisa. Esse campo dá suporte à pesquisa entre o nome de exibição, o nome de exibição do workspace e a descrição do CatalogEntry.

O campo de pesquisa dá suporte aos seguintes operadores:

  • " " : aspas duplas; correspondem às palavras fechadas como uma frase exata.

  • * : Asterisco; caracteres curinga correspondentes a zero ou mais caracteres.

  • ? : ponto de interrogação; caractere curinga correspondente a um único caractere.

  • &&>>&> exigem cada termo de pesquisa.

  • Sublinhados são tratados como parte de um termo de pesquisa; nenhum escape é necessário.

  • Outros caracteres especiais são ignorados e tratados como separadores.

CatalogQueryResponse

Objeto

Os resultados da pesquisa.

Nome Tipo Description
continuationToken

string

A continuationToken para a próxima página.
value CatalogEntry[]:

Uma lista de entradas de catálogo

CatalogWorkspace

Objeto

O workspace para a entrada do catálogo.

Nome Tipo Description
displayName

string

O nome de exibição da área de trabalho.
id

string (uuid)

A ID do workspace

ErrorParameter

Objeto

Um parâmetro estruturado que fornece contexto legível por computador adicional sobre um erro.

Nome Tipo Description
message

string

Uma descrição legível pelo ser humano do significado do parâmetro.
name

string

O identificador de parâmetro.
value

string

O valor do parâmetro.

ErrorRelatedResource

Objeto

O objeto relacionado ao erro nos detalhes do recurso.

Nome Tipo Description
resourceId

string

O identificador do recurso envolvido no erro.
resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
isRetriable

boolean

Quando true, a solicitação pode ser repetida. Use o Retry-After cabeçalho de resposta para determinar o atraso, se disponível.
message

string

Uma representação legível humana do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
parameters

ErrorParameter[]

Parâmetros estruturados que fornecem contexto legível por computador adicional sobre o erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string (uuid)

ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível humana do erro.
parameters

ErrorParameter[]

Parâmetros estruturados que fornecem contexto legível por computador adicional sobre o erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

ItemCatalogEntry

Objeto

A representação de metadados do catálogo de um item de Fabric.

Nome Tipo Description
catalogEntryType string:

FabricItem

O tipo de entrada do catálogo.
description

string

A descrição da entrada do catálogo.
displayName

string

O nome de exibição da entrada do catálogo.
hierarchy

ItemCatalogEntryHierarchy

A hierarquia da entrada do catálogo.
id

string (uuid)

A objectId da entrada do catálogo.
type

ItemType

O tipo de item fabric.

ItemCatalogEntryHierarchy

Objeto

Os ancestrais imediatos do item na arquitetura de dados do Fabric. Somente os níveis aplicáveis são retornados.

Nome Tipo Description
workspace

CatalogWorkspace

O workspace que contém o item.

ItemType

Enumeração

O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.

Valor Description
Dashboard

Painel do PowerBI.
Report

Relatório do PowerBI.
SemanticModel

Modelo semântico do PowerBI.
PaginatedReport

Relatório paginado do PowerBI.
Datamart

Datamart do PowerBI.
Lakehouse

Uma casa no lago.
Eventhouse

Uma casa de eventos.
Environment

Um ambiente.
KQLDatabase

Um banco de dados KQL.
KQLQueryset

Um conjunto de consultas KQL.
KQLDashboard

Um painel KQL.
DataPipeline

Um pipeline de dados.
Notebook

Um notebook.
SparkJobDefinition

Uma definição de trabalho do Spark.
MLExperiment

Um experimento de aprendizado de máquina.
MLModel

Um modelo de machine learning.
Warehouse

Um armazém.
Eventstream

Um fluxo de eventos.
SQLEndpoint

Um ponto de extremidade SQL.
MirroredWarehouse

Um armazém espelhado.
MirroredDatabase

Um banco de dados espelhado.
Reflex

Um Reflexo.
GraphQLApi

Um item de API para GraphQL.
MountedDataFactory

Um MountedDataFactory.
SQLDatabase

Um SQLDatabase.
CopyJob

Um trabalho de cópia.
VariableLibrary

Um VariableLibrary.
Dataflow

Um fluxo de dados.
ApacheAirflowJob

Um ApacheAirflowJob.
WarehouseSnapshot

Um instantâneo do Warehouse.
DigitalTwinBuilder

Um DigitalTwinBuilder.
DigitalTwinBuilderFlow

Um fluxo do Construtor de Gêmeos Digitais.
MirroredAzureDatabricksCatalog

Um catálogo espelhado do Azure Databricks.
Map

Um mapa.
AnomalyDetector

Um Detector de Anomalias.
UserDataFunction

Uma função de dados do usuário.
GraphModel

Um GraphModel.
GraphQuerySet

Um Graph QuerySet.
SnowflakeDatabase

Um Banco de Dados Snowflake para armazenar tabelas iceberg criadas a partir da conta snowflake.
OperationsAgent

Um OperationsAgent.
CosmosDBDatabase

Um banco de dados do Cosmos DB.
Ontology

Uma ontologia.
EventSchemaSet

Um EventSchemaSet.
DataAgent

Um DataAgent.
MirroredCatalog

Um MirroredCatalog.
PolicySet

Um PolicySet.
AppBackend

Um AppBackend.
OrgApp

Um aplicativo de organização.
OrgAppAudience

Uma audiência de aplicativo da organização.
DataBuildToolJob

Um DataBuildToolJob.
AzureDatabricksStorage

Um item de armazenamento com backup do OneLake para Azure Databricks.
Plan

Um plano.

WorkspaceCatalogEntry

Objeto

A representação de metadados de catálogo de um workspace Fabric.

Nome Tipo Description
catalogEntryType string:

Workspace

O tipo de entrada do catálogo.
description

string

A descrição da entrada do catálogo.
displayName

string

O nome de exibição da entrada do catálogo.
id

string (uuid)

A objectId da entrada do catálogo.
type

WorkspaceCatalogEntryType

O tipo de entrada do catálogo. Entradas de catálogo always Workspace for workspace.

WorkspaceCatalogEntryType

Enumeração

O tipo relatado em uma entrada de catálogo de workspace. Tipos de WorkspaceCatalogEntryType adicionais podem ser adicionados ao longo do tempo.

Valor Description
Workspace

Um espaço de trabalho.