Items - Create KQL Database

Servicio:: KQLDatabase

Versión de la API:: v1

Crea una base de datos KQL en el área de trabajo especificada.
Esta API admite operaciones de larga duración (LRO).

Permisos

El autor de la llamada debe tener un rol de área de trabajo colaborador .

Ámbitos delegados necesarios

KQLDatabase.ReadWrite.All o Item.ReadWrite.All

Limitaciones

Para crear una base de datos KQL, el área de trabajo debe estar en una capacidad de Fabric compatible. Para obtener más información, consulte: tipos de licencia de Microsoft Fabric.

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

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string (uuid)	Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
displayName	True	string	Nombre para mostrar de la base de datos KQL. El nombre de la base de datos puede contener caracteres alfanuméricos, caracteres de subrayado, puntos y guiones. No se admiten caracteres especiales.
creationPayload		KQLDatabaseCreationPayload: ShortcutDatabaseCreationPayload ReadWriteDatabaseCreationPayload	Carga de creación de la base de datos KQL. Use `definition` o `creationPayload`. No puede usar ambos al mismo tiempo.
definition		KQLDatabaseDefinition	Definición pública de la base de datos KQL. Use `creationPayload` o `definition`. No puede usar ambos al mismo tiempo.
description		string	Descripción de la base de datos KQL. La longitud máxima es de 256 caracteres.
folderId		string (uuid)	Identificador de carpeta. Si no se especifica o null, la base de datos KQL se crea con el área de trabajo como carpeta.

Respuestas

Nombre	Tipo	Description
201 Created	KQLDatabase	Creado correctamente
202 Accepted		Solicitud aceptada, aprovisionamiento de bases de datos KQL en curso Encabezados Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: InvalidItemType: el tipo de elemento no es válido ItemDisplayNameAlreadyInUse: ya se usa el nombre para mostrar del elemento CorruptedPayload: la carga proporcionada está dañada. WorkspaceItemsLimitExceeded: se superó el límite de elementos del área de trabajo.

Nombre

Tipo

Description

201 Created

KQLDatabase

Creado correctamente

202 Accepted

Solicitud aceptada, aprovisionamiento de bases de datos KQL en curso

Encabezados

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

InvalidItemType: el tipo de elemento no es válido
ItemDisplayNameAlreadyInUse: ya se usa el nombre para mostrar del elemento
CorruptedPayload: la carga proporcionada está dañada.
WorkspaceItemsLimitExceeded: se superó el límite de elementos del área de trabajo.

Ejemplos

Create a ReadWrite KQL database example

Create a ReadWrite KQL database with definition example

Create a Shortcut KQL database to source Azure Data Explorer cluster example

Create a Shortcut KQL database to source Azure Data Explorer cluster with invitation token example

Create a Shortcut KQL database to source KQL database example

Create a ReadWrite KQL database example

Solicitud de ejemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlDatabases

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "creationPayload": {
    "databaseType": "ReadWrite",
    "parentEventhouseItemId": "5b218778-e7a5-4d73-8187-f10824047836"
  }
}

Respuesta de muestra

status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a ReadWrite KQL database with definition example

Solicitud de ejemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlDatabases

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "definition": {
    "parts": [
      {
        "path": "DatabaseProperties.json",
        "payload": "ewogICJkYXRhYmFzZVR5cGUiOiAiUmVhZFdyaXRlIiwKICAicGFyZW50RXZlbnRob3VzZUl0ZW1JZCI6ICI1YjIxODc3OC1lN2E1LTRkNzMtODE4Ny1mMTA4MjQwNDc4MzYiLAogICJvbmVMYWtlQ2FjaGluZ1BlcmlvZCI6ICJQMzY1MDBEIiwKICAib25lTGFrZVN0YW5kYXJkU3RvcmFnZVBlcmlvZCI6ICJQMzY1MDBEIgp9",
        "payloadType": "InlineBase64"
      },
      {
        "path": "DatabaseSchema.kql",
        "payload": "Ly8gS1FMIHNjcmlwdAovLyBVc2UgbWFuYWdlbWVudCBjb21tYW5kcyBpbiB0aGlzIHNjcmlwdCB0byBjb25maWd1cmUgeW91ciBkYXRhYmFzZSBpdGVtcywgc3VjaCBhcyB0YWJsZXMsIGZ1bmN0aW9ucywgbWF0ZXJpYWxpemVkIHZpZXdzLCBhbmQgbW9yZS4KCi5jcmVhdGUtbWVyZ2UgdGFibGUgTXlMb2dzIChMZXZlbDpzdHJpbmcsIFRpbWVzdGFtcDpkYXRldGltZSwgVXNlcklkOnN0cmluZywgVHJhY2VJZDpzdHJpbmcsIE1lc3NhZ2U6c3RyaW5nLCBQcm9jZXNzSWQ6aW50KQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Respuesta de muestra

status code:: 201

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047651"
}

status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a Shortcut KQL database to source Azure Data Explorer cluster example

Solicitud de ejemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlDatabases

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "creationPayload": {
    "databaseType": "Shortcut",
    "parentEventhouseItemId": "5b218778-e7a5-4d73-8187-f10824047836",
    "sourceClusterUri": "https://adxcluster.westus.kusto.windows.net",
    "sourceDatabaseName": "MyDatabase"
  }
}

Respuesta de muestra

status code:: 201

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047653"
}

