次の方法で共有

Items - Create KQL Database

  • リファレンス
サービス:
KQLDatabase
API バージョン:
v1

指定したワークスペースに KQL データベースを作成します。
この API は、実行時間の長い操作 (LRO)をサポートします。

権限

呼び出し元には、共同作成者 以上のワークスペース ロールが必要です。

必要な委任されたスコープ

KQLDatabase.ReadWrite.All または Item.ReadWrite.All

制限

  • KQL データベースを作成するには、ワークスペースがサポートされている Fabric 容量上にある必要があります。 詳細については、「Microsoft Fabric ライセンスの種類を参照してください。

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

同一性 支える
利用者 はい
サービス プリンシパルの とマネージド ID の はい

インターフェイス

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

URI パラメーター

名前 / 必須 型 説明
workspaceId
 path True

string

uuid

ワークスペース ID。

要求本文

名前 必須 型 説明
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 - 項目の表示名は既に使用されています

  • CorruptedPayload - 指定されたペイロードが破損しています。

例

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

エラーに関係するリソース ID。
resourceType

string

エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。
requestId

string

エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。

ItemType

列挙

アイテムの種類。 追加の項目の種類は、時間の経過と同時に追加される場合があります。

値 説明
Dashboard

PowerBI ダッシュボード。
DataPipeline

データ パイプライン。
Datamart

PowerBI データマート。
Environment

環境。
Eventhouse

イベントハウス。
Eventstream

イベントストリーム。
GraphQLApi

GraphQL 項目の API。
KQLDashboard

KQL ダッシュボード。
KQLDatabase

KQL データベース。
KQLQueryset

KQL クエリセット。
Lakehouse

レイクハウス。
MLExperiment

機械学習の実験。
MLModel

機械学習モデル。
MirroredDatabase

ミラー化されたデータベース。
MirroredWarehouse

ミラー化された倉庫。
MountedDataFactory

MountedDataFactory。
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

アイテム ID。
properties

KQLDatabaseProperties

KQL データベースのプロパティ。
type

ItemType

アイテムの種類。
workspaceId

string

uuid

ワークスペース ID。

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

親イベントハウス ID。
queryServiceUri

string

クエリ サービス URI。

KqlDatabaseType

列挙

データベースの型。

値 説明
ReadWrite

データベースに対する読み取り操作と書き込み操作を許可します。
Shortcut

ショートカットは、ソース データベースに対する読み取り専用操作を許可する埋め込み参照です。 ソースは、Azure Data Explorer クラスターまたは Fabric Eventhouse 内の同じテナントまたは異なるテナントに配置できます。

PayloadType

列挙

定義パーツペイロードの型。 追加のペイロードの種類は、時間の経過と同時に追加される場合があります。

値 説明
InlineBase64

インライン ベース 64。

ReadWriteDatabaseCreationPayload

Object

ReadWrite KQL データベース項目作成ペイロード

名前 型 説明
databaseType string:

ReadWrite

KQL データベースの型
parentEventhouseItemId

string

uuid

親イベントハウス項目 ID。

ShortcutDatabaseCreationPayload

Object

ショートカット KQL データベース項目作成ペイロード

名前 型 説明
databaseType string:

Shortcut

KQL データベースの型
invitationToken

string

ソース データベースに従う招待トークン
parentEventhouseItemId

string

uuid

親イベントハウス項目 ID。
sourceClusterUri

string

ソース Eventhouse または Azure Data Explorer クラスターの URI
sourceDatabaseName

string

ソース Eventhouse または Azure Data Explorer クラスターでフォローするデータベースの名前。