Items - Create Mirrored Database

Служба:: MirroredDatabase

Версия API:: v1

Создает зеркальную базу данных в указанной рабочей области.
Этот API не поддерживает создание зеркальной базы данных без определения. Чтобы создать зеркальную базу данных с определением, ознакомьтесь с определении зеркальной базы данных статье.

Разрешения

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

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

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

поддерживаемые удостоверения Microsoft Entra

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

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

Интерфейс

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

Параметры URI

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

Текст запроса

Имя	Обязательно	Тип	Описание
definition	True	MirroredDatabaseDefinition	Открытое определение зеркальной базы данных.
displayName	True	string	Отображаемое имя зеркальной базы данных. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.
description		string	Описание зеркальной базы данных. Максимальная длина — 256 символов.
folderId		string (uuid)	Идентификатор папки. Если не задано или не задано значение NULL, зеркальная база данных создается в рабочей области в качестве папки.
sensitivityLabelSettings		SensitivityLabelSettings	Параметры метки конфиденциальности для зеркальной базы данных.

Ответы

Имя Тип Описание

201 Created

Имя	Тип	Описание
201 Created	MirroredDatabase	Успешно создано
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: InvalidItemType — тип элемента недопустим ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется. Поврежденный Payload — предоставленные полезные данные повреждены. WorkspaceItemsLimitExceed — превышено ограничение элемента рабочей области.

MirroredDatabase

Успешно создано

429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

InvalidItemType — тип элемента недопустим
ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется.
Поврежденный Payload — предоставленные полезные данные повреждены.
WorkspaceItemsLimitExceed — превышено ограничение элемента рабочей области.

Примеры

Create a mirrored database with public definition example

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

HTTP

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

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

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

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