status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a Shortcut KQL database to source Azure Data Explorer cluster with invitation token example

Solicitud de ejemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlDatabases

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "creationPayload": {
    "databaseType": "Shortcut",
    "parentEventhouseItemId": "5b218778-e7a5-4d73-8187-f10824047836",
    "invitationToken": "eyJ0eXAiOiJKVInvitationToken"
  }
}

Respuesta de muestra

status code:: 201

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047654"
}

status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a Shortcut KQL database to source KQL database example

Solicitud de ejemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlDatabases

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "creationPayload": {
    "databaseType": "Shortcut",
    "parentEventhouseItemId": "5b218778-e7a5-4d73-8187-f10824047836",
    "sourceDatabaseName": "ac542109-abd1-4ee3-aec5-86282c01ee24"
  }
}

Respuesta de muestra

status code:: 201

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047652"
}

status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definiciones

Nombre	Description
CreateKQLDatabaseRequest	Cree una carga de solicitud de base de datos KQL.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
ItemTag	Representa una etiqueta aplicada en un elemento.
ItemType	Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
KQLDatabase	Objeto de base de datos KQL.
KQLDatabaseDefinition	Objeto de definición pública de base de datos KQL.
KQLDatabaseDefinitionPart	Objeto de elemento de definición de base de datos KQL.
KQLDatabaseProperties	Propiedades de la base de datos KQL.
KqlDatabaseType	Tipo de la base de datos.
PayloadType	Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.
ReadWriteDatabaseCreationPayload	Carga de creación de elementos de base de datos KQL de ReadWrite
ShortcutDatabaseCreationPayload	Carga de creación de elementos de base de datos KQL de acceso directo

CreateKQLDatabaseRequest

Objeto

Cree una carga de solicitud de base de datos KQL.

Nombre	Tipo	Description
creationPayload	KQLDatabaseCreationPayload: ReadWriteDatabaseCreationPayload ShortcutDatabaseCreationPayload	Carga de creación de la base de datos KQL. Use `definition` o `creationPayload`. No puede usar ambos al mismo tiempo.
definition	KQLDatabaseDefinition	Definición pública de la base de datos KQL. Use `creationPayload` o `definition`. No puede usar ambos al mismo tiempo.
description	string	Descripción de la base de datos KQL. La longitud máxima es de 256 caracteres.
displayName	string	Nombre para mostrar de la base de datos KQL. El nombre de la base de datos puede contener caracteres alfanuméricos, caracteres de subrayado, puntos y guiones. No se admiten caracteres especiales.
folderId	string (uuid)	Identificador de carpeta. Si no se especifica o null, la base de datos KQL se crea con el área de trabajo como carpeta.

ErrorRelatedResource

Objeto

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

Objeto

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

Objeto

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.

ItemTag

Objeto

Representa una etiqueta aplicada en un elemento.

Nombre	Tipo	Description
displayName	string	Nombre de la etiqueta.
id	string (uuid)	Identificador de etiqueta.

ItemType

Enumeración

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

