Items - Create KQL Database

Service:: KQLDatabase

Version d'API:: v1

Crée une base de données KQL dans l’espace de travail spécifié.
Cette API prend en charge opérations longues (LRO).

Autorisations

L’appelant doit avoir un rôle d’espace de travail contributeur .

Étendues déléguées requises

KQLDatabase.ReadWrite.All ou Item.ReadWrite.All

Limites

Pour créer une base de données KQL, l’espace de travail doit se trouver sur une capacité Fabric prise en charge. Pour plus d’informations, consultez : types de licences Microsoft Fabric.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Soutien
Utilisateur	Oui
principal de service et identités managées	Oui

Interface

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
workspaceId	path	True	string (uuid)	ID de l’espace de travail.

Corps de la demande

Nom	Obligatoire	Type	Description
displayName	True	string	Nom complet de la base de données KQL. Le nom de la base de données peut contenir des caractères alphanumériques, des traits de soulignement, des points et des traits d’union. Les caractères spéciaux ne sont pas pris en charge.
creationPayload		KQLDatabaseCreationPayload: ShortcutDatabaseCreationPayload ReadWriteDatabaseCreationPayload	Charge utile de création de base de données KQL. Utilisez `definition` ou `creationPayload`. Vous ne pouvez pas utiliser les deux en même temps.
definition		KQLDatabaseDefinition	Définition publique de la base de données KQL. Utilisez `creationPayload` ou `definition`. Vous ne pouvez pas utiliser les deux en même temps.
description		string	Description de la base de données KQL. La longueur maximale est de 256 caractères.
folderId		string (uuid)	ID du dossier. Si elle n’est pas spécifiée ou null, la base de données KQL est créée avec l’espace de travail en tant que dossier.

Réponses

Nom	Type	Description
201 Created	KQLDatabase	Création réussie
202 Accepted		Demande acceptée, approvisionnement de base de données KQL en cours En-têtes Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : InvalidItemType - Le type d’élément n’est pas valide ItemDisplayNameAlreadyInUse : le nom d’affichage de l’élément est déjà utilisé CorruptedPayload : la charge utile fournie est endommagée. WorkspaceItemsLimitExceededed : limite d’élément d’espace de travail dépassée.

Nom

Type

Description

201 Created

KQLDatabase

Création réussie

202 Accepted

Demande acceptée, approvisionnement de base de données KQL en cours

En-têtes

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

Other Status Codes

ErrorResponse

Codes d’erreur courants :

InvalidItemType - Le type d’élément n’est pas valide
ItemDisplayNameAlreadyInUse : le nom d’affichage de l’élément est déjà utilisé
CorruptedPayload : la charge utile fournie est endommagée.
WorkspaceItemsLimitExceededed : limite d’élément d’espace de travail dépassée.

Exemples

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

Exemple de requête

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

Exemple de réponse

Code d’état:: 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

Exemple de requête

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

Exemple de réponse

Code d’état:: 201

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

Code d’état:: 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

Exemple de requête

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

Exemple de réponse

Code d’état:: 201

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

Code d’état:: 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

Exemple de requête

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

Exemple de réponse

Code d’état:: 201

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

Code d’état:: 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

Exemple de requête

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

Exemple de réponse

Code d’état:: 201

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

Code d’état:: 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

Définitions

Nom	Description
CreateKQLDatabaseRequest	Créez une charge utile de demande de base de données KQL.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
ItemTag	Représente une balise appliquée à un élément.
ItemType	Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.
KQLDatabase	Objet de base de données KQL.
KQLDatabaseDefinition	Objet de définition publique de base de données KQL.
KQLDatabaseDefinitionPart	Objet de partie de définition de base de données KQL.
KQLDatabaseProperties	Propriétés de la base de données KQL.
KqlDatabaseType	Type de la base de données.
PayloadType	Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.
ReadWriteDatabaseCreationPayload	Charge utile de création d’élément de base de données ReadWrite KQL
ShortcutDatabaseCreationPayload	Charge utile de création d’élément de base de données KQL de raccourci

CreateKQLDatabaseRequest

Objet

Créez une charge utile de demande de base de données KQL.

Nom	Type	Description
creationPayload	KQLDatabaseCreationPayload: ReadWriteDatabaseCreationPayload ShortcutDatabaseCreationPayload	Charge utile de création de base de données KQL. Utilisez `definition` ou `creationPayload`. Vous ne pouvez pas utiliser les deux en même temps.
definition	KQLDatabaseDefinition	Définition publique de la base de données KQL. Utilisez `creationPayload` ou `definition`. Vous ne pouvez pas utiliser les deux en même temps.
description	string	Description de la base de données KQL. La longueur maximale est de 256 caractères.
displayName	string	Nom complet de la base de données KQL. Le nom de la base de données peut contenir des caractères alphanumériques, des traits de soulignement, des points et des traits d’union. Les caractères spéciaux ne sont pas pris en charge.
folderId	string (uuid)	ID du dossier. Si elle n’est pas spécifiée ou null, la base de données KQL est créée avec l’espace de travail en tant que dossier.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

ItemTag

Objet

Représente une balise appliquée à un élément.

Nom	Type	Description
displayName	string	Nom de la balise.
id	string (uuid)	ID de balise.

