Megosztás a következőn keresztül:

Items - Create KQL Database

  • Referencia
Szolgáltatás:
KQLDatabase
API-verzió:
v1

Létrehoz egy KQL-adatbázist a megadott munkaterületen.
Ez az API támogatja hosszú ideig futó műveleteket (LRO).

Engedélyek

A hívónak közreműködői vagy magasabb munkaterületi szerepkört kell tartalmaznia.

Kötelező delegált hatókörök

KQLDatabase.ReadWrite.All vagy Item.ReadWrite.All

Korlátozások

Microsoft Entra által támogatott identitások

Ez az API támogatja az ebben a szakaszban felsorolt Microsoft identitásokat.

Azonosság Támogat
Felhasználó Igen
szolgáltatásnév és felügyelt identitások Igen

Interfész

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

URI-paraméterek

Name In Kötelező Típus Description
workspaceId
 path True

string (uuid)

A munkaterület azonosítója.

Kérelem törzse

Name Kötelező Típus Description
displayName True

string

A KQL-adatbázis megjelenítendő neve. Az adatbázis neve tartalmazhat alfanumerikus karaktereket, aláhúzásjeleket, pontokat és kötőjeleket. A speciális karakterek nem támogatottak.
creationPayload KQLDatabaseCreationPayload:

A KQL-adatbázis létrehozásának hasznos adatai. definition vagy creationPayloadhasználata. Egyszerre nem használhatja mindkettőt.
definition

KQLDatabaseDefinition

A KQL-adatbázis nyilvános definíciója. creationPayload vagy definitionhasználata. Egyszerre nem használhatja mindkettőt.
description

string

A KQL-adatbázis leírása. A maximális hossz 256 karakter.

Válaszok

Name Típus Description
201 Created

KQLDatabase

Sikeresen létrehozva
202 Accepted

Kérelem elfogadása, KQL-adatbázis kiépítése folyamatban

Fejlécek

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

ErrorResponse

Gyakori hibakódok:

  • InvalidItemType – Az elem típusa érvénytelen

  • ItemDisplayNameAlreadyInUse – Az elem megjelenítendő neve már használatban van

  • CorruptedPayload – A megadott hasznos adatok sérültek.

  • WorkspaceItemsLimitExceeded – A munkaterület elemkorlátja túllépve.

Példák

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

Mintakérelem

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

Mintaválasz

Állapotkód:
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

Mintakérelem

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

Mintaválasz

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

Mintakérelem

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

Mintaválasz

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

Mintakérelem

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

Mintaválasz

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

Mintakérelem

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

Mintaválasz

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

Definíciók

Name Description
CreateKQLDatabaseRequest

KQL-adatbázis-kérelem hasznos adatainak létrehozása.
ErrorRelatedResource

A hibával kapcsolatos erőforrás-részletek objektum.
ErrorResponse

A hibaválasz.
ErrorResponseDetails

A hibaválasz részletei.
ItemTag

Egy elemre alkalmazott címkét jelöl.
ItemType

Az elem típusa. Idővel további elemtípusok is hozzáadhatók.
KQLDatabase

KQL-adatbázis-objektum.
KQLDatabaseDefinition

KQL-adatbázis nyilvános definíciós objektuma.
KQLDatabaseDefinitionPart

KQL adatbázisdefiníciós részobjektum.
KQLDatabaseProperties

A KQL-adatbázis tulajdonságai.
KqlDatabaseType

Az adatbázis típusa.
PayloadType

A definíciórész hasznos adattípusa. Idővel további hasznos adattípusok is hozzáadhatók.
ReadWriteDatabaseCreationPayload

ReadWrite KQL-adatbáziselem létrehozása hasznos adat
ShortcutDatabaseCreationPayload

A KQL-adatbáziselem létrehozásának hasznos adatainak billentyűparancsa

CreateKQLDatabaseRequest

Objektum

KQL-adatbázis-kérelem hasznos adatainak létrehozása.

Name Típus Description
creationPayload KQLDatabaseCreationPayload:

A KQL-adatbázis létrehozásának hasznos adatai. definition vagy creationPayloadhasználata. Egyszerre nem használhatja mindkettőt.
definition

KQLDatabaseDefinition

A KQL-adatbázis nyilvános definíciója. creationPayload vagy definitionhasználata. Egyszerre nem használhatja mindkettőt.
description

string

A KQL-adatbázis leírása. A maximális hossz 256 karakter.
displayName

string

A KQL-adatbázis megjelenítendő neve. Az adatbázis neve tartalmazhat alfanumerikus karaktereket, aláhúzásjeleket, pontokat és kötőjeleket. A speciális karakterek nem támogatottak.

ErrorRelatedResource

Objektum

A hibával kapcsolatos erőforrás-részletek objektum.

Name Típus Description
resourceId

string

A hibában érintett erőforrás-azonosító.
resourceType

string

A hibában érintett erőforrás típusa.

ErrorResponse

Objektum

A hibaválasz.

Name Típus Description
errorCode

string

Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message

string

A hiba emberi olvasható ábrázolása.
moreDetails

ErrorResponseDetails[]

