FabricTools v0.33.0 Public Preview

New-FabricMirroredDatabase

Creates a new MirroredDatabase in a specified Microsoft Fabric workspace.

Syntax

New-FabricMirroredDatabase [-WorkspaceId] <guid> [-MirroredDatabaseName] <string>
 [[-MirroredDatabaseDescription] <string>] [[-MirroredDatabasePathDefinition] <string>]
 [[-MirroredDatabasePathPlatformDefinition] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

This function sends a POST request to the Microsoft Fabric API to create a new MirroredDatabase in the specified workspace. It supports optional parameters for MirroredDatabase description and path definitions for the MirroredDatabase content.

Examples

Example 1

Add-FabricMirroredDatabase -WorkspaceId "workspace-12345" -MirroredDatabaseName "New MirroredDatabase" -MirroredDatabasePathDefinition "C:\MirroredDatabases\example.json"

Parameters

NameTypeReq.Pos.PipelineDescription
-MirroredDatabaseName string ✓Required 1 –

The name of the MirroredDatabase to be created.

-WorkspaceId guid ✓Required 0 –

The unique identifier of the workspace where the MirroredDatabase will be created.

-Confirmalias: cf switch Named –

Prompts you for confirmation before running the cmdlet.

-MirroredDatabaseDescription string 2 –

An optional description for the MirroredDatabase.

-MirroredDatabasePathDefinition string 3 –

An optional path to the MirroredDatabase definition file to upload.

-MirroredDatabasePathPlatformDefinition string 4 –

An optional path to the platform-specific definition (e.g., .platform file) to upload.

-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