Compartilhar via

Items - Get KQL Database

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

Retorna propriedades do banco de dados KQL especificado.

Permissões

O chamador deve ter permissões de leitura para o banco de dados KQL.

Escopos delegados necessários

KQLDatabase.Read.All ou KQLDatabase.ReadWrite.All ou Item.Read.All ou Item.ReadWrite.All

Identidades com suporte do Microsoft Entra

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

Identidade Apoio
Utilizador Sim
entidade de serviço e identidades gerenciadas Sim

Interfase

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
kqlDatabaseId
 path True

string (uuid)

A ID do banco de dados KQL.
workspaceId
 path True

string (uuid)

A ID do workspace.

Respostas

Nome Tipo Description
200 OK

KQLDatabase

Solicitação concluída com êxito.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • ItemNotFound - O item solicitado não foi encontrado.

Exemplos

Get a KQL database example

Solicitação de exemplo

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlDatabases/5b218778-e7a5-4d73-8187-f10824047715

Resposta de exemplo

Código de status:
200 
{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "properties": {
    "parentEventhouseItemId": "6a437a7c-1a28-4fd0-a362-11308b94c79b",
    "queryServiceUri": "https://trd-f7k1b2rzuqrjmb3wpd.z5.kusto.fabric.microsoft.com",
    "ingestionServiceUri": "https://ingest-trd-f7k1b2rzuqrjmb3wpd.z5.kusto.fabric.microsoft.com",
    "databaseType": "ReadWrite"
  }
}

Definições

Nome Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
ItemTag

Representa uma marca aplicada em um item.
ItemType

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

Um objeto de banco de dados KQL.
KQLDatabaseProperties

As propriedades do banco de dados KQL.
KqlDatabaseType

O tipo do banco de dados.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida 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.
message

string

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

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.
requestId

string

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

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

ItemTag

Objeto

Representa uma marca aplicada em um item.

Nome Tipo Description
displayName

string

O nome da marca.
id

string (uuid)

A ID da marca.

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 bloco de anotações.
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.

KQLDatabase

Objeto

Um objeto de banco de dados KQL.

Nome Tipo Description
description

string

A descrição do item.
displayName

string

O nome de exibição do item.
folderId

string (uuid)

A ID da pasta.
id

string (uuid)

A ID do item.
properties

KQLDatabaseProperties

As propriedades do banco de dados KQL.
tags

ItemTag[]

Lista de marcas aplicadas.
type

ItemType

O tipo de item.
workspaceId

string (uuid)

A ID do workspace.

KQLDatabaseProperties

Objeto

As propriedades do banco de dados KQL.

Nome Tipo Description
databaseType

KqlDatabaseType

O tipo do banco de dados.
ingestionServiceUri

string

URI do serviço de ingestão.
parentEventhouseItemId

string

ID da casa de eventos pai.
queryServiceUri

string

URI do serviço de consulta.

KqlDatabaseType

Enumeração

O tipo do banco de dados.

Valor Description
ReadWrite

Permite operações de leitura e gravação no banco de dados.
Shortcut

Um atalho é uma referência inserida que permite operações somente leitura em um banco de dados de origem. A origem pode estar nos mesmos locatários ou em locatários diferentes, seja em um cluster do Azure Data Explorer ou em um Fabric Eventhouse.