Items - Publish Environment

服務:: Environment

API 版本:: v1

觸發環境發佈作業。

備註

此 API 是預計於 2027 年 3 月 31 日淘汰的測試版的版本。 呼叫此 API 時 - 呼叫端必須將查詢參數 beta 設定為 false

此 API 支援長時間執行的作業（LRO）。

權限

環境項目的寫入權限。

必要的委派範圍

Item.ReadWrite.All 或 Environment.ReadWrite.All

Microsoft Entra 支援的身份

此 API 支援本節中列出的Microsoft 身分識別。

身份	Support
User	Yes
服務主體和受控識別	Yes

介面

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

URI 參數

名稱	位於	必要	類型	Description
environmentId	path	True	string (uuid)	環境標識碼。
workspaceId	path	True	string (uuid)	工作區識別碼。
beta	query	True	boolean	此參數指定要使用的 API 版本。設定為 `false` 以使用發行版本。

回覆

名稱	類型	Description
200 OK	EnvironmentProperties	已成功提交發佈作業要求。
202 Accepted		已接受要求，發佈作業正在進行中。當 `beta=false` （2027年3月31日後違約）時，會歸還GA合約。標題 Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	服務費率上限被超標。伺服器會回傳一個 `Retry-After` 標頭，以秒數表示客戶端在發送額外請求前必須等待多久。標題 Retry-After: integer
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?beta=false

範例回覆

狀態碼:: 200

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

狀態碼:: 202

Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69
x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69
Retry-After: 120

定義

名稱	Description
ComponentPublishInfo	發佈環境中每個元件的資訊。
EnvironmentProperties	環境屬性。
EnvironmentPublishState	發佈狀態。可能會隨著時間新增其他狀態類型。
ErrorParameter	一個結構化參數，提供關於錯誤的額外機器可讀上下文。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
PublishDetails	發佈作業的詳細數據。
SparkLibraries	Spark 連結庫。
SparkSettings	Spark 設定。

ComponentPublishInfo

Object

發佈環境中每個元件的資訊。

名稱	類型	Description
sparkLibraries	SparkLibraries	Spark 連結庫發佈資訊。
sparkSettings	SparkSettings	Spark 設定發佈資訊。

EnvironmentProperties

Object

環境屬性。

名稱	類型	Description
publishDetails	PublishDetails	環境發佈作業詳細數據。

EnvironmentPublishState

列舉型別

發佈狀態。可能會隨著時間新增其他狀態類型。

值	Description
Success	環境發佈處於成功狀態。
Cancelled	環境發佈處於已取消狀態。
Failed	環境發佈處於失敗狀態。
Cancelling	環境發佈處於取消狀態。
Running	環境發佈處於執行中狀態。
Waiting	環境發佈處於等候狀態。

ErrorParameter

Object

一個結構化參數，提供關於錯誤的額外機器可讀上下文。

名稱	類型	Description
message	string	一個人類可讀的參數意義描述。
name	string	參數識別碼。
value	string	這是參數值。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱	類型	Description
resourceId	string	發生錯誤的資源識別碼。
resourceType	string	發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
isRetriable	boolean	若屬實，請求可重新嘗試。如果有延遲，請使用 `Retry-After` 回應標頭來判斷延遲。
message	string	錯誤的人類可讀取表示法。
moreDetails	ErrorResponseDetails[]	其他錯誤詳細數據的清單。
parameters	ErrorParameter[]	結構化參數提供更多機器可讀的錯誤上下文。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。
requestId	string (uuid)	與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
parameters	ErrorParameter[]	結構化參數提供更多機器可讀的錯誤上下文。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。

PublishDetails

Object

發佈作業的詳細數據。

名稱	類型	Description
componentPublishInfo	ComponentPublishInfo	環境元件發佈資訊。
endTime	string (date-time)	使用 YYYY-MM-DDTHH：mm：ss.ssssssssZ 格式的發佈作業結束時間，以 UTC 為單位。
startTime	string (date-time)	以 UTC 為單位開始發佈作業的時間，使用 YYYY-MM-DDTHH：mm：ss.sssssssZ 格式。
state	EnvironmentPublishState	發佈狀態。可能會隨著時間新增其他狀態類型。
targetVersion	string (uuid)	要發行的目標頂點。

SparkLibraries

Object

Spark 連結庫。

名稱	類型	Description
state	EnvironmentPublishState	發佈狀態。可能會隨著時間新增其他狀態類型。

SparkSettings

Object

Spark 設定。

名稱	類型	Description
state	EnvironmentPublishState	發佈狀態。可能會隨著時間新增其他狀態類型。