FabricTools v0.33.0 Public Preview

Update-FabricLakehouse

Updates the properties of a Fabric Lakehouse.

Syntax

Update-FabricLakehouse [-WorkspaceId] <guid> [-LakehouseId] <guid> [-LakehouseName] <string>
 [[-LakehouseDescription] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

The Update-FabricLakehouse function updates the name and/or description of a specified Fabric Lakehouse by making a PATCH request to the API.

Examples

Example 1

Updates the name of the Lakehouse with the ID "Lakehouse123" to "NewLakehouseName".

Update-FabricLakehouse -LakehouseId "Lakehouse123" -LakehouseName "NewLakehouseName"

Example 2

Updates both the name and description of the Lakehouse "Lakehouse123".

Update-FabricLakehouse -LakehouseId "Lakehouse123" -LakehouseName "NewName" -LakehouseDescription "Updated description"

Parameters

NameTypeReq.Pos.PipelineDescription
-LakehouseId guid ✓Required 1 –

The unique identifier of the Lakehouse to be updated.

-LakehouseName string ✓Required 2 –

The new name for the Lakehouse.

-WorkspaceId guid ✓Required 0 –

The unique identifier of the workspace where the Lakehouse exists.

-Confirmalias: cf switch Named –

Prompts you for confirmation before running the cmdlet.

-LakehouseDescription string 3 –

(Optional) The new description for the Lakehouse.

-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

  • Calls Confirm-TokenState to ensure token validity before making the API request.

Author: Tiago Balabuch, Kamil Nowinski