Bearbeiten

Freigeben über

Mirroring - Get Mirroring Status

  • Reference
Service:
MirroredDatabase
API Version:
v1

Get the status of the mirrored database.

Permissions

The caller must have viewer or higher workspace role.

Required Delegated Scopes

MirroredDatabase.Read.All or MirroredDatabase.ReadWrite.All or Item.Read.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}/getMirroringStatus

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

MirroringStatusResponse

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • UnknownError - An error occurred.

Examples

Get mirroring status example

Sample request

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

Sample response

Status code:
200 
{
  "status": "Running"
}

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
MirroringStatus

The mirroring status type. Additional MirroringStatus types may be added over time.
MirroringStatusResponse

Response of getting mirroring status.

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.

MirroringStatus

The mirroring status type. Additional MirroringStatus types may be added over time.

Name Type Description
Initialized

string

The associated SQL endpoint provisioning is succeeded and the mirrored database is ready for start.
Initializing

string

The associated SQL endpoint provisioning is in progress.
Running

string

The mirroring instance for the mirrored database is running.
Starting

string

The mirroring instance for the mirrored database is starting.
Stopped

string

The mirroring instance for the mirrored database is stopped.
Stopping

string

The mirroring instance for the mirrored database is stopping.

MirroringStatusResponse

Response of getting mirroring status.

Name Type Description
error

ErrorResponse

Error is set if error happens in mirroring
status

MirroringStatus

The status of mirroring