ItemType

Énumération

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Dashboard	Tableau de bord PowerBI.
Report	Rapport PowerBI.
SemanticModel	Modèle sémantique PowerBI.
PaginatedReport	Rapport paginé PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Un lac.
Eventhouse	Un eventhouse.
Environment	Environnement.
KQLDatabase	Base de données KQL.
KQLQueryset	Ensemble de requêtes KQL.
KQLDashboard	Tableau de bord KQL.
DataPipeline	Un pipeline de données.
Notebook	Un bloc-notes.
SparkJobDefinition	Définition d’un travail Spark.
MLExperiment	Une expérience de Machine Learning.
MLModel	Modèle Machine Learning.
Warehouse	Un entrepôt.
Eventstream	Flux d’événements.
SQLEndpoint	Point de terminaison SQL.
MirroredWarehouse	Un entrepôt mis en miroir.
MirroredDatabase	Une base de données mise en miroir.
Reflex	Un réflexe.
GraphQLApi	API pour l’élément GraphQL.
MountedDataFactory	Un MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Tâche de copie.
VariableLibrary	A VariableLibrary.
Dataflow	Flux de données.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Capture instantanée de l’entrepôt.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Flux de générateur de jumeaux numériques.
MirroredAzureDatabricksCatalog	Catalogue Azure databricks mis en miroir.
Map	Carte.
AnomalyDetector	Détecteur d’anomalies.
UserDataFunction	Fonction de données utilisateur.
GraphModel	A GraphModel.
GraphQuerySet	Ensemble de requêtes Graph.
SnowflakeDatabase	Une base de données Snowflake pour stocker les tables Iceberg créées à partir du compte Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Base de données Cosmos DB.
Ontology	Une ontologie.
EventSchemaSet	An EventSchemaSet.

KQLDatabase

Objet

Objet de base de données KQL.

Nom	Type	Description
description	string	Description de l’élément.
displayName	string	Nom complet de l’élément.
folderId	string (uuid)	ID du dossier.
id	string (uuid)	ID d’élément.
properties	KQLDatabaseProperties	Propriétés de la base de données KQL.
tags	ItemTag[]	Liste des balises appliquées.
type	ItemType	Type d’élément.
workspaceId	string (uuid)	ID de l’espace de travail.

KQLDatabaseDefinition

Objet

Objet de définition publique de base de données KQL.

Nom	Type	Description
format	string	Format de la définition d’élément.
parts	KQLDatabaseDefinitionPart[]	Liste des parties de définition.

KQLDatabaseDefinitionPart

Objet

Objet de partie de définition de base de données KQL.

Nom	Type	Description
path	string	Chemin du composant de base de données KQL.
payload	string	Charge utile de la partie de base de données KQL.
payloadType	PayloadType	Type de charge utile.

KQLDatabaseProperties

Objet

Propriétés de la base de données KQL.

Nom	Type	Description
databaseType	KqlDatabaseType	Type de la base de données.
ingestionServiceUri	string	URI du service d’ingestion.
parentEventhouseItemId	string	ID d’eventhouse parent.
queryServiceUri	string	URI du service de requête.

KqlDatabaseType

Énumération

Type de la base de données.

Valeur	Description
ReadWrite	Autorise les opérations de lecture et d’écriture sur la base de données.
Shortcut	Un raccourci est une référence incorporée qui autorise les opérations en lecture seule sur une base de données source. La source peut se trouver dans les mêmes locataires ou différents, soit dans un cluster Azure Data Explorer, soit dans un eventhouse Fabric.

PayloadType

Énumération

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
InlineBase64	Base 64 inline.

ReadWriteDatabaseCreationPayload

Objet

Charge utile de création d’élément de base de données ReadWrite KQL

Nom	Type	Description
databaseType	string: ReadWrite	Type de la base de données KQL
parentEventhouseItemId	string (uuid)	ID de l’élément eventhouse parent.

ShortcutDatabaseCreationPayload

Objet

Charge utile de création d’élément de base de données KQL de raccourci

Nom	Type	Description
databaseType	string: Shortcut	Type de la base de données KQL
invitationToken	string	Jeton d’invitation pour suivre la base de données source
parentEventhouseItemId	string (uuid)	ID de l’élément eventhouse parent.
sourceClusterUri	string	URI du cluster Eventhouse ou Azure Data Explorer source
sourceDatabaseName	string	Nom de la base de données à suivre dans le cluster Eventhouse source ou Azure Data Explorer.

Partager via

Items - Create KQL Database

Autorisations

Étendues déléguées requises

Limites

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Corps de la demande

Réponses

Exemples

Create a ReadWrite KQL database example

Exemple de requête

Exemple de réponse

Create a ReadWrite KQL database with definition example

Exemple de requête

Exemple de réponse

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

Exemple de requête

Exemple de réponse

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

Exemple de requête

Exemple de réponse

Create a Shortcut KQL database to source KQL database example

Exemple de requête

Exemple de réponse

Définitions

CreateKQLDatabaseRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

KQLDatabase

KQLDatabaseDefinition

KQLDatabaseDefinitionPart

KQLDatabaseProperties

KqlDatabaseType

PayloadType

ReadWriteDatabaseCreationPayload

ShortcutDatabaseCreationPayload