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 参数

名称	在	必需	类型	说明
workspaceId	path	True	string (uuid)	工作区 ID。

请求正文

名称	必需	类型	说明
displayName	True	string	环境显示名称。
definition		EnvironmentDefinition	环境公共定义。
description		string	环境说明。最大长度为 256 个字符。
folderId		string (uuid)	文件夹 ID。如果未指定或为 null，则会使用工作区作为其文件夹创建环境。

响应

名称	类型	说明
201 Created	Environment	已成功创建
202 Accepted		请求接受，正在进行环境预配标头 Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	常见错误代码： InvalidItemType - 项类型无效 ItemDisplayNameAlreadyInUse - 项显示名称已被使用 CorruptedPayload - 提供的有效负载已损坏。 WorkspaceItemsLimitExceeded - 超出工作区项限制。

名称

类型

说明

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

定义

名称	说明
ComponentPublishInfo	发布环境中每个组件的信息。
CreateEnvironmentRequest	创建环境请求有效负载。
Environment	环境项。
EnvironmentDefinition	环境公共定义对象。有关如何创建环境公共定义的详细信息，请参阅本文。
EnvironmentDefinitionPart	环境定义部件对象。
EnvironmentProperties	环境属性。
EnvironmentPublishState	发布状态。可能会随着时间的推移添加其他状态类型。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ItemTag	表示应用于项的标记。
ItemType	项的类型。可能会随着时间的推移添加其他项类型。
PayloadType	定义部件有效负载的类型。可能会随着时间的推移添加其他有效负载类型。
PublishDetails	发布作的详细信息。
SparkLibraries	Spark 库。
SparkSettings	Spark 设置。

ComponentPublishInfo

Object

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

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

CreateEnvironmentRequest

Object

创建环境请求有效负载。

名称	类型	说明
definition	EnvironmentDefinition	环境公共定义。
description	string	环境说明。最大长度为 256 个字符。
displayName	string	环境显示名称。
folderId	string (uuid)	文件夹 ID。如果未指定或为 null，则会使用工作区作为其文件夹创建环境。

Environment

Object

环境项。

名称	类型	说明
description	string	项说明。
displayName	string	项显示名称。
folderId	string (uuid)	文件夹 ID。
id	string (uuid)	项 ID。
properties	EnvironmentProperties	环境属性。
tags	ItemTag[]	已应用的标记列表。
type	ItemType	项类型。
workspaceId	string (uuid)	工作区 ID。

EnvironmentDefinition

Object

环境公共定义对象。有关如何创建环境公共定义的详细信息，请参阅本文。

名称	类型	说明
format	string	环境定义的格式。
parts	EnvironmentDefinitionPart[]	定义部件的列表。

EnvironmentDefinitionPart

Object

环境定义部件对象。

名称	类型	说明
path	string	环境部件路径。
payload	string	环境部件有效负载。
payloadType	PayloadType	有效负载类型。

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

ItemTag

Object

表示应用于项的标记。

名称	类型	说明
displayName	string	标签的名称。
id	string (uuid)	标记 ID。

ItemType

枚举

项的类型。可能会随着时间的推移添加其他项类型。

值	说明
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	事件流。
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	用户数据函数。

PayloadType

枚举

定义部件有效负载的类型。可能会随着时间的推移添加其他有效负载类型。

值	说明
InlineBase64	内联基线 64。

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	发布状态。可能会随着时间的推移添加其他状态类型。

通过

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