{
  "displayName": "Mirrored database 1",
  "description": "A mirrored database description",
  "type": "MirroredDatabase",
  "workspaceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
  "id": "b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Определения

Имя	Описание
CreateMirroredDatabaseRequest	Создайте полезные данные запроса зеркальной базы данных.
EntireTenantPrincipal	Представляет субъект клиента
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
GroupPrincipal	Представляет группу безопасности.
GroupType	Тип группы. С течением времени могут добавляться дополнительные типы групп.
ItemTag	Представляет тег, примененный к элементу.
ItemType	Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
MirroredDatabase	Зеркальный элемент базы данных.
MirroredDatabaseDefinition	Объект открытого определения зеркальной базы данных. Дополнительные сведения о структуре определения зеркальной базы данных см. в этой статье .
MirroredDatabaseDefinitionPart	Объект части определения зеркальной базы данных.
MirroredDatabaseProperties	Свойства зеркальной базы данных.
PayloadType	Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.
PrincipalType	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
SensitivityLabel	Представляет метку конфиденциальности, примененную к элементу.
SensitivityLabelApplyStrategy	Стратегия применения метки конфиденциальности. Значением по умолчанию является ApplyOrFail. С течением времени могут добавляться дополнительные типы.
SensitivityLabelSettings	Параметры метки конфиденциальности.
ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
ServicePrincipalPrincipal	Представляет субъект-службу Microsoft Entra.
ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Представляет профиль субъекта-службы.
SqlEndpointProperties	Объект, содержащий свойства конечной точки SQL.
SqlEndpointProvisioningStatus	Тип состояния подготовки конечной точки SQL. С течением времени могут добавляться дополнительные `SqlEndpointProvisioningStatus` типы.
UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.
UserPrincipal	Представляет субъект пользователя Microsoft Entra.

CreateMirroredDatabaseRequest

Объект

Создайте полезные данные запроса зеркальной базы данных.

Имя	Тип	Описание
definition	MirroredDatabaseDefinition	Открытое определение зеркальной базы данных.
description	string	Описание зеркальной базы данных. Максимальная длина — 256 символов.
displayName	string	Отображаемое имя зеркальной базы данных. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.
folderId	string (uuid)	Идентификатор папки. Если не задано или не задано значение NULL, зеркальная база данных создается в рабочей области в качестве папки.
sensitivityLabelSettings	SensitivityLabelSettings	Параметры метки конфиденциальности для зеркальной базы данных.

EntireTenantPrincipal

Объект

Представляет субъект клиента

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
type	string: EntireTenant	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

ErrorRelatedResource

Объект

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

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

ErrorResponse

Объект

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

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

ErrorResponseDetails

Объект

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

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

GroupDetails

Объект

Группировка конкретных сведений. Применимо, если тип субъекта Group.

Имя	Тип	Описание
groupType	GroupType	Тип группы. С течением времени могут добавляться дополнительные типы групп.

GroupPrincipal

Объект

Представляет группу безопасности.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
groupDetails	GroupDetails	Группировка конкретных сведений. Применимо, если тип субъекта `Group`.
id	string (uuid)	Идентификатор субъекта.
type	string: Group	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

GroupType

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

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

Значение	Описание
Unknown	Тип основной группы неизвестен.
SecurityGroup	Субъект — это группа безопасности.
DistributionList	Субъект — это список рассылки.

ItemTag

Объект

Представляет тег, примененный к элементу.

Имя	Тип	Описание
displayName	string	Имя тега.
id	string (uuid)	Идентификатор тега.

ItemType

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

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

Значение	Описание
Dashboard	Панель мониторинга PowerBI.
Report	Отчет PowerBI.
SemanticModel	Семантическая модель PowerBI.
PaginatedReport	Отчет с разбивкой на страницы PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Озеро.
Eventhouse	Хранилище событий.
Environment	Среда.
KQLDatabase	База данных KQL.
KQLQueryset	Набор запросов KQL.
KQLDashboard	Панель мониторинга KQL.
DataPipeline	Конвейер данных.
Notebook	Записная книжка.
SparkJobDefinition	Определение задания Spark.
MLExperiment	Эксперимент машинного обучения.
MLModel	Модель машинного обучения.
Warehouse	Склад.
Eventstream	Поток событий.
SQLEndpoint	Конечная точка SQL.
MirroredWarehouse	Зеркальный склад.
MirroredDatabase	Зеркальная база данных.
Reflex	Рефлекс.
GraphQLApi	API для элемента GraphQL.
MountedDataFactory	ПодключеннаяdataFactory.
SQLDatabase	База данных SQLDatabase.
CopyJob	Задание копирования.
VariableLibrary	ПеременнаяLibrary.
Dataflow	Поток данных.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Моментальный снимок хранилища.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Поток Конструктора цифровых двойников.
MirroredAzureDatabricksCatalog	Зеркальный каталог azure databricks.
Map	Карта.
AnomalyDetector	Детектор аномалий.
UserDataFunction	Функция данных пользователя.
GraphModel	A GraphModel.
GraphQuerySet	Набор запросов Graph.
SnowflakeDatabase	База данных Snowflake для хранения таблиц Iceberg, созданных из учетной записи Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	База данных Cosmos DB.
Ontology	An Ontology.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	ЗеркальныйCatalog.
AppBackend	An AppBackend.
OrgApp	Приложение организации.
OrgAppAudience	Аудитория приложений организации.
DataBuildToolJob	A DataBuildToolJob.
AzureDatabricksStorage	Элемент хранилища с поддержкой OneLake для Azure Databricks.
Plan	План.

MirroredDatabase

Объект

Зеркальный элемент базы данных.

Имя	Тип	Описание
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Удостоверение элемента по умолчанию.
description	string	Описание элемента.
displayName	string	Отображаемое имя элемента.
folderId	string (uuid)	Идентификатор папки.
id	string (uuid)	Идентификатор элемента.
properties	MirroredDatabaseProperties	Свойства зеркальной базы данных.
sensitivityLabel	SensitivityLabel	Метка конфиденциальности элементов.
tags	ItemTag[]	Список примененных тегов.
type	ItemType	Тип элемента.
workspaceId	string (uuid)	Идентификатор рабочей области.

MirroredDatabaseDefinition

Объект

Объект открытого определения зеркальной базы данных. Дополнительные сведения о структуре определения зеркальной базы данных см. в этой статье .

Имя	Тип	Описание
format	string	Формат определения зеркальной базы данных.
parts	MirroredDatabaseDefinitionPart[]	Список частей определения.

MirroredDatabaseDefinitionPart

Объект

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

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

MirroredDatabaseProperties

Объект

Свойства зеркальной базы данных.

Имя	Тип	Описание
defaultSchema	string	Схема по умолчанию зеркальной базы данных. Это свойство возвращается только для зеркальной базы данных, которая включает схему по умолчанию в определении.
oneLakeTablesPath	string	Путь OneLake к каталогу зеркальных таблиц баз данных.
sqlEndpointProperties	SqlEndpointProperties	Объект, содержащий свойства конечной точки SQL.

PayloadType

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

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

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

PrincipalType

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

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

Значение	Описание
User	Субъект является субъектом-пользователем Microsoft Entra.
ServicePrincipal	Субъект является субъектом-службой Microsoft Entra.
Group	Субъект — это группа безопасности.
ServicePrincipalProfile	Субъект — это профиль субъекта-службы.
EntireTenant	Субъект представляет всех пользователей клиента.

SensitivityLabel

Объект

Представляет метку конфиденциальности, примененную к элементу.

Имя	Тип	Описание
id	string (uuid)	Идентификатор метки конфиденциальности.

SensitivityLabelApplyStrategy

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

Стратегия применения метки конфиденциальности. Значением по умолчанию является ApplyOrFail. С течением времени могут добавляться дополнительные типы.

Значение	Описание
ApplyOrFail	Примените метку конфиденциальности или сбой операции, если она не может быть применена.
Ignore	Игнорируйте метку конфиденциальности, если ее нельзя применить и продолжить операцию без применения метки.

SensitivityLabelSettings

Объект

Параметры метки конфиденциальности.

Имя	Тип	Описание
labelId	string (uuid)	Идентификатор метки конфиденциальности.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Стратегия применения метки конфиденциальности.

ServicePrincipalDetails

Объект

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.

Имя	Тип	Описание
aadAppId	string (uuid)	Microsoft Entra AppId субъекта-службы.

ServicePrincipalPrincipal

Объект

Представляет субъект-службу Microsoft Entra.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
servicePrincipalDetails	ServicePrincipalDetails	Сведения о субъекте-службе. Применимо, если тип субъекта `ServicePrincipal`.
type	string: ServicePrincipal	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

ServicePrincipalProfileDetails

Объект

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.

Имя	Тип	Описание
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Родительский субъект профиля субъекта-службы.

ServicePrincipalProfilePrincipal

Объект

Представляет профиль субъекта-службы.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Сведения о профиле субъекта-службы. Применимо, если тип субъекта `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.

SqlEndpointProperties

Объект

Объект, содержащий свойства конечной точки SQL.

Имя	Тип	Описание
connectionString	string	Конечная точка SQL строка подключения.
id	string	Идентификатор конечной точки SQL.
provisioningStatus	SqlEndpointProvisioningStatus	Состояние подготовки конечной точки SQL.

SqlEndpointProvisioningStatus

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

Тип состояния подготовки конечной точки SQL. С течением времени могут добавляться дополнительные SqlEndpointProvisioningStatus типы.

Значение	Описание
InProgress	Подготовка конечной точки SQL выполняется.
Success	Подготовка конечной точки SQL завершилась успешно.
Failed	Сбой подготовки конечной точки SQL.

UserDetails

Объект

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.

Имя	Тип	Описание
userPrincipalName	string	Основное имя пользователя.

UserPrincipal

Объект

Представляет субъект пользователя Microsoft Entra.

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта.
id	string (uuid)	Идентификатор субъекта.
type	string: User	Тип субъекта. С течением времени могут добавляться дополнительные типы субъектов.
userDetails	UserDetails	Сведения о субъекте-пользователе. Применимо, если тип субъекта `User`.