Items - Create KQL Database

Serviço:: KQLDatabase

Versão da API:: v1

Cria um banco de dados KQL no workspace especificado.
Essa API dá suporte a LRO (operações de execução longa).

Permissões

O chamador deve ter uma função de workspace de colaborador .

Escopos delegados necessários

KQLDatabase.ReadWrite.All ou Item.ReadWrite.All

Limitações

Para criar um banco de dados KQL, o workspace deve estar em uma capacidade do Fabric com suporte. Para obter mais informações, consulte: tipos de licença do Microsoft Fabric.

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

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	A ID do workspace.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
displayName	True	string	O nome de exibição do banco de dados KQL. O nome do banco de dados pode conter caracteres alfanuméricos, sublinhados, períodos e hifens. Não há suporte para caracteres especiais.
creationPayload		KQLDatabaseCreationPayload: ShortcutDatabaseCreationPayload ReadWriteDatabaseCreationPayload	O conteúdo de criação do banco de dados KQL. Use `definition` ou `creationPayload`. Você não pode usar ambos ao mesmo tempo.
definition		KQLDatabaseDefinition	A definição pública do banco de dados KQL. Use `creationPayload` ou `definition`. Você não pode usar ambos ao mesmo tempo.
description		string	A descrição do banco de dados KQL. O comprimento máximo é de 256 caracteres.
folderId		string (uuid)	A ID da pasta. Se não for especificado ou nulo, o banco de dados KQL será criado com o workspace como sua pasta.

Respostas

Nome	Tipo	Description
201 Created	KQLDatabase	Criado com êxito
202 Accepted		Solicitação aceita, provisionamento de banco de dados KQL em andamento Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: InvalidItemType – O tipo de item é inválido ItemDisplayNameAlreadyInUse – O nome de exibição do item já está sendo usado CorruptedPayload – O conteúdo fornecido está corrompido. WorkspaceItemsLimitExceeded - Limite de itens do workspace excedido.

Nome

Tipo

Description

201 Created

KQLDatabase

Criado com êxito

202 Accepted

Solicitação aceita, provisionamento de banco de dados KQL em andamento

Cabeçalhos

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

Other Status Codes

ErrorResponse

Códigos de erro comuns:

InvalidItemType – O tipo de item é inválido
ItemDisplayNameAlreadyInUse – O nome de exibição do item já está sendo usado
CorruptedPayload – O conteúdo fornecido está corrompido.
WorkspaceItemsLimitExceeded - Limite de itens do workspace excedido.

Exemplos

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

Solicitação de exemplo

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"
  }
}

Resposta de exemplo

Código de status:: 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

Solicitação de exemplo

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"
      }
    ]
  }
}

Resposta de exemplo

Código de status:: 201

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

Código de status:: 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

Solicitação de exemplo

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"
  }
}

Resposta de exemplo

Código de status:: 201

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

Código de status:: 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

Solicitação de exemplo

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"
  }
}

Resposta de exemplo

Código de status:: 201

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

Código de status:: 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

Solicitação de exemplo

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"
  }
}

Resposta de exemplo

Código de status:: 201

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

Código de status:: 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

Definições

Nome	Description
CreateKQLDatabaseRequest	Criar conteúdo de solicitação de banco de dados KQL.
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.
KQLDatabaseDefinition	Objeto de definição pública do banco de dados KQL.
KQLDatabaseDefinitionPart	Objeto de parte de definição de banco de dados KQL.
KQLDatabaseProperties	As propriedades do banco de dados KQL.
KqlDatabaseType	O tipo do banco de dados.
PayloadType	O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.
ReadWriteDatabaseCreationPayload	Conteúdo de criação de item de banco de dados KQL readWrite
ShortcutDatabaseCreationPayload	Conteúdo de criação de item de banco de dados KQL de atalho

CreateKQLDatabaseRequest

Objeto

Criar conteúdo de solicitação de banco de dados KQL.

Nome	Tipo	Description
creationPayload	KQLDatabaseCreationPayload: ReadWriteDatabaseCreationPayload ShortcutDatabaseCreationPayload	O conteúdo de criação do banco de dados KQL. Use `definition` ou `creationPayload`. Você não pode usar ambos ao mesmo tempo.
definition	KQLDatabaseDefinition	A definição pública do banco de dados KQL. Use `creationPayload` ou `definition`. Você não pode usar ambos ao mesmo tempo.
description	string	A descrição do banco de dados KQL. O comprimento máximo é de 256 caracteres.
displayName	string	O nome de exibição do banco de dados KQL. O nome do banco de dados pode conter caracteres alfanuméricos, sublinhados, períodos e hifens. Não há suporte para caracteres especiais.
folderId	string (uuid)	A ID da pasta. Se não for especificado ou nulo, o banco de dados KQL será criado com o workspace como sua pasta.

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.

KQLDatabaseDefinition

Objeto

Objeto de definição pública do banco de dados KQL.

Nome	Tipo	Description
format	string	O formato da definição do item.
parts	KQLDatabaseDefinitionPart[]	Uma lista de partes de definição.

KQLDatabaseDefinitionPart

Objeto

Objeto de parte de definição de banco de dados KQL.

Nome	Tipo	Description
path	string	O caminho da parte do banco de dados KQL.
payload	string	O conteúdo da parte do banco de dados KQL.
payloadType	PayloadType	O tipo de conteúdo.

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.

PayloadType

Enumeração

O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

Valor	Description
InlineBase64	Base 64 embutida.

ReadWriteDatabaseCreationPayload

Objeto

Conteúdo de criação de item de banco de dados KQL readWrite

Nome	Tipo	Description
databaseType	string: ReadWrite	O tipo do banco de dados KQL
parentEventhouseItemId	string (uuid)	ID do item da casa de eventos pai.

ShortcutDatabaseCreationPayload

Objeto

Conteúdo de criação de item de banco de dados KQL de atalho

Nome	Tipo	Description
databaseType	string: Shortcut	O tipo do banco de dados KQL
invitationToken	string	Token de convite para seguir o banco de dados de origem
parentEventhouseItemId	string (uuid)	ID do item da casa de eventos pai.
sourceClusterUri	string	O URI do cluster do Eventhouse ou do Azure Data Explorer de origem
sourceDatabaseName	string	O nome do banco de dados a seguir no cluster do Eventhouse ou do Azure Data Explorer de origem.

Compartilhar via

Items - Create KQL Database

Permissões

Escopos delegados necessários

Limitações

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Create a ReadWrite KQL database example

Solicitação de exemplo

Resposta de exemplo

Create a ReadWrite KQL database with definition example

Solicitação de exemplo

Resposta de exemplo

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

Solicitação de exemplo

Resposta de exemplo

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

Solicitação de exemplo

Resposta de exemplo

Create a Shortcut KQL database to source KQL database example

Solicitação de exemplo

Resposta de exemplo

Definições

CreateKQLDatabaseRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

KQLDatabase

KQLDatabaseDefinition

KQLDatabaseDefinitionPart

KQLDatabaseProperties

KqlDatabaseType

PayloadType

ReadWriteDatabaseCreationPayload

ShortcutDatabaseCreationPayload