Partilhar via

Items - Get KQL Database

Serviço:
KQLDatabase
Versão 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 suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Suporte
Utilizador Sim
da entidade de serviço e identidades gerenciadas Sim

Interfaz

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

Parâmetros URI

Nome Em Necessário Tipo Descrição
kqlDatabaseId
 path True

string (uuid)

O ID do banco de dados KQL.
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.

Respostas

Nome Tipo Descrição
200 OK

KQLDatabase

Pedido concluído com sucesso.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

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

Exemplos

Get a KQL database example

Pedido 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 estado:
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 Descrição
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 tag aplicada em um item.
ItemType

O tipo do item. Tipos de itens 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

Objetivo

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Descrição
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Objetivo

A resposta de erro.

Nome Tipo Descrição
errorCode

string

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

string

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

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Objetivo

Os detalhes da resposta de erro.

Nome Tipo Descrição
errorCode

string

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

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

ItemTag

Objetivo

Representa uma tag aplicada em um item.

Nome Tipo Descrição
displayName

string

O nome da tag.
id

string (uuid)

O ID da tag.

ItemType

Enumeração

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

Valor Descrição
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 caderno.
SparkJobDefinition

Uma definição de trabalho de faísca.
MLExperiment

Uma experiência de aprendizagem automática.
MLModel

Um modelo de aprendizagem automática.
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

Uma API para o item GraphQL.
MountedDataFactory

Um MountedDataFactory.
SQLDatabase

Um SQLDatabase.
CopyJob

Um trabalho de cópia.
VariableLibrary

Uma VariableLibrary.
Dataflow

Um fluxo de dados.
ApacheAirflowJob

Um ApacheAirflowJob.
WarehouseSnapshot

Um instantâneo do Warehouse.
DigitalTwinBuilder

Um DigitalTwinBuilder.
DigitalTwinBuilderFlow

Um fluxo de construtor de gêmeos digitais.
MirroredAzureDatabricksCatalog

Um catálogo de databricks azure espelhado.
Map

Um mapa.
AnomalyDetector

Um detetor de anomalias.
UserDataFunction

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

Um GraphModel.
GraphQuerySet

Um Graph QuerySet.
SnowflakeDatabase

Uma base de dados Snowflake para armazenar tabelas Iceberg criadas a partir da conta Snowflake.
OperationsAgent

Um Agente de Operações.
CosmosDBDatabase

Uma base de dados Cosmos DB.
Ontology

Uma ontologia.
EventSchemaSet

Um EventoSchemaSet.

KQLDatabase

Objetivo

Um objeto de banco de dados KQL.

Nome Tipo Descrição
description

string

A descrição do item.
displayName

string

O nome de exibição do item.
folderId

string (uuid)

O ID da pasta.
id

string (uuid)

O ID do item.
properties

KQLDatabaseProperties

As propriedades do banco de dados KQL.
tags

ItemTag[]

Lista de tags aplicadas.
type

ItemType

O tipo de item.
workspaceId

string (uuid)

O ID do espaço de trabalho.

KQLDatabaseProperties

Objetivo

As propriedades do banco de dados KQL.

Nome Tipo Descrição
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 Descrição
ReadWrite

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

Um atalho é uma referência incorporada 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, em um cluster do Azure Data Explorer ou em uma Fabric Eventhouse.