Поделиться через

Items - Create KQL Database

  • Ссылка
Служба:
KQLDatabase
Версия API:
v1

Создает базу данных KQL в указанной рабочей области.
Этот API поддерживает длительные операции (LRO).

Разрешения

Вызывающий объект должен иметь участника или более поздней роли рабочей области.

Обязательные делегированные области

KQLDatabase.ReadWrite.All или Item.ReadWrite.All

Ограничения

  • Чтобы создать базу данных KQL, рабочая область должна находиться в поддерживаемой емкости Fabric. Дополнительные сведения см. в статье типов лицензий Microsoft Fabric.

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает удостоверения Microsoft , перечисленные в этом разделе.

Тождество Поддержка
Пользователь Да
субъекта-службы и управляемых удостоверений Да

Интерфейс

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

Параметры URI

Имя В Обязательно Тип Описание
workspaceId
 path True

string

uuid

Идентификатор рабочей области.

Текст запроса

Имя Обязательно Тип Описание
displayName True

string

Отображаемое имя базы данных KQL. Имя базы данных может содержать буквенно-цифровые символы, символы подчеркивания, периоды и дефисы. Специальные символы не поддерживаются.
creationPayload KQLDatabaseCreationPayload:

Полезные данные создания базы данных KQL. Используйте definition или creationPayload. Вы не можете использовать оба одновременно.
definition

KQLDatabaseDefinition

Общедоступное определение базы данных KQL. Используйте creationPayload или definition. Вы не можете использовать оба одновременно.
description

string

Описание базы данных KQL. Максимальная длина — 256 символов.

Ответы

Имя Тип Описание
201 Created

KQLDatabase

Успешно создано
202 Accepted

Запрос принят, подготовка базы данных KQL выполняется

Заголовки

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • InvalidItemType — тип элемента недопустим

  • ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется

  • Поврежденный Payload — предоставленные полезные данные повреждены.

Примеры

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

Образец запроса

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

Пример ответа

Код состояния:
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

Образец запроса

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

Пример ответа

Код состояния:
201 
{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047651"
}
Код состояния:
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

Образец запроса

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

Пример ответа

Код состояния:
201 
{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047653"
}
Код состояния:
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

Образец запроса

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

Пример ответа

Код состояния:
201 
{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047654"
}
Код состояния:
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

Образец запроса

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

Пример ответа

Код состояния:
201 
{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047652"
}
Код состояния:
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

Определения

Имя Описание
CreateKQLDatabaseRequest

Создайте полезные данные запроса базы данных KQL.
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse

Ответ на ошибку.
ErrorResponseDetails

Сведения об ответе на ошибку.
ItemType

Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
KQLDatabase

Объект базы данных KQL.
KQLDatabaseDefinition

Объект открытого определения базы данных KQL.
KQLDatabaseDefinitionPart

Объект части определения базы данных KQL.
KQLDatabaseProperties

Свойства базы данных KQL.
KqlDatabaseType

Тип базы данных.
PayloadType

Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.
ReadWriteDatabaseCreationPayload

Полезные данные создания элемента базы данных ReadWrite KQL
ShortcutDatabaseCreationPayload

Полезные данные создания элемента базы данных KQL

CreateKQLDatabaseRequest

Object

Создайте полезные данные запроса базы данных KQL.

Имя Тип Описание
creationPayload KQLDatabaseCreationPayload:

Полезные данные создания базы данных KQL. Используйте definition или creationPayload. Вы не можете использовать оба одновременно.
definition

KQLDatabaseDefinition

Общедоступное определение базы данных KQL. Используйте creationPayload или definition. Вы не можете использовать оба одновременно.
description

string

Описание базы данных KQL. Максимальная длина — 256 символов.
displayName

string

Отображаемое имя базы данных KQL. Имя базы данных может содержать буквенно-цифровые символы, символы подчеркивания, периоды и дефисы. Специальные символы не поддерживаются.

