Items - Create KQL Database

Usługa:: KQLDatabase

Wersja interfejsu API:: v1

Tworzy bazę danych KQL w określonym obszarze roboczym.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Uprawnienia

Obiekt wywołujący musi mieć rolę obszaru roboczego współautora .

Wymagane zakresy delegowane

KQLDatabase.ReadWrite.All lub Item.ReadWrite.All

Ograniczenia

Aby utworzyć bazę danych KQL, obszar roboczy musi znajdować się w obsługiwanej pojemności sieci szkieletowej. Aby uzyskać więcej informacji, zobacz: typy licencji Microsoft Fabric.

Microsoft Entra obsługiwane tożsamości

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator obszaru roboczego.

Treść żądania

Nazwa	Wymagane	Typ	Opis
displayName	True	string	Nazwa wyświetlana bazy danych KQL. Nazwa bazy danych może zawierać znaki alfanumeryczne, podkreślenia, kropki i łączniki. Znaki specjalne nie są obsługiwane.
creationPayload		KQLDatabaseCreationPayload: ShortcutDatabaseCreationPayload ReadWriteDatabaseCreationPayload	Ładunek tworzenia bazy danych KQL. Użyj `definition` lub `creationPayload`. Nie można używać obu tych elementów w tym samym czasie.
definition		KQLDatabaseDefinition	Definicja publiczna bazy danych KQL. Użyj `creationPayload` lub `definition`. Nie można używać obu tych elementów w tym samym czasie.
description		string	Opis bazy danych KQL. Maksymalna długość to 256 znaków.
folderId		string (uuid)	Identyfikator folderu. Jeśli nie zostanie określona lub ma wartość null, baza danych KQL zostanie utworzona z obszarem roboczym jako jego folderem.
sensitivityLabelSettings		SensitivityLabelSettings	Ustawienia etykiety poufności dla bazy danych KQL.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	KQLDatabase	Pomyślnie utworzono
202 Accepted		Akceptowanie żądania, aprowizowanie bazy danych KQL w toku Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: InvalidItemType — typ elementu jest nieprawidłowy ItemDisplayNameAlreadyInUse — nazwa wyświetlana elementu jest już używana CorruptedPayload — podany ładunek jest uszkodzony. WorkspaceItemsLimitExceeded — przekroczono limit elementu obszaru roboczego.

Przykłady

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 201

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047651",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 201

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047653",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 201

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047654",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 201

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047652",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Kod stanu:: 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

Definicje

Nazwa	Opis
CreateKQLDatabaseRequest	Utwórz ładunek żądania bazy danych KQL.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
ItemTag	Reprezentuje tag zastosowany w elemencie.
ItemType	Typ elementu. Dodatkowe typy elementów można dodawać w czasie.
KQLDatabase	Obiekt bazy danych KQL.
KQLDatabaseDefinition	Obiekt definicji publicznej bazy danych KQL. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji bazy danych KQL.
KQLDatabaseDefinitionPart	Obiekt części definicji bazy danych KQL.
KQLDatabaseProperties	Właściwości bazy danych KQL.
KqlDatabaseType	Typ bazy danych.
PayloadType	Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.
ReadWriteDatabaseCreationPayload	Ładunek tworzenia elementu bazy danych KQL ReadWrite
SensitivityLabel	Reprezentuje etykietę poufności zastosowaną do elementu.
SensitivityLabelApplyStrategy	Strategia stosowania etykiety poufności. Wartość domyślna to ApplyOrFail. Dodatkowe typy mogą być dodawane w czasie.
SensitivityLabelSettings	Ustawienia etykiety poufności.
ShortcutDatabaseCreationPayload	Skrótowy ładunek elementu bazy danych KQL

CreateKQLDatabaseRequest

Objekt

Utwórz ładunek żądania bazy danych KQL.

