Items - Create Environment

服務:: Environment

API 版本:: v1

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

權限

呼叫端必須具有 參與者 工作區角色。

必要的委派範圍

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	環境顯示名稱。
definition		EnvironmentDefinition	環境公共定義。
description		string	環境描述。長度上限為 256 個字元。
folderId		string (uuid)	資料夾識別碼。如果未指定或 Null，則會使用工作區作為其資料夾來建立環境。

回應

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

名稱

類型

Description

201 Created

Environment

已成功建立

202 Accepted

要求已接受，正在進行環境布建

標題

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

常見的錯誤碼：

InvalidItemType - 項目類型無效
ItemDisplayNameAlreadyInUse - 已使用項目顯示名稱
CorruptedPayload - 提供的承載已損毀。
WorkspaceItemsLimitExceeded - 超過工作區專案限制。

範例

Create an environment example

Create an environment with public definition example

Create an 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

Create an environment with public definition example

範例要求

HTTP

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

{
  "displayName": "Environment_1",
  "description": "An environment description.",
  "definition": {
    "parts": [
      {
        "path": "Libraries/CustomLibraries/samplelibrary.jar",
        "payload": "eyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplepython.py",
        "payload": "FyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplewheel-0.18.0-py2.py3-none-any.whl",
        "payload": "LyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/sampleR.tar.gz",
        "payload": "ZyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/PublicLibraries/environment.yml",
        "payload": "IyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Setting/Sparkcompute.yml",
        "payload": "GyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

範例回覆

狀態碼:: 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	環境專案。
EnvironmentDefinition	環境公用定義物件。請參閱本文，以取得如何製作環境公用定義的詳細資訊。
EnvironmentDefinitionPart	環境定義零件物件。
EnvironmentProperties	環境屬性。
EnvironmentPublishState	發佈狀態。可能會隨著時間新增其他狀態類型。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。
ItemTag	表示在專案上套用的標記。
ItemType	專案的型別。可能會隨著時間新增其他項目類型。
PayloadType	定義元件承載的類型。可能會隨著時間新增其他承載類型。
PublishDetails	發佈作業的詳細數據。
SparkLibraries	Spark 連結庫。
SparkSettings	Spark 設定。

ComponentPublishInfo

Object

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

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

CreateEnvironmentRequest

Object

建立環境要求承載。

名稱	類型	Description
definition	EnvironmentDefinition	環境公共定義。
description	string	環境描述。長度上限為 256 個字元。
displayName	string	環境顯示名稱。
folderId	string (uuid)	資料夾識別碼。如果未指定或 Null，則會使用工作區作為其資料夾來建立環境。

Environment

Object

環境專案。

名稱	類型	Description
description	string	專案描述。
displayName	string	項目顯示名稱。
folderId	string (uuid)	資料夾識別碼。
id	string (uuid)	項目標識碼。
properties	EnvironmentProperties	環境屬性。
tags	ItemTag[]	已套用標籤的清單。
type	ItemType	項目類型。
workspaceId	string (uuid)	工作區標識碼。

EnvironmentDefinition

Object

環境公用定義物件。請參閱本文，以取得如何製作環境公用定義的詳細資訊。

名稱	類型	Description
format	string	環境定義的格式。
parts	EnvironmentDefinitionPart[]	定義元件的清單。

EnvironmentDefinitionPart

Object

環境定義零件物件。

名稱	類型	Description
path	string	環境部分路徑。
payload	string	環境部分承載。
payloadType	PayloadType	承載類型。

EnvironmentProperties

Object

環境屬性。

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

EnvironmentPublishState

列舉型別

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

值	Description
Success	環境發佈處於成功狀態。
Cancelled	環境發佈處於已取消狀態。
Failed	環境發佈處於失敗狀態。
Cancelling	環境發佈處於取消狀態。
Running	環境發佈處於執行中狀態。
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	錯誤相關的資源詳細數據。

ItemTag

Object

表示在專案上套用的標記。

名稱	類型	Description
displayName	string	標籤的名稱。
id	string (uuid)	標記標識碼。

ItemType

列舉型別

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

值	Description
Dashboard	PowerBI 儀錶板。
Report	PowerBI 報表。
SemanticModel	PowerBI 語意模型。
PaginatedReport	PowerBI 編頁報表。
Datamart	PowerBI datamart。
Lakehouse	湖屋
Eventhouse	事件屋。
Environment	環境。
KQLDatabase	KQL 資料庫。
KQLQueryset	KQL 查詢集。
KQLDashboard	KQL 儀錶板。
DataPipeline	數據管線。
Notebook	筆記本。
SparkJobDefinition	Spark 作業定義。
MLExperiment	機器學習實驗。
MLModel	機器學習模型。
Warehouse	倉儲。
Eventstream	eventstream。
SQLEndpoint	SQL 端點。
MirroredWarehouse	鏡像倉儲。
MirroredDatabase	鏡像資料庫。
Reflex	反射。
GraphQLApi	GraphQL 專案的 API。
MountedDataFactory	MountedDataFactory。
SQLDatabase	SQLDatabase。
CopyJob	複製作業。
VariableLibrary	VariableLibrary。
Dataflow	數據流。
ApacheAirflowJob	ApacheAirflowJob。
WarehouseSnapshot	倉儲快照集。
DigitalTwinBuilder	DigitalTwinBuilder。
DigitalTwinBuilderFlow	數字對應項產生器流程。
MirroredAzureDatabricksCatalog	鏡像的 Azure databricks 目錄。
Map	一張地圖。
AnomalyDetector	異常偵測器。
UserDataFunction	使用者資料函數。
GraphModel	GraphModel 的 GraphModel。
GraphQuerySet	圖形 QuerySet。
SnowflakeDatabase	一個 Snowflake 資料庫，用來儲存由 Snowflake 帳號建立的 Iceberg 表格。
OperationsAgent	一個行動特工。
CosmosDBDatabase	一個 Cosmos 資料庫。

PayloadType

列舉型別

定義元件承載的類型。可能會隨著時間新增其他承載類型。

值	Description
InlineBase64	內嵌基底 64。

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	發佈狀態。可能會隨著時間新增其他狀態類型。

共用方式為

Items - Create Environment

權限

必要的委派範圍

局限性

Microsoft Entra 支援的身分識別

介面

URI 參數

要求本文

回應

範例

Create an environment example

範例要求

範例回覆

Create an environment with public definition example

範例要求

範例回覆

定義

ComponentPublishInfo

CreateEnvironmentRequest

Environment

EnvironmentDefinition

EnvironmentDefinitionPart

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PayloadType

PublishDetails

SparkLibraries

SparkSettings