FabricTools v0.33.0 Public Preview

Update-FabricEventstreamDefinition

Updates the definition of a Eventstream in a Microsoft Fabric workspace.

Syntax

Update-FabricEventstreamDefinition [-WorkspaceId] <guid> [-EventstreamId] <guid>
 [-EventstreamPathDefinition] <string> [[-EventstreamPathPlatformDefinition] <string>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Description

This function allows updating the content or metadata of a Eventstream in a Microsoft Fabric workspace. The Eventstream content can be provided as file paths, and metadata updates can optionally be enabled.

Examples

Example 1

Updates the content of the Eventstream with ID 67890 in the workspace 12345 using the specified Eventstream file.

Update-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" -EventstreamPathDefinition "C:\Eventstreams\Eventstream.ipynb"

Example 2

Updates both the content and metadata of the Eventstream with ID 67890 in the workspace 12345.

Update-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890" -EventstreamPathDefinition "C:\Eventstreams\Eventstream.ipynb" -UpdateMetadata $true

Parameters

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

(Mandatory) The unique identifier of the Eventstream to be updated.

-EventstreamPathDefinition string ✓Required 2 –

(Mandatory) The file path to the Eventstream content definition file. The content will be encoded as Base64 and sent in the request.

-WorkspaceId guid ✓Required 0 –

(Mandatory) The unique identifier of the workspace where the Eventstream resides.

-Confirmalias: cf switch Named –

Prompts you for confirmation before running the cmdlet.

-EventstreamPathPlatformDefinition string 3 –

(Optional) The file path to the Eventstream's platform-specific definition file. The content will be encoded as Base64 and sent in the request.

-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.
  • The Eventstream content is encoded as Base64 before being sent to the Fabric API.

Author: Tiago Balabuch, Kamil Nowinski