Items - Get Mirrored Database Definition

Service:

MirroredDatabase

API Version:

v1

Returns the specified mirrored database public definition.

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/{mirroredDatabaseId}/getDefinition

URI Parameters

Name	In	Required	Type	Description
mirroredDatabaseId	path	True	string uuid	The mirrored database ID.
workspaceId	path	True	string uuid	The workspace ID.

Responses

Name	Type	Description
200 OK	MirroredDatabaseDefinitionResponse	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: OperationNotSupportedForItem - Operation not supported for requested item.

Examples

Get a mirrored database definition example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/mirroredDatabases/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Sample response

Status code:

200

{
  "definition": {
    "parts": [
      {
        "path": "mirroredDatabase.json",
        "payload": "eyAicHJvcGVydGllcy..WJsZSIgfSB9IH0gXSB9IH0",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
MirroredDatabaseDefinition	Mirrored database public definition object.
MirroredDatabaseDefinitionPart	Mirrored database definition part object.
MirroredDatabaseDefinitionResponse	Mirrored database public definition response.
PayloadType	The type of the definition part payload. Additional payload types may be added over time.

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.

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.

MirroredDatabaseDefinitionResponse

Mirrored database public definition response.

Name	Type	Description
definition	MirroredDatabaseDefinition	Mirrored database public definition object.

PayloadType

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

Name	Type	Description
InlineBase64	string	Inline Base 64.