Bearbeiten

Freigeben über

Items - Create Mirrored Database

  • Reference
Service:
MirroredDatabase
API Version:
v1

Creates a mirrored database in the specified workspace.

Permissions

The caller must have contributor or higher 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 No

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
displayName True

string

The mirrored database display name. The display name must follow naming rules according to item type.
definition

MirroredDatabaseDefinition

The mirrored database public definition.
description

string

The mirrored database description. Maximum length is 256 characters.

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.

Examples

Create a mirrored database with public definition example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/mirroredDatabases

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

Sample response

Status code:
201 
{
  "displayName": "Mirrored database 1",
  "description": "A mirrored database description",
  "type": "MirroredDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

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.
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

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.

ErrorRelatedResource

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

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

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.

ItemType

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

Name Type Description
Dashboard

string

PowerBI dashboard.
DataPipeline

string

A data pipeline.
Datamart

string

PowerBI datamart.
Environment

string

An environment.
Eventhouse

string

An eventhouse.
Eventstream

string

An eventstream.
KQLDashboard

string

A KQL dashboard.
KQLDatabase

string

A KQL database.
KQLQueryset

string

A KQL queryset.
Lakehouse

string

A lakehouse.
MLExperiment

string

A machine learning experiment.
MLModel

string

A machine learning model.
MirroredDatabase

string

A mirrored database.
MirroredWarehouse

string

A mirrored warehouse.
Notebook

string

A notebook.
PaginatedReport

string

PowerBI paginated report.
Reflex

string

A Reflex.
Report

string

PowerBI report.
SQLEndpoint

string

An SQL endpoint.
SemanticModel

string

PowerBI semantic model.
SparkJobDefinition

string

A spark job definition.
Warehouse

string

A warehouse.

MirroredDatabase

A mirrored database item.

Name Type Description
description

string

The item description.
displayName

string

The item display name.
id

string

The item ID.
properties

MirroredDatabaseProperties

The mirrored database properties.
type

ItemType

The item type.
workspaceId

string

The workspace ID.

MirroredDatabaseDefinition

Mirrored database public definition object.

Name Type Description
parts

MirroredDatabaseDefinitionPart[]

A list of definition parts.

MirroredDatabaseDefinitionPart

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

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

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

Name Type Description
InlineBase64

string

Inline Base 64.

SqlEndpointProperties

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

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

Name Type Description
Failed

string

SQL endpoint provisioning failed.
InProgress

string

SQL endpoint provisioning is in progress.
Success

string

SQL endpoint provisioning succeeded.