Items - Publish Environment (preview)

服务:: Environment

API 版本:: v1

触发环境发布作。

注释

此 API 是预览版的一部分，仅用于评估和开发目的。它可能会根据反馈进行更改，不建议将其用于生产。此预览版 API 将于 2026 年 3 月 1 日弃用，并替换为此处提供的稳定版本。新版本引入了中断性变更，并且不向后兼容。 调用此 API 时，调用方必须指定 true 为查询参数 preview的值。

弃用通知

引入了新的查询参数 preview ，以促进此转换：

查询 preview 参数当前默认为 true.
将查询参数的值 preview 设置为 false 使用此 API 的稳定发布版本。
从 2026 年 3 月 1 日起，默认值 preview 将更改为 false。

建议通过指定falsepreview查询参数（查询参数的默认值preview将设置为 false API 的弃用日期）来迁移集成以尽快使用发布版本。

发布版本中引入了以下不兼容的更改：

响应正在遵循长时间运行的作（LRO）模式，可能会返回 HTTP 响应代码 202。

Permissions

环境项的写入权限。

所需的委派范围

Item.ReadWrite.All 或 Environment.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/publish?preview={preview}

URI 参数

名称	在	必需	类型	说明
environmentId	path	True	string (uuid)	环境 ID。
workspaceId	path	True	string (uuid)	工作区 ID。
preview	query	True	boolean	此参数指定要使用的 API 版本。 `true`设置为使用此页面中所述的预览版本，或使用`false`此处详述的发布版本。从 2026 年 3 月 1 日起，默认值 `preview` 将更改为 `false`。

响应

名称	类型	说明
200 OK	EnvironmentProperties	已成功提交发布作请求。
Other Status Codes	ErrorResponse	常见错误代码： InvalidEnvironmentPublish - 由于错误，失败发布作的版本 <GUID 的环境发布作> 失败：Code = EnvironmentAnotherOngoingPublishProcess。

名称

类型

说明

200 OK

EnvironmentProperties

已成功提交发布作请求。

Other Status Codes

ErrorResponse

常见错误代码：

InvalidEnvironmentPublish - 由于错误，失败发布作的版本 <GUID 的环境发布作> 失败：Code = EnvironmentAnotherOngoingPublishProcess。

示例

Publish environment example

示例请求

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/publish?preview=True

示例响应

状态代码:: 200

{
  "publishDetails": {
    "state": "Running",
    "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
    "startTime": "2024-03-29T14:17:09.0697022Z",
    "componentPublishInfo": {
      "sparkLibraries": {
        "state": "Running"
      },
      "sparkSettings": {
        "state": "Running"
      }
    }
  }
}

定义

名称	说明
ComponentPublishInfo	发布环境中每个组件的信息。
EnvironmentProperties	环境属性。
EnvironmentPublishState	发布状态。可能会随着时间的推移添加其他状态类型。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
PublishDetails	发布作的详细信息。
SparkLibraries	Spark 库。
SparkSettings	Spark 设置。

ComponentPublishInfo

Object

发布环境中每个组件的信息。

名称	类型	说明
sparkLibraries	SparkLibraries	Spark 库发布信息。
sparkSettings	SparkSettings	Spark 设置发布信息。

EnvironmentProperties

Object

环境属性。

名称	类型	说明
publishDetails	PublishDetails	环境发布作详细信息。

EnvironmentPublishState

枚举

发布状态。可能会随着时间的推移添加其他状态类型。

值	说明
Success	环境发布处于成功状态。
Cancelled	环境发布处于已取消状态。
Failed	环境发布处于失败状态。
Cancelling	环境发布处于取消状态。
Running	环境发布处于运行状态。
Waiting	环境发布处于等待状态。

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	与错误相关的资源详细信息。

PublishDetails

Object

发布作的详细信息。

名称	类型	说明
componentPublishInfo	ComponentPublishInfo	环境组件发布信息。
endTime	string (date-time)	使用 YYYY-MM-DDTHH：mm：ss.sssZ 格式结束发布作的时间。
startTime	string (date-time)	使用 YYYY-MM-DDTHH：mm：ss.ssZ 格式开始发布作的时间。
state	EnvironmentPublishState	发布状态。可能会随着时间的推移添加其他状态类型。
targetVersion	string (uuid)	要发布的目标版本。

SparkLibraries

Object

Spark 库。

名称	类型	说明
state	EnvironmentPublishState	发布状态。可能会随着时间的推移添加其他状态类型。

SparkSettings

Object

Spark 设置。

名称	类型	说明
state	EnvironmentPublishState	发布状态。可能会随着时间的推移添加其他状态类型。