Items - Create Mirrored Database

Service:: MirroredDatabase

API Version:: v1

Creates a mirrored database in the specified workspace.
This API does not support creating a mirrored database without a definition. To create Mirrored database with definition, refer to Mirrored database definition article.

Permissions

The caller must have a contributor workspace role.

Required Delegated Scopes

MirroredDatabase.ReadWrite.All or Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredDatabases

URI Parameters

Name	In	Required	Type	Description
workspaceId	path	True	string (uuid)	The workspace ID.

Request Body

Name	Required	Type	Description
definition	True	MirroredDatabaseDefinition	The mirrored database public definition.
displayName	True	string	The mirrored database display name. The display name must follow naming rules according to item type.
description		string	The mirrored database description. Maximum length is 256 characters.
folderId		string (uuid)	The folder ID. If not specified or null, the mirrored database is created with the workspace as its folder.

Responses

Name	Type	Description
201 Created	MirroredDatabase	Successfully created
Other Status Codes	ErrorResponse	Common error codes: InvalidItemType - Item type is invalid ItemDisplayNameAlreadyInUse - Item display name is already used. CorruptedPayload - The provided payload is corrupted. WorkspaceItemsLimitExceeded - Workspace item limit exceeded.

Name

Type

Description

201 Created

MirroredDatabase

Successfully created

Other Status Codes

ErrorResponse

Common error codes:

InvalidItemType - Item type is invalid
ItemDisplayNameAlreadyInUse - Item display name is already used.
CorruptedPayload - The provided payload is corrupted.
WorkspaceItemsLimitExceeded - Workspace item limit exceeded.

Examples

Create a mirrored database with public definition example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/mirroredDatabases

{
  "displayName": "Mirrored database 1",
  "description": "A mirrored database description",
  "definition": {
    "parts": [
      {
        "path": "mirroring.json",
        "payload": "eyAicHJvcGVydGllcy..WJsZSIgfSB9IH0gXSB9IH0",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Sample response

Status code:: 201

{
  "displayName": "Mirrored database 1",
  "description": "A mirrored database description",
  "type": "MirroredDatabase",
  "workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
  "id": "b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2"
}

Definitions

Name	Description
CreateMirroredDatabaseRequest	Create mirrored database request payload.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemTag	Represents a tag applied on an item.
ItemType	The type of the item. Additional item types may be added over time.
MirroredDatabase	A mirrored database item.
MirroredDatabaseDefinition	Mirrored database public definition object.
MirroredDatabaseDefinitionPart	Mirrored database definition part object.
MirroredDatabaseProperties	The mirrored database properties.
PayloadType	The type of the definition part payload. Additional payload types may be added over time.
SqlEndpointProperties	An object containing the properties of the SQL endpoint.
SqlEndpointProvisioningStatus	The SQL endpoint provisioning status type. Additional `SqlEndpointProvisioningStatus` types may be added over time.

CreateMirroredDatabaseRequest

Object

Create mirrored database request payload.

Name	Type	Description
definition	MirroredDatabaseDefinition	The mirrored database public definition.
description	string	The mirrored database description. Maximum length is 256 characters.
displayName	string	The mirrored database display name. The display name must follow naming rules according to item type.
folderId	string (uuid)	The folder ID. If not specified or null, the mirrored database is created with the workspace as its folder.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

ItemTag

Object

Represents a tag applied on an item.

Name	Type	Description
displayName	string	The name of the tag.
id	string (uuid)	The tag ID.

ItemType

Enumeration

The type of the item. Additional item types may be added over time.

Value	Description
ApacheAirflowJob	An ApacheAirflowJob.
CopyJob	A Copy job.
Dashboard	PowerBI dashboard.
DataPipeline	A data pipeline.
Dataflow	A Dataflow.
Datamart	PowerBI datamart.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	A Digital Twin Builder Flow.
Environment	An environment.
Eventhouse	An eventhouse.
Eventstream	An eventstream.
GraphQLApi	An API for GraphQL item.
KQLDashboard	A KQL dashboard.
KQLDatabase	A KQL database.
KQLQueryset	A KQL queryset.
Lakehouse	A lakehouse.
MLExperiment	A machine learning experiment.
MLModel	A machine learning model.
MirroredAzureDatabricksCatalog	A mirrored azure databricks catalog.
MirroredDatabase	A mirrored database.
MirroredWarehouse	A mirrored warehouse.
MountedDataFactory	A MountedDataFactory.
Notebook	A notebook.
PaginatedReport	PowerBI paginated report.
Reflex	A Reflex.
Report	PowerBI report.
SQLDatabase	A SQLDatabase.
SQLEndpoint	An SQL endpoint.
SemanticModel	PowerBI semantic model.
SparkJobDefinition	A spark job definition.
VariableLibrary	A VariableLibrary.
Warehouse	A warehouse.
WarehouseSnapshot	A Warehouse snapshot.

MirroredDatabase

Object

A mirrored database item.

Name	Type	Description
description	string	The item description.
displayName	string	The item display name.
folderId	string (uuid)	The folder ID.
id	string (uuid)	The item ID.
properties	MirroredDatabaseProperties	The mirrored database properties.
tags	ItemTag[]	List of applied tags.
type	ItemType	The item type.
workspaceId	string (uuid)	The workspace ID.

MirroredDatabaseDefinition

Object

Mirrored database public definition object.

Name	Type	Description
parts	MirroredDatabaseDefinitionPart[]	A list of definition parts.

MirroredDatabaseDefinitionPart

Object

Mirrored database definition part object.

Name	Type	Description
path	string	The mirrored database part path.
payload	string	The mirrored database part payload.
payloadType	PayloadType	The payload type.

MirroredDatabaseProperties

Object

The mirrored database properties.

Name	Type	Description
defaultSchema	string	Default schema of the mirrored database. This property is returned only for mirrored database that enables default schema in definition.
oneLakeTablesPath	string	OneLake path to the mirrored database tables directory.
sqlEndpointProperties	SqlEndpointProperties	An object containing the properties of the SQL endpoint.

PayloadType

Enumeration

The type of the definition part payload. Additional payload types may be added over time.

Value	Description
InlineBase64	Inline Base 64.

SqlEndpointProperties

Object

An object containing the properties of the SQL endpoint.

Name	Type	Description
connectionString	string	SQL endpoint connection string.
id	string	SQL endpoint ID.
provisioningStatus	SqlEndpointProvisioningStatus	The SQL endpoint provisioning status.

SqlEndpointProvisioningStatus

Enumeration

The SQL endpoint provisioning status type. Additional SqlEndpointProvisioningStatus types may be added over time.

Value	Description
Failed	SQL endpoint provisioning failed.
InProgress	SQL endpoint provisioning is in progress.
Success	SQL endpoint provisioning succeeded.

Share via

Items - Create Mirrored Database

Permissions

Required Delegated Scopes

Microsoft Entra supported identities

Interface

URI Parameters

Request Body

Responses

Examples

Create a mirrored database with public definition example

Sample request

Sample response

Definitions

CreateMirroredDatabaseRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

MirroredDatabase

MirroredDatabaseDefinition

MirroredDatabaseDefinitionPart

MirroredDatabaseProperties

PayloadType

SqlEndpointProperties

SqlEndpointProvisioningStatus