Items - Create KQL Database

Tjeneste:: KQLDatabase

API-version:: v1

Opretter en KQL-database i det angivne arbejdsområde.
Denne API understøtter LRO-handlinger (Long Running Operations).

Tilladelser

Den, der ringer op, skal have en bidragyderarbejdsområderolle.

Påkrævede delegerede områder

KQLDatabase.ReadWrite.All eller Item.ReadWrite.All

Begrænsninger

Hvis du vil oprette en KQL-database, skal arbejdsområdet være på en understøttet Fabric-kapacitet. Du kan få flere oplysninger under: Microsoft Fabric-licenstyper.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
displayName	True	string	Det viste KQL-databasenavn. Databasenavnet kan indeholde alfanumeriske tegn, understregningstegn, punktummer og bindestreger. Specialtegn understøttes ikke.
creationPayload		KQLDatabaseCreationPayload: ShortcutDatabaseCreationPayload ReadWriteDatabaseCreationPayload	Nyttedata for oprettelse af KQL-database. Brug `definition` eller `creationPayload`. Du kan ikke bruge begge dele på samme tid.
definition		KQLDatabaseDefinition	Den offentlige definition af KQL-databasen. Brug `creationPayload` eller `definition`. Du kan ikke bruge begge dele på samme tid.
description		string	Beskrivelsen af KQL-databasen. Maksimumlængden er 256 tegn.
folderId		string (uuid)	Mappe-id'et. Hvis den ikke er angivet eller null, oprettes KQL-databasen med arbejdsområdet som mappe.

Svar

Name	Type	Beskrivelse
201 Created	KQLDatabase	Oprettet
202 Accepted		Anmodning accepteret, klargøring af KQL-database er i gang Headere Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: InvalidItemType – Elementtypen er ugyldig ItemDisplayNameAlreadyInUse – Det viste navn på elementet bruges allerede CorruptedPayload – Den angivne nyttedata er beskadiget. WorkspaceItemsLimitExceeded – Grænsen for arbejdsområdeelement er overskredet.

Eksempler

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

Eksempelanmodning

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

Eksempelsvar

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

Eksempelanmodning

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

Eksempelsvar

Statuskode:: 201

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

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

Eksempelanmodning

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

Eksempelsvar

Statuskode:: 201

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

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

Eksempelanmodning

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

Eksempelsvar

Statuskode:: 201

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

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

Eksempelanmodning

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

Eksempelsvar

Statuskode:: 201

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

Statuskode:: 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	Beskrivelse
CreateKQLDatabaseRequest	Opret nyttedata for KQL-databaseanmodning.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
ItemTag	Repræsenterer et mærke, der er anvendt på et element.
ItemType	Elementets type. Der kan tilføjes flere elementtyper over tid.
KQLDatabase	Et KQL-databaseobjekt.
KQLDatabaseDefinition	Offentlig KQL-databasedefinitionsobjekt.
KQLDatabaseDefinitionPart	Objekt for KQL-databasedefinitionsdel.
KQLDatabaseProperties	Egenskaberne for KQL-databasen.
KqlDatabaseType	Databasens type.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.
ReadWriteDatabaseCreationPayload	Payload til oprettelse af KQL-databaseelement i ReadWrite
ShortcutDatabaseCreationPayload	Genvej til nyttedata for oprettelse af KQL-databaseelement

CreateKQLDatabaseRequest

Objekt

Opret nyttedata for KQL-databaseanmodning.

Name	Type	Beskrivelse
creationPayload	KQLDatabaseCreationPayload: ReadWriteDatabaseCreationPayload ShortcutDatabaseCreationPayload	Nyttedata for oprettelse af KQL-database. Brug `definition` eller `creationPayload`. Du kan ikke bruge begge dele på samme tid.
definition	KQLDatabaseDefinition	Den offentlige definition af KQL-databasen. Brug `creationPayload` eller `definition`. Du kan ikke bruge begge dele på samme tid.
description	string	Beskrivelsen af KQL-databasen. Maksimumlængden er 256 tegn.
displayName	string	Det viste KQL-databasenavn. Databasenavnet kan indeholde alfanumeriske tegn, understregningstegn, punktummer og bindestreger. Specialtegn understøttes ikke.
folderId	string (uuid)	Mappe-id'et. Hvis den ikke er angivet eller null, oprettes KQL-databasen med arbejdsområdet som mappe.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

ItemTag

Objekt

Repræsenterer et mærke, der er anvendt på et element.

Name	Type	Beskrivelse
displayName	string	Navnet på mærket.
id	string (uuid)	Tag-id'et.

ItemType

Optælling

Elementets type. Der kan tilføjes flere elementtyper over tid.

