Freigeben über

Items - Create KQL Database

Dienst:
KQLDatabase
API-Version:
v1

Erstellt eine KQL-Datenbank im angegebenen Arbeitsbereich.
Diese API unterstützt LRO-.

Erlaubnisse

Der Aufrufer muss über eine Rolle des Mitwirkenden-Arbeitsbereichs verfügen.

Erforderliche delegierte Bereiche

KQLDatabase.ReadWrite.All oder Item.ReadWrite.All

Begrenzungen

  • Zum Erstellen einer KQL-Datenbank muss sich der Arbeitsbereich auf einer unterstützten Fabric-Kapazität befinden. Weitere Informationen finden Sie unter: Microsoft Fabric-Lizenztypen.

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität Unterstützen
Benutzer Ja
Dienstprinzipal und verwaltete Identitäten Ja

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.

Anforderungstext

Name Erforderlich Typ Beschreibung
displayName True

string

Der Anzeigename der KQL-Datenbank. Der Datenbankname kann alphanumerische Zeichen, Unterstriche, Punkte und Bindestriche enthalten. Sonderzeichen werden nicht unterstützt.
creationPayload KQLDatabaseCreationPayload:

Die KQL-Datenbankerstellungsnutzlast. Verwenden Sie definition oder creationPayload. Sie können beide nicht gleichzeitig verwenden.
definition

KQLDatabaseDefinition

Die öffentliche KQL-Datenbankdefinition. Verwenden Sie creationPayload oder definition. Sie können beide nicht gleichzeitig verwenden.
description

string

Die KQL-Datenbankbeschreibung. Die maximale Länge beträgt 256 Zeichen.
folderId

string (uuid)

Die Ordner-ID. Wenn sie nicht angegeben oder null ist, wird die KQL-Datenbank mit dem Arbeitsbereich als Ordner erstellt.

Antworten

Name Typ Beschreibung
201 Created

KQLDatabase

Erfolgreich erstellt
202 Accepted

Akzeptierte Anforderung, KQL-Datenbankbereitstellung in Bearbeitung

Header

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

ErrorResponse

Häufige Fehlercodes:

  • InvalidItemType – Elementtyp ist ungültig.

  • ItemDisplayNameAlreadyInUse - Elementanzeigename wird bereits verwendet

  • CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.

  • WorkspaceItemsLimitExceededed – Grenzwert für Arbeitsbereichselemente wurde überschritten.

Beispiele

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
CreateKQLDatabaseRequest

Erstellen Sie die KQL-Datenbankanforderungsnutzlast.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
ItemTag

Stellt ein Tag dar, das auf ein Element angewendet wird.
ItemType

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.
KQLDatabase

Ein KQL-Datenbankobjekt.
KQLDatabaseDefinition

Öffentliches Definitionsobjekt der KQL-Datenbank.
KQLDatabaseDefinitionPart

KQL-Datenbankdefinitionsteilobjekt.
KQLDatabaseProperties

Die KQL-Datenbankeigenschaften.
KqlDatabaseType

Der Typ der Datenbank.
PayloadType

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.
ReadWriteDatabaseCreationPayload

ReadWrite KQL-Datenbankelementerstellungsnutzlast
ShortcutDatabaseCreationPayload

KQL-Datenbankelementerstellungsnutzlast

CreateKQLDatabaseRequest

Objekt

Erstellen Sie die KQL-Datenbankanforderungsnutzlast.

Name Typ Beschreibung
creationPayload KQLDatabaseCreationPayload:

Die KQL-Datenbankerstellungsnutzlast. Verwenden Sie definition oder creationPayload. Sie können beide nicht gleichzeitig verwenden.
definition

KQLDatabaseDefinition

Die öffentliche KQL-Datenbankdefinition. Verwenden Sie creationPayload oder definition. Sie können beide nicht gleichzeitig verwenden.
description

string

Die KQL-Datenbankbeschreibung. Die maximale Länge beträgt 256 Zeichen.
displayName

string

Der Anzeigename der KQL-Datenbank. Der Datenbankname kann alphanumerische Zeichen, Unterstriche, Punkte und Bindestriche enthalten. Sonderzeichen werden nicht unterstützt.
folderId

string (uuid)

Die Ordner-ID. Wenn sie nicht angegeben oder null ist, wird die KQL-Datenbank mit dem Arbeitsbereich als Ordner erstellt.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

ItemTag

Objekt

Stellt ein Tag dar, das auf ein Element angewendet wird.

Name Typ Beschreibung
displayName

string

Der Name des Tags.
id

string (uuid)

Die Tag-ID.

ItemType

Enumeration

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Dashboard

PowerBI-Dashboard.
Report

PowerBI-Bericht.
SemanticModel

PowerBI-Semantikmodell.
PaginatedReport

PowerBI-Paginated-Bericht.
Datamart

PowerBI datamart.
Lakehouse

Ein Seehaus.
Eventhouse

Ein Eventhouse.
Environment

Eine Umgebung.
KQLDatabase

Eine KQL-Datenbank.
KQLQueryset

