Items - Create KQL Queryset

Service:

KQLQueryset

API Version:

v1

Creates a KQL queryset in the specified workspace.
To create a KQL queryset with definition, refer to the KQL queryset definition article.

Permissions

The caller must have contributor or higher workspace role.

Required Delegated Scopes

KQLQueryset.ReadWrite.All or Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal	Yes
Managed identities	Yes

Interface

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

URI Parameters

Name	In	Required	Type	Description
workspaceId	path	True	string uuid	The workspace ID.

Request Body

Name	Required	Type	Description
displayName	True	string	The KQL queryset display name. The display name must follow naming rules according to item type.
definition		KQLQuerysetDefinition	The KQL queryset public definition.
description		string	The KQL queryset description. Maximum length is 256 characters.

Responses

Name	Type	Description
201 Created	KQLQueryset	Successfully created
Other Status Codes	ErrorResponse	Common error codes: InvalidItemType - Item type is invalid ItemDisplayNameAlreadyInUse - Item display name is already used. CorruptedPayload - The provided payload is corrupted.

Examples

Create a KQL queryset example

Create a KQL queryset with definition example

Create a KQL queryset example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlQuerysets

{
  "displayName": "KQLQueryset_1",
  "description": "A KQL queryset description"
}

Sample response

Status code:

201

{
  "displayName": "KQLQueryset_1",
  "description": "A KQL queryset description",
  "type": "KQLQueryset",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Create a KQL queryset with definition example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlQuerysets

{
  "displayName": "KQLQueryset_1",
  "description": "A KQL queryset description",
  "definition": {
    "format": null,
    "parts": [
      {
        "path": "RealTimeQueryset.json",
        "payload": "eyJjb250ZW50Ijoie1wicGF5bG9hZFwiOntcInRhYnNcIjpbe1wiaWRcIjpcImFkODAxYjlkLTEwOTEtNDI2NC04ZjdhLThlNDkyOGI5ZTEzOFwiLFwicXVlcnlSYW5nZVwiOntcInN0YXJ0TGluZU51bWJlclwiOjEsXCJzdGFydENvbHVtblwiOjEsXCJlbmRMaW5lTnVtYmVyXCI6MSxcImVuZENvbHVtblwiOjl9LFwidGV4dFwiOlwicHJpbnQgMTBcIixcImNvbW1hbmRJbkNvbnRleHRcIjpcInByaW50IDEwXCIsXCJleGVjdXRpb25TdGF0dXNcIjpcIm5vdFN0YXJ0ZWRcIixcImNsaWVudFJlcXVlc3RJZFwiOm51bGwsXCJjb21tYW5kVHlwZVwiOlwiUXVlcnlcIixcImNvbW1hbmRXaXRob3V0TGVhZGluZ0NvbW1lbnRzXCI6XCJwcmludCAxMFwiLFwiaGlkZUVtcHR5Q29sdW1uc1wiOmZhbHNlLFwiY3Vyc29yUG9zaXRpb25cIjp7XCJsaW5lTnVtYmVyXCI6MSxcImNvbHVtblwiOjl9fV0sXCJ0YWJJbkNvbnRleHRcIjpcImFkODAxYjlkLTEwOTEtNDI2NC04ZjdhLThlNDkyOGI5ZTEzOFwiLFwiY29ubmVjdGlvbnNcIjp7fX19In0=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Sample response

Status code:

201

{
  "displayName": "KQLQueryset_1",
  "description": "A KQL queryset description",
  "type": "KQLQueryset",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definitions

Name	Description
CreateKQLQuerysetRequest	Create KQL queryset request payload.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemType	The type of the item. Additional item types may be added over time.
KQLQueryset	A KQL queryset object.
KQLQuerysetDefinition	KQL queryset public definition object.
KQLQuerysetDefinitionPart	KQL queryset definition part object.
PayloadType	The type of the definition part payload. Additional payload types may be added over time.

CreateKQLQuerysetRequest

Create KQL queryset request payload.

Name	Type	Description
definition	KQLQuerysetDefinition	The KQL queryset public definition.
description	string	The KQL queryset description. Maximum length is 256 characters.
displayName	string	The KQL queryset display name. The display name must follow naming rules according to item type.

ErrorRelatedResource

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

ItemType

The type of the item. Additional item types may be added over time.

Name	Type	Description
Dashboard	string	PowerBI dashboard.
DataPipeline	string	A data pipeline.
Datamart	string	PowerBI datamart.
Environment	string	An environment.
Eventhouse	string	An eventhouse.
Eventstream	string	An eventstream.
KQLDashboard	string	A KQL dashboard.
KQLDatabase	string	A KQL database.
KQLQueryset	string	A KQL queryset.
Lakehouse	string	A lakehouse.
MLExperiment	string	A machine learning experiment.
MLModel	string	A machine learning model.
MirroredDatabase	string	A mirrored database.
MirroredWarehouse	string	A mirrored warehouse.
Notebook	string	A notebook.
PaginatedReport	string	PowerBI paginated report.
Reflex	string	A Reflex.
Report	string	PowerBI report.
SQLEndpoint	string	An SQL endpoint.
SemanticModel	string	PowerBI semantic model.
SparkJobDefinition	string	A spark job definition.
Warehouse	string	A warehouse.

KQLQueryset

A KQL queryset object.

Name	Type	Description
description	string	The item description.
displayName	string	The item display name.
id	string	The item ID.
type	ItemType	The item type.
workspaceId	string	The workspace ID.

KQLQuerysetDefinition

KQL queryset public definition object.

Name	Type	Description
format	string	The format of the item definition.
parts	KQLQuerysetDefinitionPart[]	A list of definition parts.

KQLQuerysetDefinitionPart

KQL queryset definition part object.

Name	Type	Description
path	string	The KQL queryset part path.
payload	string	The KQL queryset part payload.
payloadType	PayloadType	The payload type.

PayloadType

The type of the definition part payload. Additional payload types may be added over time.

Name	Type	Description
InlineBase64	string	Inline Base 64.