Items - Create Environment

服務:

Environment

API 版本:

v1

在指定的工作區中建立環境。
此 API 支援 長時間執行的作業 （LRO）。

此 API 不支援使用定義建立環境。

權限

呼叫者必須具有 參與者 或更高的工作區角色。

必要的委派範圍

Environment.ReadWrite.All 或 Item.ReadWrite.All

局限性

• 若要建立環境，工作區必須位於支援的 Fabric 容量上。

Microsoft Entra 支援的身分識別

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

身份	支援
使用者	是的
服務主體 和 受控識別	是的

介面

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

URI 參數

名稱	位於	必要	類型	Description
workspaceId	path	True	string uuid	工作區標識碼。

要求本文

名稱	必要	類型	Description
displayName	True	string	環境顯示名稱。
description		string	環境描述。 長度上限為 256 個字元。

回應

名稱	類型	Description
201 Created	Environment	已成功建立
202 Accepted		要求已接受，正在進行環境布建 標題 Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	常見的錯誤碼： InvalidItemType - 項目類型無效 ItemDisplayNameAlreadyInUse - 已使用項目顯示名稱 CorruptedPayload - 提供的承載已損毀

範例

Create a environment example

範例要求

HTTP

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

{
  "displayName": "Environment_1",
  "description": "An environment description"
}

範例回覆

狀態碼:

201

{
  "displayName": "Environment_1",
  "description": "An environment description",
  "type": "Environment",
  "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

定義

名稱	Description
ComponentPublishInfo	發佈環境中每個元件的資訊。
CreateEnvironmentRequest	建立環境要求承載。
Environment	環境專案。
EnvironmentPublishInfo	環境發佈資訊。
EnvironmentPublishState	發佈狀態。 可能會隨著時間新增其他狀態類型。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
ItemType	專案的型別。 可能會隨著時間新增其他項目類型。
PublishDetails	發佈作業的詳細數據。
SparkLibraries	Spark 連結庫。
SparkSettings	Spark 設定。

ComponentPublishInfo

Object

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

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

CreateEnvironmentRequest

Object

建立環境要求承載。

名稱	類型	Description
description	string	環境描述。 長度上限為 256 個字元。
displayName	string	環境顯示名稱。

Environment

Object

環境專案。

名稱	類型	Description
description	string	專案描述。
displayName	string	項目顯示名稱。
id	string uuid	項目標識碼。
properties	EnvironmentPublishInfo	環境屬性。
type	ItemType	項目類型。
workspaceId	string uuid	工作區標識碼。

EnvironmentPublishInfo

Object

環境發佈資訊。

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

EnvironmentPublishState

Enumeration

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

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

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
moreDetails	ErrorResponseDetails[]	其他錯誤詳細數據的清單。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。
requestId	string	與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

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

ItemType

Enumeration

專案的型別。 可能會隨著時間新增其他項目類型。

值	Description
Dashboard	PowerBI 儀錶板。
DataPipeline	數據管線。
Datamart	PowerBI datamart。
Environment	環境。
Eventhouse	事件屋。
Eventstream	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	倉儲。

PublishDetails

Object

發佈作業的詳細數據。

名稱	類型	Description
componentPublishInfo	ComponentPublishInfo	環境元件發佈資訊。
endTime	string date-time	發佈作業的結束時間。
startTime	string date-time	發佈作業的開始時間。
state	EnvironmentPublishState	發佈狀態。 可能會隨著時間新增其他狀態類型。
targetVersion	string uuid	要發行的目標頂點。

SparkLibraries

Object

Spark 連結庫。

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

SparkSettings

Object

Spark 設定。

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