ErrorRelatedResource

Object

Объект сведений об ошибках, связанных с ресурсом.

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

Ответ на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

Сведения об ответе на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.

ItemType

Перечисление

Тип элемента. С течением времени могут добавляться дополнительные типы элементов.

Значение Описание
Dashboard

Панель мониторинга PowerBI.
DataPipeline

Конвейер данных.
Datamart

Datamart PowerBI.
Environment

Среда.
Eventhouse

Хранилище событий.
Eventstream

Поток событий.
GraphQLApi

API для элемента GraphQL.
KQLDashboard

Панель мониторинга KQL.
KQLDatabase

База данных KQL.
KQLQueryset

Набор запросов KQL.
Lakehouse

Озеро.
MLExperiment

Эксперимент машинного обучения.
MLModel

Модель машинного обучения.
MirroredDatabase

Зеркальная база данных.
MirroredWarehouse

Зеркальный склад.
MountedDataFactory

ПодключеннаяdataFactory.
Notebook

Записная книжка.
PaginatedReport

Отчет с разбивкой на страницы PowerBI.
Reflex

Рефлекс.
Report

Отчет PowerBI.
SQLDatabase

База данных SQLDatabase.
SQLEndpoint

Конечная точка SQL.
SemanticModel

Семантическая модель PowerBI.
SparkJobDefinition

Определение задания Spark.
Warehouse

Склад.

KQLDatabase

Object

Объект базы данных KQL.

Имя Тип Описание
description

string

Описание элемента.
displayName

string

Отображаемое имя элемента.
id

string

uuid

Идентификатор элемента.
properties

KQLDatabaseProperties

Свойства базы данных KQL.
type

ItemType

Тип элемента.
workspaceId

string

uuid

Идентификатор рабочей области.

KQLDatabaseDefinition

Object

Объект открытого определения базы данных KQL.

Имя Тип Описание
format

string

Формат определения элемента.
parts

KQLDatabaseDefinitionPart[]

Список частей определения.

KQLDatabaseDefinitionPart

Object

Объект части определения базы данных KQL.

Имя Тип Описание
path

string

Путь к части базы данных KQL.
payload

string

Полезные данные части базы данных KQL.
payloadType

PayloadType

Тип полезных данных.

KQLDatabaseProperties

Object

Свойства базы данных KQL.

Имя Тип Описание
databaseType

KqlDatabaseType

Тип базы данных.
ingestionServiceUri

string

URI службы приема.
parentEventhouseItemId

string

Идентификатор родительского дома событий.
queryServiceUri

string

URI службы запросов.

KqlDatabaseType

Перечисление

Тип базы данных.

Значение Описание
ReadWrite

Разрешает операции чтения и записи в базе данных.
Shortcut

Ярлык — это внедренная ссылка, позволяющая выполнять только операции чтения в исходной базе данных. Источник может находиться в одном или разных клиентах в кластере Azure Data Explorer или в хранилище событий Fabric.

PayloadType

Перечисление

Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

Значение Описание
InlineBase64

Встроенная база 64.

ReadWriteDatabaseCreationPayload

Object

Полезные данные создания элемента базы данных ReadWrite KQL

Имя Тип Описание
databaseType string:

ReadWrite

Тип базы данных KQL
parentEventhouseItemId

string

uuid

Идентификатор элемента родительского хранилища событий.

ShortcutDatabaseCreationPayload

Object

Полезные данные создания элемента базы данных KQL

Имя Тип Описание
databaseType string:

Shortcut

Тип базы данных KQL
invitationToken

string

Маркер приглашения для выполнения исходной базы данных
parentEventhouseItemId

string

uuid

Идентификатор элемента родительского хранилища событий.
sourceClusterUri

string

Универсальный код ресурса (URI) исходного хранилища событий или кластера Azure Data Explorer
sourceDatabaseName

string

Имя базы данных, необходимой для выполнения в исходном хранилище событий или кластере Azure Data Explorer.