FabricTools v0.33.0 Public Preview

Get-FabricEventstreamDefinition

Retrieves the definition of a Eventstream from a specific workspace in Microsoft Fabric.

Syntax

Get-FabricEventstreamDefinition [-WorkspaceId] <guid> [[-EventstreamId] <guid>]
 [[-EventstreamFormat] <string>] [<CommonParameters>]

Description

This function fetches the Eventstream's content or metadata from a workspace. Handles both synchronous and asynchronous operations, with detailed logging and error handling.

Examples

Example 1

Retrieves the definition of the Eventstream with ID 67890 from the workspace with ID 12345 in the ipynb format.

Get-FabricEventstreamDefinition -WorkspaceId "12345" -EventstreamId "67890"

Example 2

Retrieves the definitions of all Eventstreams in the workspace with ID 12345 in the ipynb format.

Get-FabricEventstreamDefinition -WorkspaceId "12345"

Parameters

NameTypeReq.Pos.PipelineDescription
-WorkspaceId guid ✓Required 0 –

(Mandatory) The unique identifier of the workspace from which the Eventstream definition is to be retrieved.

-EventstreamFormat string 2 –

Specifies the format of the Eventstream definition. Currently, only 'ipynb' is supported. Default: 'ipynb'.

-EventstreamId guid 1 –

(Optional)The unique identifier of the Eventstream whose definition needs to be retrieved.

This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.

Notes

Author: Tiago Balabuch, Kamil Nowinski