FabricTools v0.33.0 Public Preview

Get-FabricMirroredDatabase

Retrieves an MirroredDatabase or a list of MirroredDatabases from a specified workspace in Microsoft Fabric.

Syntax

Get-FabricMirroredDatabase [-WorkspaceId] <guid> [[-MirroredDatabaseId] <guid>]
 [[-MirroredDatabaseName] <string>] [<CommonParameters>]

Description

The Get-FabricMirroredDatabase function sends a GET request to the Fabric API to retrieve MirroredDatabase details for a given workspace. It can filter the results by MirroredDatabaseName.

Examples

Example 1

Retrieves the "Development" MirroredDatabase from workspace "12345".

Get-FabricMirroredDatabase -WorkspaceId "12345" -MirroredDatabaseName "Development"

Example 2

Retrieves all MirroredDatabases in workspace "12345".

Get-FabricMirroredDatabase -WorkspaceId "12345"

Parameters

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

(Mandatory) The ID of the workspace to query MirroredDatabases.

-MirroredDatabaseId guid 1 –

(Optional) The ID of a specific MirroredDatabase to retrieve.

-MirroredDatabaseName string 2 –

(Optional) The name of the specific MirroredDatabase to retrieve.

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