Update-FabricEnvironment
Updates the properties of a Fabric Environment.
Syntax
Update-FabricEnvironment [-WorkspaceId] <guid> [-EnvironmentId] <guid> [-EnvironmentName] <string>
[[-EnvironmentDescription] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
The Update-FabricEnvironment function updates the name and/or description of a specified Fabric Environment by making a PATCH request to the API.
Examples
Example 1
Updates the name of the Environment with the ID "Environment123" to "NewEnvironmentName".
Update-FabricEnvironment -EnvironmentId "Environment123" -EnvironmentName "NewEnvironmentName"Example 2
Updates both the name and description of the Environment "Environment123".
Update-FabricEnvironment -EnvironmentId "Environment123" -EnvironmentName "NewName" -EnvironmentDescription "Updated description"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -EnvironmentId | guid | ✓Required | 1 | – | The unique identifier of the Environment to be updated. |
| -EnvironmentName | string | ✓Required | 2 | – | The new name for the Environment. |
| -WorkspaceId | guid | ✓Required | 0 | – | The unique identifier of the workspace where the Environment resides. |
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -EnvironmentDescription | string | 3 | – | (Optional) The new description for the Environment. |
|
| -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