FabricTools v0.33.0 Public Preview

Stop-FabricMirroredDatabaseMirroring

Stops the mirroring of a specified mirrored database in a given workspace.

Syntax

Stop-FabricMirroredDatabaseMirroring [-WorkspaceId] <guid> [[-MirroredDatabaseId] <guid>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Description

This function sends a POST request to the Microsoft Fabric API to stop the mirroring of a specified mirrored database. It requires the workspace ID and the mirrored database ID as parameters.

Examples

Example 1

Stops the mirroring of the mirrored database with ID 67890 in the workspace 12345.

Stop-FabricMirroredDatabaseMirroring -WorkspaceId "12345" -MirroredDatabaseId "67890"

Parameters

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

The unique identifier of the workspace where the mirrored database resides. This parameter is mandatory.

-Confirmalias: cf switch Named –

Prompts you for confirmation before running the cmdlet.

-MirroredDatabaseId guid 1 –

The unique identifier of the mirrored database to be stopped. This parameter is mandatory.

-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.
  • This function handles asynchronous operations and retrieves operation results if required.

Author: Tiago Balabuch, Kamil Nowinski