Værdi	Beskrivelse
Dashboard	PowerBI-dashboard.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-model.
PaginatedReport	Sideinddelt PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et søhus.
Eventhouse	Et eventhouse.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-forespørgselssæt.
KQLDashboard	Et KQL-dashboard.
DataPipeline	En datapipeline.
Notebook	En notesbog.
SparkJobDefinition	En spark jobdefinition.
MLExperiment	Et maskinel indlæringseksperiment.
MLModel	En model til maskinel indlæring.
Warehouse	Et lager.
Eventstream	En hændelsesstream.
SQLEndpoint	Et SQL-slutpunkt.
MirroredWarehouse	Et spejlvendt lager.
MirroredDatabase	En spejlet database.
Reflex	En refleks.
GraphQLApi	En API til GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Et kopijob.
VariableLibrary	En VariabelLibrary.
Dataflow	Et dataflow.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et lagersnapshot.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Et Digital Twin Builder-flow.
MirroredAzureDatabricksCatalog	Et spejlet Azure Databricks-katalog.
Map	Et kort.
AnomalyDetector	En uregelmæssighedsregistrering.
UserDataFunction	En brugerdatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	Et Graph QuerySet.
SnowflakeDatabase	En Snowflake-database til lagring af Iceberg-tabeller, der er oprettet fra Snowflake-konto.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.
Ontology	En ontologi.
EventSchemaSet	Et EventSchemaSet.
DataAgent	En DataAgent.

KQLDatabase

Objekt

Et KQL-databaseobjekt.

Name	Type	Beskrivelse
description	string	Elementbeskrivelsen.
displayName	string	Det viste elementnavn.
folderId	string (uuid)	Mappe-id'et.
id	string (uuid)	Element-id'et.
properties	KQLDatabaseProperties	Egenskaberne for KQL-databasen.
tags	ItemTag[]	Liste over anvendte mærker.
type	ItemType	Elementtypen.
workspaceId	string (uuid)	Arbejdsområde-id'et.

KQLDatabaseDefinition

Objekt

Offentlig KQL-databasedefinitionsobjekt.

Name	Type	Beskrivelse
format	string	Formatet af elementdefinitionen.
parts	KQLDatabaseDefinitionPart[]	En liste over definitionsdele.

KQLDatabaseDefinitionPart

Objekt

Objekt for KQL-databasedefinitionsdel.

Name	Type	Beskrivelse
path	string	Stien til KQL-databasedelen.
payload	string	Nyttedata for KQL-databasedelen.
payloadType	PayloadType	Nyttedatatypen.

KQLDatabaseProperties

Objekt

Egenskaberne for KQL-databasen.

Name	Type	Beskrivelse
databaseType	KqlDatabaseType	Databasens type.
ingestionServiceUri	string	URI for indtagelsestjeneste.
parentEventhouseItemId	string	Id for overordnet hændelseshus.
queryServiceUri	string	URI for forespørgselstjeneste.

KqlDatabaseType

Optælling

Databasens type.

Værdi	Beskrivelse
ReadWrite	Tillader læse- og skrivehandlinger i databasen.
Shortcut	En genvej er en integreret reference, der tillader skrivebeskyttede handlinger i en kildedatabase. Kilden kan være i de samme eller forskellige lejere, enten i en Azure Data Explorer-klynge eller i et Fabric Eventhouse.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.

ReadWriteDatabaseCreationPayload

Objekt

Payload til oprettelse af KQL-databaseelement i ReadWrite

Name	Type	Beskrivelse
databaseType	string: ReadWrite	KQL-databasens type
parentEventhouseItemId	string (uuid)	Element-id for overordnet hændelseshus.

ShortcutDatabaseCreationPayload

Objekt

Genvej til nyttedata for oprettelse af KQL-databaseelement

Name	Type	Beskrivelse
databaseType	string: Shortcut	KQL-databasens type
invitationToken	string	Invitationstoken til at følge kildedatabasen
parentEventhouseItemId	string (uuid)	Element-id for overordnet hændelseshus.
sourceClusterUri	string	URI'en for kildehændelseshuset eller Azure Data Explorer-klyngen
sourceDatabaseName	string	Navnet på den database, der skal følges i kildehændelseshuset eller Azure Data Explorer-klyngen.

Del via

Items - Create KQL Database

Tilladelser

Påkrævede delegerede områder

Begrænsninger

Microsoft Entra-understøttede identiteter

Grænseflade

URI-parametre

Brødtekst for anmodning

Svar

Eksempler

Create a ReadWrite KQL database example

Eksempelanmodning

Eksempelsvar

Create a ReadWrite KQL database with definition example

Eksempelanmodning

Eksempelsvar

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

Eksempelanmodning

Eksempelsvar

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

Eksempelanmodning

Eksempelsvar

Create a Shortcut KQL database to source KQL database example

Eksempelanmodning

Eksempelsvar

Definitioner

CreateKQLDatabaseRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

KQLDatabase

KQLDatabaseDefinition

KQLDatabaseDefinitionPart

KQLDatabaseProperties

KqlDatabaseType

PayloadType

ReadWriteDatabaseCreationPayload

ShortcutDatabaseCreationPayload