Items - Update KQL Database
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 | Yes |
Managed identities | Yes |
Interface
PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
kql
|
path | True |
string uuid |
The KQL database ID. |
workspace
|
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 |
Request completed successfully. |
|
Other Status Codes |
Common error codes:
|
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
{
"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 |
---|---|
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Item |
The type of the item. Additional item types may be added over time. |
KQLDatabase |
A KQL database object. |
KQLDatabase |
The KQL database properties. |
Kql |
The type of the database. |
Update |
Update KQL database request. |
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 |
List of additional error details. |
|
relatedResource |
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 |
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. |
Report |
string |
PowerBI report. |
SQLEndpoint |
string |
An SQL endpoint. |
SemanticModel |
string |
PowerBI semantic model. |
SparkJobDefinition |
string |
A spark job definition. |
Warehouse |
string |
A warehouse. |
KQLDatabase
A KQL database object.
Name | Type | Description |
---|---|---|
description |
string |
The item description. |
displayName |
string |
The item display name. |
id |
string |
The item ID. |
properties |
The KQL database properties. |
|
type |
The item type. |
|
workspaceId |
string |
The workspace ID. |
KQLDatabaseProperties
The KQL database properties.
Name | Type | Description |
---|---|---|
databaseType |
The type of the database. |
|
ingestionServiceUri |
string |
Ingestion service URI. |
parentEventhouseItemId |
string |
Parent eventhouse ID. |
queryServiceUri |
string |
Query service URI. |
KqlDatabaseType
The type of the database.
Name | Type | Description |
---|---|---|
ReadWrite |
string |
Allows read and write operations on the database. |
Shortcut |
string |
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
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. |