通过

Items - Create Item

  • 参考
服务:
Core
API 版本:
v1

在指定的工作区中创建项。
许多项类型都支持此 API，可在 项管理概述中找到受支持的项类型。 可以使用 获取项定义 API 来获取项定义。

此 API 支持 长时间运行的作（LRO）。

权限

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

所需的委派范围

对于项 API，请使用以下范围类型：

  • 泛型范围：Item.ReadWrite.All
  • 特定范围：itemType。ReadWrite.All（例如：Notebook.ReadWrite.All）

有关范围的详细信息，请参阅 范围文章。

局限性

  • 若要创建非 PowerBI Fabric 项，工作区必须具有受支持的 Fabric 容量。 有关详细信息，请参阅 Microsoft Fabric 许可证类型。
  • 若要创建 PowerBI 项，用户必须具有相应的许可证。 有关详细信息，请参阅 Microsoft Fabric 许可证类型。
  • 创建项时，请使用 creationPayload 或 definition，但不能同时使用两者。

Microsoft Entra 支持的标识

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

身份 支持
用户 是的
服务主体 和 托管标识 支持调用中的项类型时。 检查要调用的项目类型的相应 API，以查看调用是否受支持。 例如，支持语义模型。

接口

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

URI 参数

名称 在 必需 类型 说明
workspaceId
 path True

string

uuid

工作区 ID。

请求正文

名称 必需 类型 说明
displayName True

string

项显示名称。 显示名称必须遵循项类型的命名规则。
type True

ItemType

项类型。
creationPayload

object

用于创建项的一组属性。 相关类型的 “创建项”页指示是否支持 creationPayload 并列出项的属性。 使用 creationPayload 或 definition。 不能同时使用这两者。
definition

ItemDefinition

项定义。 相关类型的 创建项 页指示是否支持定义并详细说明其结构。 使用 definition 或 creationPayload。 不能同时使用这两者。
description

string

项说明。 最大长度为 256 个字符。

响应

名称 类型 说明
201 Created

Item

已成功创建
202 Accepted

请求已接受，正在进行项预配

标头

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

常见错误代码：

  • InvalidItemType - 项类型无效。

  • ItemDisplayNameAlreadyInUse - 项显示名称已被使用。

  • CorruptedPayload - 提供的有效负载已损坏

示例

Create an item example

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items

{
  "displayName": "Item 1",
  "type": "Lakehouse"
}

示例响应

状态代码:
201 
{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
状态代码:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

定义

名称 说明
CreateItemRequest

创建项请求有效负载。
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
Item

项对象。
ItemDefinition

项定义对象。
ItemDefinitionPart

项定义部件对象。
ItemType

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

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

CreateItemRequest

Object

创建项请求有效负载。

名称 类型 说明
creationPayload

object

用于创建项的一组属性。 相关类型的 “创建项”页指示是否支持 creationPayload 并列出项的属性。 使用 creationPayload 或 definition。 不能同时使用这两者。
definition

ItemDefinition

项定义。 相关类型的 创建项 页指示是否支持定义并详细说明其结构。 使用 definition 或 creationPayload。 不能同时使用这两者。
description

string

项说明。 最大长度为 256 个字符。
displayName

string

项显示名称。 显示名称必须遵循项类型的命名规则。
type

ItemType

项类型。

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

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

Item

Object

项对象。

名称 类型 说明
description

string

项说明。
displayName

string

项显示名称。
id

string

uuid

项 ID。
type

ItemType

项类型。
workspaceId

string

uuid

工作区 ID。

ItemDefinition

Object

项定义对象。

名称 类型 说明
format

string

项定义的格式。
parts

ItemDefinitionPart[]

定义部件的列表。

ItemDefinitionPart

Object

项定义部件对象。

名称 类型 说明
path

string

项部件路径。
payload

string

项部件有效负载。
payloadType

PayloadType

有效负载类型。

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

仓库。

PayloadType

Enumeration

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

值 说明
InlineBase64

内联基线 64。