Items - Create KQL Database

Referens

Tjänst:: KQLDatabase

API-version:: v1

Skapar en KQL-databas på den angivna arbetsytan.
Det här API:et stöder tidskrävande åtgärder (LRO).

Behörigheter

Anroparen måste ha deltagare eller högre arbetsyteroll.

Obligatoriska delegerade omfång

KQLDatabase.ReadWrite.All eller Item.ReadWrite.All

Begränsningar

Om du vill skapa en KQL-databas måste arbetsytan finnas på en infrastrukturresurskapacitet som stöds. Mer information finns i: Microsoft Fabric-licenstyper.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänstens huvudnamn och hanterade identiteter	Ja

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
workspaceId	path	True	string uuid	Arbetsytans ID.

Begärandetext

Name	Obligatorisk	Typ	Description
displayName	True	string	Visningsnamnet för KQL-databasen. Databasnamnet kan innehålla alfanumeriska tecken, understreck, punkter och bindestreck. Specialtecken stöds inte.
creationPayload		KQLDatabaseCreationPayload: ShortcutDatabaseCreationPayload ReadWriteDatabaseCreationPayload	Nyttolasten för att skapa KQL-databasen. Använd `definition` eller `creationPayload`. Du kan inte använda båda samtidigt.
definition		KQLDatabaseDefinition	Den offentliga definitionen för KQL-databasen. Använd `creationPayload` eller `definition`. Du kan inte använda båda samtidigt.
description		string	KQL-databasbeskrivningen. Maximal längd är 256 tecken.

Svar

Name	Typ	Description
201 Created	KQLDatabase	Har skapats
202 Accepted		Begäran accepterad, KQL-databasetablering pågår Sidhuvuden Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: InvalidItemType – Objekttypen är ogiltig ItemDisplayNameAlreadyInUse – Objektets visningsnamn används redan CorruptedPayload – den angivna nyttolasten är skadad.

Name

Typ

Description

201 Created

KQLDatabase

Har skapats

202 Accepted

Begäran accepterad, KQL-databasetablering pågår

Sidhuvuden

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

InvalidItemType – Objekttypen är ogiltig
ItemDisplayNameAlreadyInUse – Objektets visningsnamn används redan
CorruptedPayload – den angivna nyttolasten är skadad.

Exempel

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

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 201

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047651"
}

Statuskod:: 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

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 201

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047653"
}

Statuskod:: 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

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 201

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047654"
}

Statuskod:: 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

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 201

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047652"
}

Statuskod:: 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

Definitioner

Name	Description
CreateKQLDatabaseRequest	Skapa nyttolasten för KQL-databasbegäran.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
KQLDatabase	Ett KQL-databasobjekt.
KQLDatabaseDefinition	Offentligt definitionsobjekt för KQL-databas.
KQLDatabaseDefinitionPart	KQL-databasdefinitionsdelsobjekt.
KQLDatabaseProperties	Egenskaperna för KQL-databasen.
KqlDatabaseType	Typ av databas.
PayloadType	Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.
ReadWriteDatabaseCreationPayload	Skriv upp nyttolasten för KQL-databasobjekt
ShortcutDatabaseCreationPayload	Skapa nyttolast för KQL-databasobjekt med genväg

CreateKQLDatabaseRequest

Objekt

Skapa nyttolasten för KQL-databasbegäran.

Name	Typ	Description
creationPayload	KQLDatabaseCreationPayload: ReadWriteDatabaseCreationPayload ShortcutDatabaseCreationPayload	Nyttolasten för att skapa KQL-databasen. Använd `definition` eller `creationPayload`. Du kan inte använda båda samtidigt.
definition	KQLDatabaseDefinition	Den offentliga definitionen för KQL-databasen. Använd `creationPayload` eller `definition`. Du kan inte använda båda samtidigt.
description	string	KQL-databasbeskrivningen. Maximal längd är 256 tecken.
displayName	string	Visningsnamnet för KQL-databasen. Databasnamnet kan innehålla alfanumeriska tecken, understreck, punkter och bindestreck. Specialtecken stöds inte.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Description
Dashboard	PowerBI-instrumentpanel.
DataPipeline	En datapipeline.
Datamart	PowerBI-datamart.
Environment	En miljö.
Eventhouse	Ett eventhouse.
Eventstream	En händelseström.
GraphQLApi	Ett API för GraphQL-objekt.
KQLDashboard	En KQL-instrumentpanel.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
Lakehouse	Ett sjöhus.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
MirroredDatabase	En speglad databas.
MirroredWarehouse	Ett speglat lager.
MountedDataFactory	En MountedDataFactory.
Notebook	En notebook-fil.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Reflex	En reflex.
Report	PowerBI-rapport.
SQLDatabase	En SQLDatabase.
SQLEndpoint	En SQL-slutpunkt.
SemanticModel	PowerBI-semantisk modell.
SparkJobDefinition	En definition för Spark-jobb.
Warehouse	Ett lager.