További hibaadatok listája.
relatedResource

ErrorRelatedResource

A hibával kapcsolatos erőforrásadatok.
requestId

string

A hibához társított kérés azonosítója.

ErrorResponseDetails

Objektum

A hibaválasz részletei.

Name Típus Description
errorCode

string

Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message

string

A hiba emberi olvasható ábrázolása.
relatedResource

ErrorRelatedResource

A hibával kapcsolatos erőforrásadatok.

ItemTag

Objektum

Egy elemre alkalmazott címkét jelöl.

Name Típus Description
displayName

string

A címke neve.
id

string (uuid)

A címke azonosítója.

ItemType

Enumerálás

Az elem típusa. Idővel további elemtípusok is hozzáadhatók.

Érték Description
CopyJob

Másolási feladat.
Dashboard

PowerBI-irányítópult.
DataPipeline

Egy adatfolyam.
Datamart

PowerBI datamart.
Environment

Egy környezet.
Eventhouse

Egy rendezvényház.
Eventstream

Eseménystream.
GraphQLApi

Api a GraphQL-elemhez.
KQLDashboard

KQL-irányítópult.
KQLDatabase

KQL-adatbázis.
KQLQueryset

KQL-lekérdezéskészlet.
Lakehouse

Egy tóház.
MLExperiment

Gépi tanulási kísérlet.
MLModel

Gépi tanulási modell.
MirroredDatabase

Tükrözött adatbázis.
MirroredWarehouse

Egy tükrözött raktár.
MountedDataFactory

A MountedDataFactory.
Notebook

Egy jegyzetfüzet.
PaginatedReport

Többoldalas PowerBI-jelentés.
Reflex

Egy reflex.
Report

PowerBI-jelentés.
SQLDatabase

A SQLDatabase.
SQLEndpoint

EGY SQL-végpont.
SemanticModel

PowerBI szemantikai modell.
SparkJobDefinition

Spark-feladat definíciója.
VariableLibrary

Egy VariableLibrary.
Warehouse

Egy raktár.

KQLDatabase

Objektum

KQL-adatbázis-objektum.

Name Típus Description
description

string

Az elem leírása.
displayName

string

Az elem megjelenítendő neve.
folderId

string (uuid)

A mappa azonosítója.
id

string (uuid)

Az elem azonosítója.
properties

KQLDatabaseProperties

A KQL-adatbázis tulajdonságai.
tags

ItemTag[]

Az alkalmazott címkék listája.
type

ItemType

Az elem típusa.
workspaceId

string (uuid)

A munkaterület azonosítója.

KQLDatabaseDefinition

Objektum

KQL-adatbázis nyilvános definíciós objektuma.

Name Típus Description
format

string

Az elemdefiníció formátuma.
parts

KQLDatabaseDefinitionPart[]

Definíciórészek listája.

KQLDatabaseDefinitionPart

Objektum

KQL adatbázisdefiníciós részobjektum.

Name Típus Description
path

string

A KQL-adatbázis részútvonala.
payload

string

A KQL-adatbázis hasznos adatai.
payloadType

PayloadType

A hasznos adat típusa.

KQLDatabaseProperties

Objektum

A KQL-adatbázis tulajdonságai.

Name Típus Description
databaseType

KqlDatabaseType

Az adatbázis típusa.
ingestionServiceUri

string

Betöltési szolgáltatás URI-ja.
parentEventhouseItemId

string

Szülőeseményház azonosítója.
queryServiceUri

string

Lekérdezési szolgáltatás URI-ja.

KqlDatabaseType

Enumerálás

Az adatbázis típusa.

Érték Description
ReadWrite

Olvasási és írási műveleteket tesz lehetővé az adatbázisban.
Shortcut

A parancsikon egy beágyazott hivatkozás, amely csak olvasási műveleteket tesz lehetővé egy forrásadatbázison. A forrás ugyanabban vagy különböző bérlőkben lehet, akár egy Azure Data Explorer-fürtben, akár egy Fabric Eventhouse-ban.

PayloadType

Enumerálás

A definíciórész hasznos adattípusa. Idővel további hasznos adattípusok is hozzáadhatók.

Érték Description
InlineBase64

Beágyazott 64-es alap.

ReadWriteDatabaseCreationPayload

Objektum

ReadWrite KQL-adatbáziselem létrehozása hasznos adat

Name Típus Description
databaseType string:

ReadWrite

A KQL-adatbázis típusa
parentEventhouseItemId

string (uuid)

Szülőeseményház elemazonosítója.

ShortcutDatabaseCreationPayload

Objektum

A KQL-adatbáziselem létrehozásának hasznos adatainak billentyűparancsa

Name Típus Description
databaseType string:

Shortcut

A KQL-adatbázis típusa
invitationToken

string

Meghívó jogkivonat a forrásadatbázis követésére
parentEventhouseItemId

string (uuid)

Szülőeseményház elemazonosítója.
sourceClusterUri

string

A forrás Eventhouse- vagy Azure Data Explorer-fürt URI-ja
sourceDatabaseName

string

A forrás Eventhouse- vagy Azure Data Explorer-fürtben követendő adatbázis neve.