Ein KQL-Abfrageset.
KQLDashboard

Ein KQL-Dashboard.
DataPipeline

Eine Datenpipeline.
Notebook

Ein Notizbuch.
SparkJobDefinition

Eine Sparkauftragsdefinition.
MLExperiment

Ein Machine Learning-Experiment.
MLModel

Ein Machine Learning-Modell.
Warehouse

Ein Lagerhaus.
Eventstream

Ein Ereignisstream.
SQLEndpoint

Ein SQL-Endpunkt.
MirroredWarehouse

Ein gespiegeltes Lager.
MirroredDatabase

Eine gespiegelte Datenbank.
Reflex

Ein Reflex.
GraphQLApi

Eine API für GraphQL-Element.
MountedDataFactory

Eine MountedDataFactory.
SQLDatabase

Eine SQLDatabase.
CopyJob

Ein Kopierauftrag.
VariableLibrary

Eine VariableLibrary.
Dataflow

Ein Datenfluss.
ApacheAirflowJob

Ein ApacheAirflowJob.
WarehouseSnapshot

Eine Warehouse-Momentaufnahme.
DigitalTwinBuilder

Ein DigitalTwinBuilder.
DigitalTwinBuilderFlow

Ein Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog

Ein gespiegelter Azure Databricks-Katalog.
Map

Eine Karte.
AnomalyDetector

Anomaliedetektor.
UserDataFunction

Eine Benutzerdatenfunktion.
GraphModel

Ein GraphModel.
GraphQuerySet

Ein Graph QuerySet.
SnowflakeDatabase

Eine Snowflake-Datenbank zum Speichern von Iceberg-Tabellen, die aus dem Snowflake-Konto erstellt wurden.
OperationsAgent

Ein OperationsAgent.
CosmosDBDatabase

Eine Cosmos DB-Datenbank.
Ontology

Eine Ontologie.
EventSchemaSet

Ein EventSchemaSet.

KQLDatabase

Objekt

Ein KQL-Datenbankobjekt.

Name Typ Beschreibung
description

string

Die Elementbeschreibung.
displayName

string

Der Anzeigename des Elements.
folderId

string (uuid)

Die Ordner-ID.
id

string (uuid)

Die Element-ID.
properties

KQLDatabaseProperties

Die KQL-Datenbankeigenschaften.
tags

ItemTag[]

Liste der angewendeten Tags.
type

ItemType

Der Elementtyp.
workspaceId

string (uuid)

Die Arbeitsbereichs-ID.

KQLDatabaseDefinition

Objekt

Öffentliches Definitionsobjekt der KQL-Datenbank.

Name Typ Beschreibung
format

string

Das Format der Elementdefinition.
parts

KQLDatabaseDefinitionPart[]

Eine Liste der Definitionsteile.

KQLDatabaseDefinitionPart

Objekt

KQL-Datenbankdefinitionsteilobjekt.

Name Typ Beschreibung
path

string

Der KQL-Datenbankteilpfad.
payload

string

Die Nutzlast des KQL-Datenbankteils.
payloadType

PayloadType

Der Nutzlasttyp.

KQLDatabaseProperties

Objekt

Die KQL-Datenbankeigenschaften.

Name Typ Beschreibung
databaseType

KqlDatabaseType

Der Typ der Datenbank.
ingestionServiceUri

string

Dienst-URI für Aufnahme.
parentEventhouseItemId

string

Übergeordnete Ereignishaus-ID.
queryServiceUri

string

Abfragedienst-URI.

KqlDatabaseType

Enumeration

Der Typ der Datenbank.

Wert Beschreibung
ReadWrite

Ermöglicht Lese- und Schreibvorgänge in der Datenbank.
Shortcut

Eine Verknüpfung ist ein eingebetteter Verweis, der schreibgeschützte Vorgänge in einer Quelldatenbank zulässt. Die Quelle kann sich in demselben oder verschiedenen Mandanten befinden, entweder in einem Azure Data Explorer-Cluster oder in einem Fabric Eventhouse.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
InlineBase64

Inlinebasis 64.

ReadWriteDatabaseCreationPayload

Objekt

ReadWrite KQL-Datenbankelementerstellungsnutzlast

Name Typ Beschreibung
databaseType string:

ReadWrite

Der Typ der KQL-Datenbank
parentEventhouseItemId

string (uuid)

Element-ID des übergeordneten Ereignisses.

ShortcutDatabaseCreationPayload

Objekt

KQL-Datenbankelementerstellungsnutzlast

Name Typ Beschreibung
databaseType string:

Shortcut

Der Typ der KQL-Datenbank
invitationToken

string

Einladungstoken zur Folge der Quelldatenbank
parentEventhouseItemId

string (uuid)

Element-ID des übergeordneten Ereignisses.
sourceClusterUri

string

Der URI des Quell-Eventhouse- oder Azure Data Explorer-Clusters
sourceDatabaseName

string

Der Name der Datenbank, die im Quellcluster "Eventhouse" oder "Azure Data Explorer" folgen soll.