Update-FabricEventstream
Updates the properties of a Fabric Eventstream.
Syntax
Update-FabricEventstream [-WorkspaceId] <guid> [-EventstreamId] <guid> [-EventstreamName] <string>
[[-EventstreamDescription] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
The Update-FabricEventstream function updates the name and/or description of a specified Fabric Eventstream by making a PATCH request to the API.
Examples
Example 1
Updates the name of the Eventstream with the ID "Eventstream123" to "NewEventstreamName".
Update-FabricEventstream -EventstreamId "Eventstream123" -EventstreamName "NewEventstreamName"Example 2
Updates both the name and description of the Eventstream "Eventstream123".
Update-FabricEventstream -EventstreamId "Eventstream123" -EventstreamName "NewName" -EventstreamDescription "Updated description"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -EventstreamId | guid | ✓Required | 1 | – | The unique identifier of the Eventstream to be updated. |
| -EventstreamName | string | ✓Required | 2 | – | The new name for the Eventstream. |
| -WorkspaceId | guid | ✓Required | 0 | – | The unique identifier of the workspace where the Eventstream resides. |
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -EventstreamDescription | string | 3 | – | (Optional) The new description for the Eventstream. |
|
| -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-TokenStateto ensure token validity before making the API request.
Author: Tiago Balabuch, Kamil Nowinski