Nazwa	Typ	Opis
creationPayload	KQLDatabaseCreationPayload: ReadWriteDatabaseCreationPayload ShortcutDatabaseCreationPayload	Ładunek tworzenia bazy danych KQL. Użyj `definition` lub `creationPayload`. Nie można używać obu tych elementów w tym samym czasie.
definition	KQLDatabaseDefinition	Definicja publiczna bazy danych KQL. Użyj `creationPayload` lub `definition`. Nie można używać obu tych elementów w tym samym czasie.
description	string	Opis bazy danych KQL. Maksymalna długość to 256 znaków.
displayName	string	Nazwa wyświetlana bazy danych KQL. Nazwa bazy danych może zawierać znaki alfanumeryczne, podkreślenia, kropki i łączniki. Znaki specjalne nie są obsługiwane.
folderId	string (uuid)	Identyfikator folderu. Jeśli nie zostanie określona lub ma wartość null, baza danych KQL zostanie utworzona z obszarem roboczym jako jego folderem.
sensitivityLabelSettings	SensitivityLabelSettings	Ustawienia etykiety poufności dla bazy danych KQL.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

ItemTag

Objekt

Reprezentuje tag zastosowany w elemencie.

Nazwa	Typ	Opis
displayName	string	Nazwa znacznika.
id	string (uuid)	Identyfikator tagu.

ItemType

Wyliczenie

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

Wartość	Opis
Dashboard	Pulpit nawigacyjny usługi Power BI.
Report	Raport usługi Power BI.
SemanticModel	Model semantyczny usługi PowerBI.
PaginatedReport	Raport podzielony na strony usługi PowerBI.
Datamart	Datamart usługi Power BI.
Lakehouse	Jezioro.
Eventhouse	Magazyn zdarzeń.
Environment	Środowisko.
KQLDatabase	Baza danych KQL.
KQLQueryset	Zestaw zapytań KQL.
KQLDashboard	Pulpit nawigacyjny KQL.
DataPipeline	Potok danych.
Notebook	Notes.
SparkJobDefinition	Definicja zadania platformy Spark.
MLExperiment	Eksperyment uczenia maszynowego.
MLModel	Model uczenia maszynowego.
Warehouse	Magazyn.
Eventstream	Strumień zdarzeń.
SQLEndpoint	Punkt końcowy SQL.
MirroredWarehouse	Dublowany magazyn.
MirroredDatabase	Dublowana baza danych.
Reflex	Refleks.
GraphQLApi	Interfejs API dla elementu GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Baza danych SQLDatabase.
CopyJob	Zadanie kopiowania.
VariableLibrary	ZmiennaLibrary.
Dataflow	Przepływ danych.
ApacheAirflowJob	Zadanie ApacheAirflowJob.
WarehouseSnapshot	Migawka magazynu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Przepływ usługi Digital Twin Builder.
MirroredAzureDatabricksCatalog	Dublowany wykaz usługi Azure Databricks.
Map	Mapa.
AnomalyDetector	Wykrywacz anomalii.
UserDataFunction	Funkcja danych użytkownika.
GraphModel	Model programu Graph.
GraphQuerySet	Zestaw zapytań programu Graph.
SnowflakeDatabase	Baza danych Snowflake do przechowywania tabel góry lodowej utworzonych na podstawie konta Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Baza danych usługi Cosmos DB.
Ontology	Ontologia.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.

KQLDatabase

Objekt

Obiekt bazy danych KQL.

Nazwa	Typ	Opis
description	string	Opis elementu.
displayName	string	Nazwa wyświetlana elementu.
folderId	string (uuid)	Identyfikator folderu.
id	string (uuid)	Identyfikator elementu.
properties	KQLDatabaseProperties	Właściwości bazy danych KQL.
sensitivityLabel	SensitivityLabel	Etykieta poufności elementu.
tags	ItemTag[]	Lista zastosowanych tagów.
type	ItemType	Typ elementu.
workspaceId	string (uuid)	Identyfikator obszaru roboczego.

KQLDatabaseDefinition

Objekt

Obiekt definicji publicznej bazy danych KQL. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji bazy danych KQL.

Nazwa	Typ	Opis
format	string	Format definicji elementu.
parts	KQLDatabaseDefinitionPart[]	Lista części definicji.

KQLDatabaseDefinitionPart

Objekt

Obiekt części definicji bazy danych KQL.

