FabricTools v0.33.0 Public Preview
Commands / Mirrored Database

Get-FabricMirroredDatabaseDefinition

Mirrored DatabaseGet

Retrieves the definition of a MirroredDatabase from a specific workspace in Microsoft Fabric.

Syntax

Get-FabricMirroredDatabaseDefinition [-WorkspaceId] <guid> [[-MirroredDatabaseId] <guid>]
 [<CommonParameters>]

Description

This function fetches the MirroredDatabase's content or metadata from a workspace. Handles both synchronous and asynchronous operations, with detailed logging and error handling.

Examples

Example 1

Retrieves the definition of the MirroredDatabase with ID 67890 from the workspace with ID 12345.

Get-FabricMirroredDatabaseDefinition -WorkspaceId "12345" -MirroredDatabaseId "67890"

Example 2

Retrieves the definitions of all MirroredDatabases in the workspace with ID 12345.

Get-FabricMirroredDatabaseDefinition -WorkspaceId "12345"

Parameters

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

(Mandatory) The unique identifier of the workspace from which the MirroredDatabase definition is to be retrieved.
-MirroredDatabaseId guid 1 –

(Optional)The unique identifier of the MirroredDatabase whose definition needs to be retrieved.

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.
  • Handles long-running operations asynchronously.

Author: Tiago Balabuch, Kamil Nowinski

Edit this page on GitHub Report a docs issue