Bagikan melalui

Items - Create KQL Database

  • Referensi
Layanan:
KQLDatabase
Versi API:
v1

Membuat database KQL di ruang kerja yang ditentukan.
API ini mendukung operasi jangka panjang (LRO).

Izin

Pemanggil harus memiliki kontributor atau peran ruang kerja yang lebih tinggi.

Cakupan yang Didelegasikan yang Diperlukan

KQLDatabase.ReadWrite.All atau Item.ReadWrite.All

Keterbatasan

  • Untuk membuat database KQL, ruang kerja harus berada pada kapasitas Fabric yang didukung. Untuk informasi selengkapnya, lihat: jenis lisensi Microsoft Fabric.

Identitas yang didukung Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas Dukung
Pengguna Ya
perwakilan Layanan dan identitas terkelola Ya

Antarmuka

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
workspaceId
 path True

string

uuid

ID ruang kerja.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
displayName True

string

Nama tampilan database KQL. Nama database dapat berisi karakter alfanumerik, garis bawah, titik, dan tanda hubung. Karakter khusus tidak didukung.
creationPayload KQLDatabaseCreationPayload:

Payload pembuatan database KQL. Gunakan definition atau creationPayload. Anda tidak dapat menggunakan keduanya secara bersamaan.
definition

KQLDatabaseDefinition

Definisi publik database KQL. Gunakan creationPayload atau definition. Anda tidak dapat menggunakan keduanya secara bersamaan.
description

string

Deskripsi database KQL. Panjang maksimum adalah 256 karakter.

Respons

Nama Jenis Deskripsi
201 Created

KQLDatabase

Berhasil dibuat
202 Accepted

Permintaan diterima, provisi database KQL sedang berlangsung

Header

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

ErrorResponse

Kode kesalahan umum:

  • InvalidItemType - Tipe item tidak valid

  • ItemDisplayNameAlreadyInUse - Nama tampilan item sudah digunakan

  • CorruptedPayload - Payload yang disediakan rusak.

Contoh

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

Permintaan sampel

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

Respon sampel

Kode 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

Permintaan sampel

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

Respon sampel

Kode status:
201 
{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047651"
}
Kode 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

Permintaan sampel

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

Respon sampel

Kode status:
201 
{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047653"
}
Kode 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

Permintaan sampel

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

Respon sampel

Kode status:
201 
{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047654"
}
Kode 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

Permintaan sampel

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

Respon sampel

Kode status:
201 
{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047652"
}
Kode 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

Definisi

Nama Deskripsi
CreateKQLDatabaseRequest

Buat payload permintaan database KQL.
ErrorRelatedResource

Objek detail sumber daya terkait kesalahan.
ErrorResponse

Respons kesalahan.
ErrorResponseDetails

Detail respons kesalahan.
ItemType

Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.
KQLDatabase

Objek database KQL.
KQLDatabaseDefinition

Objek definisi publik database KQL.
KQLDatabaseDefinitionPart

Objek bagian definisi database KQL.
KQLDatabaseProperties

Properti database KQL.
KqlDatabaseType

Jenis database.
PayloadType

Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.
ReadWriteDatabaseCreationPayload

Payload pembuatan item database ReadWrite KQL
ShortcutDatabaseCreationPayload

Payload pembuatan item database KQL pintasan

CreateKQLDatabaseRequest

Objek

Buat payload permintaan database KQL.

Nama Jenis Deskripsi
creationPayload KQLDatabaseCreationPayload:

Payload pembuatan database KQL. Gunakan definition atau creationPayload. Anda tidak dapat menggunakan keduanya secara bersamaan.
definition

KQLDatabaseDefinition

Definisi publik database KQL. Gunakan creationPayload atau definition. Anda tidak dapat menggunakan keduanya secara bersamaan.
description

string

Deskripsi database KQL. Panjang maksimum adalah 256 karakter.
displayName

string

Nama tampilan database KQL. Nama database dapat berisi karakter alfanumerik, garis bawah, titik, dan tanda hubung. Karakter khusus tidak didukung.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama Jenis Deskripsi
resourceId

string

ID sumber daya yang terlibat dalam kesalahan.
resourceType

string

Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama Jenis Deskripsi
errorCode