Nazwa	Typ	Opis
path	string	Ścieżka części bazy danych KQL.
payload	string	Ładunek części bazy danych KQL.
payloadType	PayloadType	Typ ładunku.

KQLDatabaseProperties

Objekt

Właściwości bazy danych KQL.

Nazwa	Typ	Opis
databaseType	KqlDatabaseType	Typ bazy danych.
ingestionServiceUri	string	Identyfikator URI usługi pozyskiwania.
parentEventhouseItemId	string	Identyfikator nadrzędnego magazynu zdarzeń.
queryServiceUri	string	Identyfikator URI usługi kwerendy.

KqlDatabaseType

Wyliczenie

Typ bazy danych.

Wartość	Opis
ReadWrite	Umożliwia operacje odczytu i zapisu w bazie danych.
Shortcut	Skrót to osadzone odwołanie umożliwiające operacje tylko do odczytu w źródłowej bazie danych. Źródło może znajdować się w tych samych lub różnych dzierżawach w klastrze Azure Data Explorer lub w usłudze Eventhouse sieci szkieletowej.

PayloadType

Wyliczenie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość	Opis
InlineBase64	Śródliniowa baza 64.

ReadWriteDatabaseCreationPayload

Objekt

Ładunek tworzenia elementu bazy danych KQL ReadWrite

Nazwa	Typ	Opis
databaseType	string: ReadWrite	Typ bazy danych KQL
parentEventhouseItemId	string (uuid)	Identyfikator elementu nadrzędnego magazynu zdarzeń.

SensitivityLabel

Objekt

Reprezentuje etykietę poufności zastosowaną do elementu.

Nazwa	Typ	Opis
id	string (uuid)	Identyfikator etykiety poufności.

SensitivityLabelApplyStrategy

Wyliczenie

Strategia stosowania etykiety poufności. Wartość domyślna to ApplyOrFail. Dodatkowe typy mogą być dodawane w czasie.

Wartość	Opis
ApplyOrFail	Zastosuj etykietę poufności lub nie powiedzie się operacji, jeśli nie można jej zastosować.
Ignore	Zignoruj etykietę poufności, jeśli nie można jej zastosować i kontynuuj operację bez stosowania etykiety.

SensitivityLabelSettings

Objekt

Ustawienia etykiety poufności.

Nazwa	Typ	Opis
labelId	string (uuid)	Identyfikator etykiety poufności.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Strategia stosowania etykiety poufności.

ShortcutDatabaseCreationPayload

Objekt

Skrótowy ładunek elementu bazy danych KQL

Nazwa	Typ	Opis
databaseType	string: Shortcut	Typ bazy danych KQL
invitationToken	string	Token zaproszenia do obserwowanej źródłowej bazy danych
parentEventhouseItemId	string (uuid)	Identyfikator elementu nadrzędnego magazynu zdarzeń.
sourceClusterUri	string	Identyfikator URI źródłowego magazynu zdarzeń lub klastra Azure Data Explorer
sourceDatabaseName	string	Nazwa bazy danych do naśladowania w źródłowym klastrze eventhouse lub Azure Data Explorer.

Udostępnij za pośrednictwem

Items - Create KQL Database

Uprawnienia

Wymagane zakresy delegowane

Ograniczenia

Microsoft Entra obsługiwane tożsamości

Interfejs

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

Create a ReadWrite KQL database example

Przykładowe żądanie

Przykładowa odpowiedź

Create a ReadWrite KQL database with definition example

Przykładowe żądanie

Przykładowa odpowiedź

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

Przykładowe żądanie

Przykładowa odpowiedź

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

Przykładowe żądanie

Przykładowa odpowiedź

Create a Shortcut KQL database to source KQL database example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CreateKQLDatabaseRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

KQLDatabase

KQLDatabaseDefinition

KQLDatabaseDefinitionPart

KQLDatabaseProperties

KqlDatabaseType

PayloadType

ReadWriteDatabaseCreationPayload

SensitivityLabel

SensitivityLabelApplyStrategy

SensitivityLabelSettings

ShortcutDatabaseCreationPayload