通过

Items - Cancel Publish Environment

服务:
Environment
API 版本:
v1

触发环境发布取消。

Permissions

环境项的写入权限。

所需的委派范围

Item.ReadWrite.All 或 Environment.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/cancelPublish

URI 参数

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

string (uuid)

环境 ID。
workspaceId
 path True

string (uuid)

工作区 ID。

响应

名称 类型 说明
200 OK

EnvironmentProperties

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • InvalidEnvironmentCancel - 由于错误导致发布取消>失败的版本 <GUID 的环境取消作失败：Code = EnvironmentUpsupportedStateForCancel。

示例

Publish environment cancellation example

示例请求

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

示例响应

状态代码:
200 
{
  "publishDetails": {
    "state": "Cancelled",
    "targetVersion": "d9d95b01-248f-4ef4-bd7e-9d3f1f6447be",
    "startTime": "2024-03-29T14:17:09.0697022Z",
    "endTime": "2024-03-29T14:48:18.0697022Z",
    "componentPublishInfo": {
      "sparkLibraries": {
        "state": "Cancelled"
      },
      "sparkSettings": {
        "state": "Cancelled"
      }
    }
  }
}

定义

名称 说明
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

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