Edit

Share via

Items - List Mirrored Databases

Service:
MirroredDatabase
API Version:
v1

Returns a list of mirrored databases from the specified workspace.
This API supports pagination.

Permissions

The caller must have a viewer workspace role.

Required Delegated Scopes

Workspace.Read.All or Workspace.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

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredDatabases
With optional parameters: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredDatabases?continuationToken={continuationToken}

URI Parameters

Name In Required Type Description
workspaceId
 path True

string (uuid)

The workspace ID.
continuationToken
 query

string

A token for retrieving the next page of results.

Responses

Name Type Description
200 OK

MirroredDatabases

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • InvalidItemType - Invalid item type.

Examples

List mirrored databases in workspace example

Sample request

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

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2",
      "displayName": "Mirrored database 1",
      "description": "A mirrored database description.",
      "type": "MirroredDatabase",
      "workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
      "properties": {
        "oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2/Tables",
        "sqlEndpointProperties": {
          "connectionString": "xxx.datawarehouse.fabric.microsoft.com",
          "id": "c2c2c2c2-dddd-eeee-ffff-a3a3a3a3a3a3",
          "provisioningStatus": "Success"
        },
        "defaultSchema": "dbo"
      }
    }
  ]
}

Definitions

Name Description
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.
MirroredDatabaseProperties

The mirrored database properties.
MirroredDatabases

A list of mirrored databases.
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.

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
Dashboard

PowerBI dashboard.
Report

PowerBI report.
SemanticModel

PowerBI semantic model.
PaginatedReport

PowerBI paginated report.
Datamart

PowerBI datamart.
Lakehouse

A lakehouse.
Eventhouse

An eventhouse.
Environment

An environment.
KQLDatabase

A KQL database.
KQLQueryset

A KQL queryset.
KQLDashboard

A KQL dashboard.
DataPipeline

A data pipeline.
Notebook

A notebook.
SparkJobDefinition

A spark job definition.
MLExperiment

A machine learning experiment.
MLModel

A machine learning model.
Warehouse

A warehouse.
Eventstream

An eventstream.
SQLEndpoint

An SQL endpoint.
MirroredWarehouse

A mirrored warehouse.
MirroredDatabase

A mirrored database.
Reflex

A Reflex.
GraphQLApi

An API for GraphQL item.
MountedDataFactory

A MountedDataFactory.
SQLDatabase

A SQLDatabase.
CopyJob

A Copy job.
VariableLibrary

A VariableLibrary.
Dataflow

A Dataflow.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

A Warehouse snapshot.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

A Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog

A mirrored azure databricks catalog.
Map

A Map.
AnomalyDetector

An Anomaly Detector.
UserDataFunction

A User Data Function.
GraphModel

A GraphModel.
GraphQuerySet

A Graph QuerySet.

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.

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.

MirroredDatabases

Object

A list of mirrored databases.

Name Type Description
continuationToken

string

The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri

string

The URI of the next result set batch. If there are no more records, it's removed from the response.
value

MirroredDatabase[]

A list of mirrored databases.

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
InProgress

SQL endpoint provisioning is in progress.
Success

SQL endpoint provisioning succeeded.
Failed

SQL endpoint provisioning failed.