Items - Get Mirrored Database Definition

Служба:

MirroredDatabase

Версия API:

v1

Возвращает указанное открытое определение зеркальной базы данных.
Этот API поддерживает длительные операции (LRO).

Разрешения

Вызывающий объект должен иметь разрешения на чтение и запись для зеркальной базы данных.

Обязательные делегированные области

MirroredDatabase.ReadWrite.All или Item.ReadWrite.All

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Поддержка
Пользователь	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
mirroredDatabaseId	path	True	string (uuid)	Идентификатор зеркальной базы данных.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.

Ответы

Имя	Тип	Описание
200 OK	MirroredDatabaseDefinitionResponse	Запрос успешно завершен.
202 Accepted		Запрос принят. Получение определения выполняется. Заголовки Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: OperationNotSupportedForItem — операция не поддерживается для запрошенного элемента.

Примеры

Get a mirrored database definition example

Образец запроса

HTTP

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

Пример ответа

Код состояния:

200

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

Код состояния:

202

Location: https://api.fabric.microsoft.com/v1/operations/0000aaaa-11bb-cccc-dd22-eeeeee333333
x-ms-operation-id: 0000aaaa-11bb-cccc-dd22-eeeeee333333
Retry-After: 30

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
MirroredDatabaseDefinition	Объект открытого определения зеркальной базы данных.
MirroredDatabaseDefinitionPart	Объект части определения зеркальной базы данных.
MirroredDatabaseDefinitionResponse	Ответ общедоступного определения базы данных зеркального отображения.
PayloadType	Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

ErrorRelatedResource

Object

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Object

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Object

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

MirroredDatabaseDefinition

Object

Объект открытого определения зеркальной базы данных.

Имя	Тип	Описание
parts	MirroredDatabaseDefinitionPart[]	Список частей определения.

MirroredDatabaseDefinitionPart

Object

Объект части определения зеркальной базы данных.

Имя	Тип	Описание
path	string	Путь к части зеркальной базы данных.
payload	string	Полезные данные части зеркальной базы данных.
payloadType	PayloadType	Тип полезных данных.

MirroredDatabaseDefinitionResponse

Object

Ответ общедоступного определения базы данных зеркального отображения.

Имя	Тип	Описание
definition	MirroredDatabaseDefinition	Объект открытого определения зеркальной базы данных.

PayloadType

Перечисление

Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

Значение	Описание
InlineBase64	Встроенная база 64.