Edit

Share via

Items - Update KQL Database

  • Reference
Service:
KQLDatabase
API Version:
v1

Updates the properties of the specified KQL database.

Permissions

The caller must have contributor or higher workspace role.

Required Delegated Scopes

KQLDatabase.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 and Managed identities Yes

Interface

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

URI Parameters

Name In Required Type Description
kqlDatabaseId
 path True

string (uuid)

The KQL database ID.
workspaceId
 path True

string (uuid)

The workspace ID.

Request Body

Name Type Description
description

string

The KQL database description. Maximum length is 256 characters.
displayName

string

The KQL database display name. The database name can contain alphanumeric characters, underscores, periods, and hyphens. Special characters aren't supported.

Responses

Name Type Description
200 OK

KQLDatabase

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • ItemNotFound - The requested item was not found

  • InvalidRequest - Invalid update request.

Examples

Update a KQL database example

Sample request

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlDatabases/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "KQLDatabase_New_Name",
  "description": "A new description for KQL database."
}

Sample response

Status code:
200 
{
  "displayName": "KQLDatabase_New_Name",
  "description": "A new description for KQL database.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
ItemTag

Represents a tag applied on an item.
ItemType

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

A KQL database object.
KQLDatabaseProperties

The KQL database properties.
KqlDatabaseType

The type of the database.
UpdateKQLDatabaseRequest

Update KQL database request.

ErrorRelatedResource

Object

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

Object

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

Object

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.

ItemTag

Object

Represents a tag applied on an item.

Name Type Description
displayName

string

The name of the tag.
id

string (uuid)

The tag ID.

ItemType

Enumeration

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

Value Description
CopyJob

A Copy job.
Dashboard

PowerBI dashboard.
DataPipeline

A data pipeline.
Dataflow

A Dataflow.
Datamart

PowerBI datamart.
Environment

An environment.
Eventhouse

An eventhouse.
Eventstream

An eventstream.
GraphQLApi

An API for GraphQL item.
KQLDashboard

A KQL dashboard.
KQLDatabase

A KQL database.
KQLQueryset

A KQL queryset.
Lakehouse

A lakehouse.
MLExperiment

A machine learning experiment.
MLModel

A machine learning model.
MirroredDatabase

A mirrored database.
MirroredWarehouse

A mirrored warehouse.
MountedDataFactory

A MountedDataFactory.
Notebook

A notebook.
PaginatedReport

PowerBI paginated report.
Reflex

A Reflex.
Report

PowerBI report.
SQLDatabase

A SQLDatabase.
SQLEndpoint

An SQL endpoint.
SemanticModel

PowerBI semantic model.
SparkJobDefinition

A spark job definition.
VariableLibrary

A VariableLibrary.
Warehouse

A warehouse.

KQLDatabase

Object

A KQL database object.

Name Type Description
description

string

The item description.
displayName

string

The item display name.
folderId

string (uuid)

The folder ID.
id

string (uuid)

The item ID.
properties

KQLDatabaseProperties

The KQL database properties.
tags

ItemTag[]

List of applied tags.
type

ItemType

The item type.
workspaceId

string (uuid)

The workspace ID.

KQLDatabaseProperties

Object

The KQL database properties.

Name Type Description
databaseType

KqlDatabaseType

The type of the database.
ingestionServiceUri

string

Ingestion service URI.
parentEventhouseItemId

string

Parent eventhouse ID.
queryServiceUri

string

Query service URI.

KqlDatabaseType

Enumeration

The type of the database.

Value Description
ReadWrite

Allows read and write operations on the database.
Shortcut

A shortcut is an embedded reference allowing read only operations on a source database. The source can be in the same or different tenants, either in an Azure Data Explorer cluster or a Fabric Eventhouse.

UpdateKQLDatabaseRequest

Object

Update KQL database request.

Name Type Description
description

string

The KQL database description. Maximum length is 256 characters.
displayName

string

The KQL database display name. The database name can contain alphanumeric characters, underscores, periods, and hyphens. Special characters aren't supported.