Update-FabricMirroredDatabase

Updates the properties of a Fabric MirroredDatabase.

Syntax

Update-FabricMirroredDatabase [-WorkspaceId] <guid> [-MirroredDatabaseId] <guid>
 [-MirroredDatabaseName] <string> [[-MirroredDatabaseDescription] <string>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Description

The Update-FabricMirroredDatabase function updates the name and/or description of a specified Fabric MirroredDatabase by making a PATCH request to the API.

Examples

Example 1

Updates the name of the MirroredDatabase with the ID "MirroredDatabase123" to "NewMirroredDatabaseName".

Update-FabricMirroredDatabase -MirroredDatabaseId "MirroredDatabase123" -MirroredDatabaseName "NewMirroredDatabaseName"

Example 2

Updates both the name and description of the MirroredDatabase "MirroredDatabase123".

Update-FabricMirroredDatabase -MirroredDatabaseId "MirroredDatabase123" -MirroredDatabaseName "NewName" -MirroredDatabaseDescription "Updated description"

Parameters

Name	Type	Req.	Pos.	Pipeline	Description
-MirroredDatabaseId	guid	✓Required	1	–	The unique identifier of the MirroredDatabase to be updated.
-MirroredDatabaseName	string	✓Required	2	–	The new name for the MirroredDatabase.
-WorkspaceId	guid	✓Required	0	–	(Mandatory) The unique identifier of the workspace where the MirroredDatabase resides.
-Confirmalias: cf	switch		Named	–	Prompts you for confirmation before running the cmdlet.
-MirroredDatabaseDescription	string		3	–	(Optional) The new description for the MirroredDatabase.
-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

Requires $FabricConfig global configuration, including BaseUrl and FabricHeaders.
Calls Confirm-TokenState to ensure token validity before making the API request.

Author: Tiago Balabuch, Kamil Nowinski

Edit this page on GitHub Report a docs issue