Items - Create Mirrored Database

服务:

MirroredDatabase

API 版本:

v1

在指定的工作区中创建镜像数据库。
此 API 不支持在没有定义的情况下创建镜像数据库。 若要创建具有定义的镜像数据库，请参阅 镜像数据库定义 一文。

权限

调用方必须具有 参与者 或更高版本的工作区角色。

所需的委派范围

MirroredDatabase.ReadWrite.All 或 Item.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份	支持
用户	是的
服务主体 和 托管标识	是的

接口

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

URI 参数

名称	在	必需	类型	说明
workspaceId	path	True	string uuid	工作区 ID。

请求正文

名称	必需	类型	说明
definition	True	MirroredDatabaseDefinition	镜像数据库公共定义。
displayName	True	string	镜像数据库显示名称。 显示名称必须遵循项类型的命名规则。
description		string	镜像数据库说明。 最大长度为 256 个字符。

响应

名称	类型	说明
201 Created	MirroredDatabase	已成功创建
Other Status Codes	ErrorResponse	常见错误代码： InvalidItemType - 项类型无效 ItemDisplayNameAlreadyInUse - 项显示名称已被使用。 CorruptedPayload - 提供的有效负载已损坏。

示例

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"
}

定义

名称	说明
CreateMirroredDatabaseRequest	创建镜像数据库请求有效负载。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ItemType	项的类型。 可能会随着时间的推移添加其他项类型。
MirroredDatabase	镜像数据库项。
MirroredDatabaseDefinition	镜像数据库公共定义对象。
MirroredDatabaseDefinitionPart	镜像数据库定义部件对象。
MirroredDatabaseProperties	镜像数据库属性。
PayloadType	定义部件有效负载的类型。 可能会随着时间的推移添加其他有效负载类型。
SqlEndpointProperties	包含 SQL 终结点属性的对象。
SqlEndpointProvisioningStatus	SQL 终结点预配状态类型。 可能会随着时间的推移添加其他 SqlEndpointProvisioningStatus 类型。

CreateMirroredDatabaseRequest

Object

创建镜像数据库请求有效负载。

名称	类型	说明
definition	MirroredDatabaseDefinition	镜像数据库公共定义。
description	string	镜像数据库说明。 最大长度为 256 个字符。
displayName	string	镜像数据库显示名称。 显示名称必须遵循项类型的命名规则。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

ItemType

Enumeration

项的类型。 可能会随着时间的推移添加其他项类型。

值	说明
Dashboard	PowerBI 仪表板。
DataPipeline	数据管道。
Datamart	PowerBI Datamart。
Environment	环境。
Eventhouse	事件屋。
Eventstream	事件流。
GraphQLApi	GraphQL 项的 API。
KQLDashboard	KQL 仪表板。
KQLDatabase	KQL 数据库。
KQLQueryset	KQL 查询集。
Lakehouse	湖屋
MLExperiment	机器学习试验。
MLModel	机器学习模型。
MirroredDatabase	镜像数据库。
MirroredWarehouse	镜像仓库。
MountedDataFactory	MountedDataFactory。
Notebook	笔记本。
PaginatedReport	PowerBI 分页报表。
Reflex	反射。
Report	PowerBI 报表。
SQLDatabase	SQLDatabase。
SQLEndpoint	SQL 终结点。
SemanticModel	PowerBI 语义模型。
SparkJobDefinition	spark 作业定义。
Warehouse	仓库。

MirroredDatabase

Object

镜像数据库项。

名称	类型	说明
description	string	项说明。
displayName	string	项显示名称。
id	string uuid	项 ID。
properties	MirroredDatabaseProperties	镜像数据库属性。
type	ItemType	项类型。
workspaceId	string uuid	工作区 ID。

MirroredDatabaseDefinition

Object

镜像数据库公共定义对象。

名称	类型	说明
parts	MirroredDatabaseDefinitionPart[]	定义部件的列表。

MirroredDatabaseDefinitionPart

Object

镜像数据库定义部件对象。

名称	类型	说明
path	string	镜像数据库部件路径。
payload	string	镜像数据库部件有效负载。
payloadType	PayloadType	有效负载类型。

MirroredDatabaseProperties

Object

镜像数据库属性。

名称	类型	说明
defaultSchema	string	镜像数据库的默认架构。 仅针对在定义中启用默认架构的镜像数据库返回此属性。
oneLakeTablesPath	string	镜像数据库表目录的 OneLake 路径。
sqlEndpointProperties	SqlEndpointProperties	包含 SQL 终结点属性的对象。

PayloadType

Enumeration

定义部件有效负载的类型。 可能会随着时间的推移添加其他有效负载类型。

值	说明
InlineBase64	内联基线 64。

SqlEndpointProperties

Object

包含 SQL 终结点属性的对象。

名称	类型	说明
connectionString	string	SQL 终结点连接字符串。
id	string	SQL 终结点 ID。
provisioningStatus	SqlEndpointProvisioningStatus	SQL 终结点预配状态。

SqlEndpointProvisioningStatus

Enumeration

SQL 终结点预配状态类型。 可能会随着时间的推移添加其他 SqlEndpointProvisioningStatus 类型。

值	说明
Failed	SQL 终结点预配失败。
InProgress	SQL 终结点预配正在进行中。
Success	SQL 终结点预配成功。