Compartir a través de

Items - Get KQL Database

  • Referencia
Servicio:
KQLDatabase
Versión de la API:
v1

Devuelve las propiedades de la base de datos KQL especificada.

Permisos

El autor de la llamada debe tener rol de área de trabajo o superior del visor.

Ámbitos delegados necesarios

KQLDatabase.Read.All o KQLDatabase.ReadWrite.All o Item.Read.All o Item.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identidad Apoyo
Usuario Sí
de entidad de servicio y identidades administradas Sí

Interfaz

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
kqlDatabaseId
 path True

string

uuid

Identificador de base de datos KQL.
workspaceId
 path True

string

uuid

Identificador del área de trabajo.

Respuestas

Nombre Tipo Description
200 OK

KQLDatabase

Solicitud completada correctamente.
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • ItemNotFound: no se encontró el elemento solicitado.

Ejemplos

Get a KQL database example

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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"
  }
}

Definiciones

Nombre Description
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
ItemType

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
KQLDatabase

Objeto de base de datos KQL.
KQLDatabaseProperties

Propiedades de la base de datos KQL.
KqlDatabaseType

Tipo de la base de datos.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre Tipo Description
resourceId

string

Identificador de recurso implicado en el error.
resourceType

string

Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

ItemType

Enumeración

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.

Valor Description
Dashboard

Panel de PowerBI.
DataPipeline

Una canalización de datos.
Datamart

Datamart de PowerBI.
Environment

Un entorno.
Eventhouse

Un centro de eventos.
Eventstream

Una secuencia de eventos.
GraphQLApi

Una API para el elemento GraphQL.
KQLDashboard

Un panel de KQL.
KQLDatabase

Una base de datos KQL.
KQLQueryset

Un conjunto de consultas KQL.
Lakehouse

Una casa de lago.
MLExperiment

Un experimento de aprendizaje automático.
MLModel

Un modelo de aprendizaje automático.
MirroredDatabase

Una base de datos reflejada.
MirroredWarehouse

Un almacén reflejado.
MountedDataFactory

A MountedDataFactory.
Notebook

Un cuaderno.
PaginatedReport

Informe paginado de PowerBI.
Reflex

Un reflejo.
Report

Informe de PowerBI.
SQLDatabase

A SQLDatabase.
SQLEndpoint

Un punto de conexión de SQL.
SemanticModel

Modelo semántico de PowerBI.
SparkJobDefinition

Una definición de trabajo de Spark.
Warehouse

Un almacén.

KQLDatabase

Object

Objeto de base de datos KQL.

Nombre Tipo Description
description

string

Descripción del elemento.
displayName

string

Nombre para mostrar del elemento.
id

string

uuid

Identificador del elemento.
properties

KQLDatabaseProperties

Propiedades de la base de datos KQL.
type

ItemType

Tipo de elemento.
workspaceId

string

uuid

Identificador del área de trabajo.

KQLDatabaseProperties

Object

Propiedades de la base de datos KQL.

Nombre Tipo Description
databaseType

KqlDatabaseType

Tipo de la base de datos.
ingestionServiceUri

string

URI del servicio de ingesta.
parentEventhouseItemId

string

Id. de la casa de eventos principal.
queryServiceUri

string

URI del servicio de consulta.

KqlDatabaseType

Enumeración

Tipo de la base de datos.

Valor Description
ReadWrite

Permite operaciones de lectura y escritura en la base de datos.
Shortcut

Un acceso directo es una referencia incrustada que permite operaciones de solo lectura en una base de datos de origen. El origen puede estar en los mismos inquilinos o diferentes, ya sea en un clúster de Azure Data Explorer o en un centro de eventos de Fabric.