Get-FabricEventhouseDefinition
Retrieves the definition of an Eventhouse from a specified Microsoft Fabric workspace.
Syntax
Get-FabricEventhouseDefinition [-WorkspaceId] <guid> [[-EventhouseId] <guid>]
[[-EventhouseFormat] <string>] [<CommonParameters>]Description
This function retrieves the definition of an Eventhouse from a specified workspace using the provided EventhouseId. It handles token validation, constructs the API URL, makes the API request, and processes the response.
Examples
Example 1
This example retrieves the definition of the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345".
Get-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890"Example 2
This example retrieves the definition of the Eventhouse with ID "eventhouse-67890" in the workspace with ID "workspace-12345" in JSON format.
Get-FabricEventhouseDefinition -WorkspaceId "workspace-12345" -EventhouseId "eventhouse-67890" -EventhouseFormat "json"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -WorkspaceId | guid | ✓Required | 0 | – | The unique identifier of the workspace where the Eventhouse exists. This parameter is mandatory. |
| -EventhouseFormat | string | 2 | – | The format in which to retrieve the Eventhouse definition. This parameter is optional. |
|
| -EventhouseId | guid | 1 | – | The unique identifier of the Eventhouse to retrieve the definition for. This parameter is optional. |
This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.
Notes
- Calls
Confirm-TokenStateto ensure token validity before making the API request.
Author: Tiago Balabuch, Kamil Nowinski