Partilhar via

Items - Create KQL Database

  • Referência
Serviço:
KQLDatabase
Versão da API:
v1

Cria um banco de dados KQL no espaço de trabalho especificado.
Esta API suporta operações de longa duração (LRO).

Permissões

O chamador deve ter função de colaborador ou superior do espaço de trabalho.

Escopos delegados necessários

KQLDatabase.ReadWrite.All ou Item.ReadWrite.All

Limitações

  • Para criar um banco de dados KQL, o espaço de trabalho deve estar em uma capacidade de malha suportada. Para obter mais informações, consulte: Tipos de licença do Microsoft Fabric.

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

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

Parâmetros do URI

Name Em Necessário Tipo Description
workspaceId
 path True

string

uuid

O ID do espaço de trabalho.

Corpo do Pedido

Name Necessá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, pontos e hífenes. Não há suporte para caracteres especiais.
creationPayload KQLDatabaseCreationPayload:

A carga útil de criação do banco de dados KQL. Use definition ou creationPayload. Não é possível usar os dois ao mesmo tempo.
definition

KQLDatabaseDefinition

A definição pública do banco de dados KQL. Use creationPayload ou definition. Não é possível usar os dois ao mesmo tempo.
description

string

A descrição do banco de dados KQL. O comprimento máximo é de 256 caracteres.

Respostas

Name Tipo Description
201 Created

KQLDatabase

Criado com sucesso
202 Accepted

Solicitação aceita, provisionamento do 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á é usado

  • CorruptedPayload - A carga fornecida está corrompida.

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

Pedido de amostra

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 da amostra

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

Pedido de amostra

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 da amostra

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

Pedido de amostra

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 da amostra

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

Pedido de amostra

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 da amostra

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

Pedido de amostra

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 da amostra

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

Name Description
CreateKQLDatabaseRequest

Crie carga útil 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.
ItemType

O tipo do item. Tipos de itens 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 de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.
ReadWriteDatabaseCreationPayload

Carga útil de criação de item de banco de dados ReadWrite KQL
ShortcutDatabaseCreationPayload

Atalho de carga útil de criação de item de banco de dados KQL

CreateKQLDatabaseRequest

Object

Crie carga útil de solicitação de banco de dados KQL.

Name Tipo Description
creationPayload KQLDatabaseCreationPayload:

A carga útil de criação do banco de dados KQL. Use definition ou creationPayload. Não é possível usar os dois ao mesmo tempo.
definition

KQLDatabaseDefinition

A definição pública do banco de dados KQL. Use creationPayload ou definition. Não é possível usar os dois 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, pontos e hífenes. Não há suporte para caracteres especiais.

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.

KQLDatabaseDefinition

Object

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

Name Tipo Description
format

string

O formato da definição do item.
parts

KQLDatabaseDefinitionPart[]

Uma lista de partes de definição.

KQLDatabaseDefinitionPart

Object

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

Name Tipo Description
path

string

O caminho da parte do banco de dados KQL.
payload

string

A carga útil parcial do banco de dados KQL.
payloadType

PayloadType

O tipo de carga útil.

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.

PayloadType

Enumeração

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

Valor Description
InlineBase64

Base em linha 64.

ReadWriteDatabaseCreationPayload

Object

Carga útil de criação de item de banco de dados ReadWrite KQL

Name Tipo Description
databaseType string:

ReadWrite

O tipo de banco de dados KQL
parentEventhouseItemId

string

uuid

ID do item da casa de eventos pai.

ShortcutDatabaseCreationPayload

Object

Atalho de carga útil de criação de item de banco de dados KQL

Name Tipo Description
databaseType string:

Shortcut

O tipo de 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 da Casa de Eventos de origem ou do cluster do Azure Data Explorer
sourceDatabaseName

string

O nome do banco de dados a ser seguido na Casa de Eventos de origem ou no cluster do Azure Data Explorer.