Valor	Description
Dashboard	Panel de PowerBI.
Report	Informe de PowerBI.
SemanticModel	Modelo semántico de PowerBI.
PaginatedReport	Informe paginado de PowerBI.
Datamart	Datamart de PowerBI.
Lakehouse	Una casa de lago.
Eventhouse	Un centro de eventos.
Environment	Un entorno.
KQLDatabase	Una base de datos KQL.
KQLQueryset	Un conjunto de consultas KQL.
KQLDashboard	Un panel de KQL.
DataPipeline	Una canalización de datos.
Notebook	Un cuaderno.
SparkJobDefinition	Una definición de trabajo de Spark.
MLExperiment	Un experimento de aprendizaje automático.
MLModel	Un modelo de aprendizaje automático.
Warehouse	Un almacén.
Eventstream	Una secuencia de eventos.
SQLEndpoint	Un punto de conexión de SQL.
MirroredWarehouse	Un almacén reflejado.
MirroredDatabase	Una base de datos reflejada.
Reflex	Un reflejo.
GraphQLApi	Una API para el elemento GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Un trabajo de copia.
VariableLibrary	A VariableLibrary.
Dataflow	Flujo de datos.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Una instantánea de almacenamiento.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Un flujo de Digital Twin Builder.
MirroredAzureDatabricksCatalog	Un catálogo de Azure Databricks reflejado.
Map	Un mapa.
AnomalyDetector	An Anomaly Detector.
UserDataFunction	Una función de datos de usuario.
GraphModel	Un GraphModel.
GraphQuerySet	Un conjunto de consultas de Graph.
SnowflakeDatabase	Una base de datos de Snowflake para almacenar tablas de Cosmos creadas a partir de la cuenta de Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Una base de datos de Cosmos DB.
Ontology	Una ontología.
EventSchemaSet	An EventSchemaSet.

KQLDatabase

Objeto

Objeto de base de datos KQL.

Nombre	Tipo	Description
description	string	Descripción del elemento.
displayName	string	Nombre para mostrar del elemento.
folderId	string (uuid)	Identificador de carpeta.
id	string (uuid)	Identificador del elemento.
properties	KQLDatabaseProperties	Propiedades de la base de datos KQL.
tags	ItemTag[]	Lista de etiquetas aplicadas.
type	ItemType	Tipo de elemento.
workspaceId	string (uuid)	Identificador del área de trabajo.

KQLDatabaseDefinition

Objeto

Objeto de definición pública de base de datos KQL.

Nombre	Tipo	Description
format	string	Formato de la definición de elemento.
parts	KQLDatabaseDefinitionPart[]	Lista de elementos de definición.

KQLDatabaseDefinitionPart

Objeto

Objeto de elemento de definición de base de datos KQL.

Nombre	Tipo	Description
path	string	Ruta de acceso del elemento de base de datos KQL.
payload	string	Carga del elemento de base de datos KQL.
payloadType	PayloadType	Tipo de carga.

KQLDatabaseProperties

Objeto

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.

PayloadType

Enumeración

Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

Valor	Description
InlineBase64	Base 64 insertada.

ReadWriteDatabaseCreationPayload

Objeto

Carga de creación de elementos de base de datos KQL de ReadWrite

Nombre	Tipo	Description
databaseType	string: ReadWrite	Tipo de la base de datos KQL
parentEventhouseItemId	string (uuid)	Id. de elemento de la casa de eventos principal.

ShortcutDatabaseCreationPayload

Objeto

Carga de creación de elementos de base de datos KQL de acceso directo

Nombre	Tipo	Description
databaseType	string: Shortcut	Tipo de la base de datos KQL
invitationToken	string	Token de invitación para seguir la base de datos de origen
parentEventhouseItemId	string (uuid)	Id. de elemento de la casa de eventos principal.
sourceClusterUri	string	URI del centro de eventos de origen o del clúster de Azure Data Explorer
sourceDatabaseName	string	Nombre de la base de datos que se va a seguir en el centro de eventos de origen o en el clúster de Azure Data Explorer.

Compartir a través de

Items - Create KQL Database

Permisos

Ámbitos delegados necesarios

Limitaciones

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Create a ReadWrite KQL database example

Solicitud de ejemplo

Respuesta de muestra

Create a ReadWrite KQL database with definition example

Solicitud de ejemplo

Respuesta de muestra

Create a Shortcut KQL database to source Azure Data Explorer cluster example

Solicitud de ejemplo

Respuesta de muestra

Create a Shortcut KQL database to source Azure Data Explorer cluster with invitation token example

Solicitud de ejemplo

Respuesta de muestra

Create a Shortcut KQL database to source KQL database example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CreateKQLDatabaseRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

KQLDatabase

KQLDatabaseDefinition

KQLDatabaseDefinitionPart

KQLDatabaseProperties

KqlDatabaseType

PayloadType

ReadWriteDatabaseCreationPayload

ShortcutDatabaseCreationPayload