FabricTools v0.33.0 Public Preview

Update-FabricEventhouseDefinition

Updates the definition of an existing Eventhouse in a specified Microsoft Fabric workspace.

Syntax

Update-FabricEventhouseDefinition [-WorkspaceId] <guid> [-EventhouseId] <guid>
 [-EventhousePathDefinition] <string> [[-EventhousePathPlatformDefinition] <string>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Description

This function sends a PATCH request to the Microsoft Fabric API to update the definition of an existing Eventhouse in the specified workspace. It supports optional parameters for Eventhouse definition and platform-specific definition.

Examples

Example 1

This example updates the definition of the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345" using the provided definition file.

Update-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhousePathDefinition "C:\Path\To\EventhouseDefinition.json"

Parameters

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

The unique identifier of the Eventhouse to be updated. This parameter is mandatory.

-EventhousePathDefinition string ✓Required 2 –

An optional path to the Eventhouse definition file to upload.

-WorkspaceId guid ✓Required 0 –

The unique identifier of the workspace where the Eventhouse exists. This parameter is mandatory.

-Confirmalias: cf switch Named –

Prompts you for confirmation before running the cmdlet.

-EventhousePathPlatformDefinition string 3 –

An optional path to the platform-specific definition file to upload.

-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