string

Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message

string

Representasi kesalahan yang dapat dibaca manusia.
moreDetails

ErrorResponseDetails[]

Daftar detail kesalahan tambahan.
relatedResource

ErrorRelatedResource

Detail sumber daya terkait kesalahan.
requestId

string

ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama Jenis Deskripsi
errorCode

string

Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message

string

Representasi kesalahan yang dapat dibaca manusia.
relatedResource

ErrorRelatedResource

Detail sumber daya terkait kesalahan.

ItemType

Enumeration

Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.

Nilai Deskripsi
Dashboard

Dasbor PowerBI.
DataPipeline

Alur data.
Datamart

Datamart PowerBI.
Environment

Lingkungan.
Eventhouse

Sebuah rumah acara.
Eventstream

Eventstream.
GraphQLApi

API untuk item GraphQL.
KQLDashboard

Dasbor KQL.
KQLDatabase

Database KQL.
KQLQueryset

Set kueri KQL.
Lakehouse

Sebuah lakehouse.
MLExperiment

Eksperimen pembelajaran mesin.
MLModel

Model pembelajaran mesin.
MirroredDatabase

Database cermin.
MirroredWarehouse

Sebuah gudang cermin.
MountedDataFactory

A MountedDataFactory.
Notebook

Buku catatan.
PaginatedReport

Laporan paginasi PowerBI.
Reflex

Sebuah Refleks.
Report

Laporan PowerBI.
SQLDatabase

Sebuah SQLDatabase.
SQLEndpoint

Titik akhir SQL.
SemanticModel

Model semantik PowerBI.
SparkJobDefinition

Definisi pekerjaan spark.
Warehouse

Sebuah gudang.

KQLDatabase

Objek

Objek database KQL.

Nama Jenis Deskripsi
description

string

Deskripsi item.
displayName

string

Nama tampilan item.
id

string

uuid

ID item.
properties

KQLDatabaseProperties

Properti database KQL.
type

ItemType

Jenis item.
workspaceId

string

uuid

ID ruang kerja.

KQLDatabaseDefinition

Objek

Objek definisi publik database KQL.

Nama Jenis Deskripsi
format

string

Format definisi item.
parts

KQLDatabaseDefinitionPart[]

Daftar bagian definisi.

KQLDatabaseDefinitionPart

Objek

Objek bagian definisi database KQL.

Nama Jenis Deskripsi
path

string

Jalur bagian database KQL.
payload

string

Payload bagian database KQL.
payloadType

PayloadType

Jenis payload.

KQLDatabaseProperties

Objek

Properti database KQL.

Nama Jenis Deskripsi
databaseType

KqlDatabaseType

Jenis database.
ingestionServiceUri

string

URI layanan penyerapan.
parentEventhouseItemId

string

ID eventhouse induk.
queryServiceUri

string

URI layanan kueri.

KqlDatabaseType

Enumeration

Jenis database.

Nilai Deskripsi
ReadWrite

Memungkinkan operasi baca dan tulis pada database.
Shortcut

Pintasan adalah referensi tersemat yang memungkinkan operasi baca saja pada database sumber. Sumbernya dapat berada di penyewa yang sama atau berbeda, baik di kluster Azure Data Explorer atau Fabric Eventhouse.

PayloadType

Enumeration

Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.

Nilai Deskripsi
InlineBase64

Dasar Sebaris 64.

ReadWriteDatabaseCreationPayload

Objek

Payload pembuatan item database ReadWrite KQL

Nama Jenis Deskripsi
databaseType string:

ReadWrite

Jenis database KQL
parentEventhouseItemId

string

uuid

ID item eventhouse induk.

ShortcutDatabaseCreationPayload

Objek

Payload pembuatan item database KQL pintasan

Nama Jenis Deskripsi
databaseType string:

Shortcut

Jenis database KQL
invitationToken

string

Token undangan untuk mengikuti database sumber
parentEventhouseItemId

string

uuid

ID item eventhouse induk.
sourceClusterUri

string

URI sumber kluster Eventhouse atau Azure Data Explorer
sourceDatabaseName

string

Nama database yang harus diikuti di kluster Eventhouse atau Azure Data Explorer sumber.