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 visualizador ou superior função de espaço de trabalho.

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

Interface

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
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

Name	Tipo	Description
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 amostra

HTTP

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

Resposta da amostra

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

Name	Description
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
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

Object

O objeto de detalhes do recurso relacionado ao erro.

Name	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name	Tipo	Description
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

Object

Os detalhes da resposta de erro.

Name	Tipo	Description
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.

ItemType

Enumeração

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

Valor	Description
Dashboard	Painel do PowerBI.
DataPipeline	Um pipeline de dados.
Datamart	Datamart do PowerBI.
Environment	Um ambiente.
Eventhouse	Uma casa de eventos.
Eventstream	Um fluxo de eventos.
GraphQLApi	Uma API para o item GraphQL.
KQLDashboard	Um painel KQL.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
Lakehouse	Uma casa no lago.
MLExperiment	Uma experiência de aprendizagem automática.
MLModel	Um modelo de aprendizagem automática.
MirroredDatabase	Um banco de dados espelhado.
MirroredWarehouse	Um armazém espelhado.
MountedDataFactory	Um MountedDataFactory.
Notebook	Um caderno.
PaginatedReport	Relatório paginado do PowerBI.
Reflex	Um reflexo.
Report	Relatório do PowerBI.
SQLDatabase	Um SQLDatabase.
SQLEndpoint	Um ponto de extremidade SQL.
SemanticModel	Modelo semântico do PowerBI.
SparkJobDefinition	Uma definição de trabalho de faísca.
Warehouse	Um armazém.

KQLDatabase

Object

Um objeto de banco de dados KQL.

Name	Tipo	Description
description	string	A descrição do item.
displayName	string	O nome de exibição do item.
id	string uuid	O ID do item.
properties	KQLDatabaseProperties	As propriedades do banco de dados KQL.
type	ItemType	O tipo de item.
workspaceId	string uuid	O ID do espaço de trabalho.

KQLDatabaseProperties

Object

As propriedades do banco de dados KQL.

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