Update-FabricKQLDatabase
Updates the properties of a Fabric KQLDatabase.
Syntax
Update-FabricKQLDatabase [-WorkspaceId] <guid> [-KQLDatabaseId] <guid> [-KQLDatabaseName] <string>
[[-KQLDatabaseDescription] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
The Update-FabricKQLDatabase function updates the name and/or description of a specified Fabric KQLDatabase by making a PATCH request to the API.
Examples
Example 1
Updates the name of the KQLDatabase with the ID "KQLDatabase123" to "NewKQLDatabaseName".
Update-FabricKQLDatabase -KQLDatabaseId "KQLDatabase123" -KQLDatabaseName "NewKQLDatabaseName"Example 2
Updates both the name and description of the KQLDatabase "KQLDatabase123".
Update-FabricKQLDatabase -KQLDatabaseId "KQLDatabase123" -KQLDatabaseName "NewName" -KQLDatabaseDescription "Updated description"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -KQLDatabaseId | guid | ✓Required | 1 | – | The unique identifier of the KQLDatabase to be updated. |
| -KQLDatabaseName | string | ✓Required | 2 | – | The new name for the KQLDatabase. |
| -WorkspaceId | guid | ✓Required | 0 | – | The unique identifier of the workspace where the KQLDatabase resides. |
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -KQLDatabaseDescription | string | 3 | – | (Optional) The new description for the KQLDatabase. |
|
| -WhatIfalias: wi | switch | Named | – | Runs the command in a mode that only reports what would happen without performing the actions. |
This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.
Notes
- Requires
$FabricConfigglobal configuration, includingBaseUrlandFabricHeaders. - Calls
Confirm-TokenStateto ensure token validity before making the API request.
Author: Tiago Balabuch, Kamil Nowinski