KQLDatabase

Objekt

Ett KQL-databasobjekt.

Name	Typ	Description
description	string	Objektbeskrivningen.
displayName	string	Objektets visningsnamn.
id	string uuid	Objekt-ID:t.
properties	KQLDatabaseProperties	Egenskaperna för KQL-databasen.
type	ItemType	Objekttypen.
workspaceId	string uuid	Arbetsytans ID.

KQLDatabaseDefinition

Objekt

Offentligt definitionsobjekt för KQL-databas.

Name	Typ	Description
format	string	Formatet för objektdefinitionen.
parts	KQLDatabaseDefinitionPart[]	En lista över definitionsdelar.

KQLDatabaseDefinitionPart

Objekt

KQL-databasdefinitionsdelsobjekt.

Name	Typ	Description
path	string	KQL-databasdelssökvägen.
payload	string	Nyttolasten för KQL-databasdelen.
payloadType	PayloadType	Nyttolasttypen.

KQLDatabaseProperties

Objekt

Egenskaperna för KQL-databasen.

Name	Typ	Description
databaseType	KqlDatabaseType	Typ av databas.
ingestionServiceUri	string	Inmatningstjänst-URI.
parentEventhouseItemId	string	Överordnat händelsehus-ID.
queryServiceUri	string	Fråga tjänst-URI.

KqlDatabaseType

Uppräkning

Typ av databas.

Värde	Description
ReadWrite	Tillåter läs- och skrivåtgärder i databasen.
Shortcut	En genväg är en inbäddad referens som tillåter skrivskyddade åtgärder i en källdatabas. Källan kan finnas i samma eller olika klientorganisationer, antingen i ett Azure Data Explorer-kluster eller i ett Fabric Eventhouse.

PayloadType

Uppräkning

Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.

Värde	Description
InlineBase64	Infogad bas 64.

ReadWriteDatabaseCreationPayload

Objekt

Skriv upp nyttolasten för KQL-databasobjekt

Name	Typ	Description
databaseType	string: ReadWrite	Typ av KQL-databas
parentEventhouseItemId	string uuid	Objekt-ID för överordnad händelsehus.

ShortcutDatabaseCreationPayload

Objekt

Skapa nyttolast för KQL-databasobjekt med genväg

Name	Typ	Description
databaseType	string: Shortcut	Typ av KQL-databas
invitationToken	string	Inbjudningstoken för att följa källdatabasen
parentEventhouseItemId	string uuid	Objekt-ID för överordnad händelsehus.
sourceClusterUri	string	URI:n för källans Eventhouse- eller Azure Data Explorer-kluster
sourceDatabaseName	string	Namnet på databasen som ska följas i eventhouse- eller Azure Data Explorer-källklustret.

Dela via

Items - Create KQL Database

Behörigheter

Obligatoriska delegerade omfång

Begränsningar

Identiteter som stöds av Microsoft Entra

Gränssnitt

URI-parametrar

Begärandetext

Svar

Exempel

Create a ReadWrite KQL database example

Exempelbegäran

Exempelsvar

Create a ReadWrite KQL database with definition example

Exempelbegäran

Exempelsvar

Create a Shortcut KQL database to source Azure Data Explorer cluster example

Exempelbegäran

Exempelsvar

Create a Shortcut KQL database to source Azure Data Explorer cluster with invitation token example

Exempelbegäran

Exempelsvar

Create a Shortcut KQL database to source KQL database example

Exempelbegäran

Exempelsvar

Definitioner

CreateKQLDatabaseRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

KQLDatabase

KQLDatabaseDefinition

KQLDatabaseDefinitionPart

KQLDatabaseProperties

KqlDatabaseType

PayloadType

ReadWriteDatabaseCreationPayload

ShortcutDatabaseCreationPayload

Ytterligare resurser