通过

Items - Update Environment

  • 参考
服务:
Environment
API 版本:
v1

更新指定环境的属性。

权限

调用方必须具有 参与者 或更高版本的工作区角色。

所需的委派范围

Environment.ReadWrite.All 或 Item.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

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

URI 参数

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

string

uuid

环境 ID。
workspaceId
 path True

string

uuid

工作区 ID。

请求正文

名称 类型 说明
description

string

环境说明。 最大长度为 256 个字符。
displayName

string

环境显示名称。

响应

名称 类型 说明
200 OK

Environment

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • ItemNotFound - 找不到请求的项目。

  • InvalidRequest - 更新请求无效

示例

Update a environment example

示例请求

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "Environment_New_Name",
  "description": "A new description for environment."
}

示例响应

状态代码:
200 
{
  "displayName": "Environment_New_Name",
  "description": "A new description for environment.",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

定义

名称 说明
ComponentPublishInfo

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

环境项。
EnvironmentPublishInfo

环境发布信息。
EnvironmentPublishState

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

与错误相关的资源详细信息对象。
ErrorResponse

错误响应。
ErrorResponseDetails

错误响应详细信息。
ItemType

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

发布作的详细信息。
SparkLibraries

Spark 库。
SparkSettings

Spark 设置。
UpdateEnvironmentRequest

更新环境请求。

ComponentPublishInfo

Object

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

名称 类型 说明
sparkLibraries

SparkLibraries

Spark 库发布信息。
sparkSettings

SparkSettings

Spark 设置发布信息。

Environment

Object

环境项。

名称 类型 说明
description

string

项说明。
displayName

string

项显示名称。
id

string

uuid

项 ID。
properties

EnvironmentPublishInfo

环境属性。
type

ItemType

项类型。
workspaceId

string

uuid

工作区 ID。

EnvironmentPublishInfo

Object

环境发布信息。

名称 类型 说明
publishDetails

PublishDetails

环境发布作详细信息。

EnvironmentPublishState

Enumeration

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

值 说明
Cancelled

环境发布处于已取消状态。
Cancelling

环境发布处于取消状态。
Failed

环境发布处于失败状态。
Running

环境发布处于运行状态。
Success

环境发布处于成功状态。
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

与错误相关的资源详细信息。

ItemType

Enumeration

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

值 说明
Dashboard

PowerBI 仪表板。
DataPipeline

数据管道。
Datamart

PowerBI Datamart。
Environment

环境。
Eventhouse

事件屋。
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

发布作的详细信息。

名称 类型 说明
componentPublishInfo

ComponentPublishInfo

环境组件发布信息。
endTime

string

date-time

发布作的结束时间。
startTime

string

date-time

发布作的开始时间。
state

EnvironmentPublishState

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

string

uuid

要发布的目标版本。

SparkLibraries

Object

Spark 库。

名称 类型 说明
state

EnvironmentPublishState

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

SparkSettings

Object

Spark 设置。

名称 类型 说明
state

EnvironmentPublishState

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

UpdateEnvironmentRequest

Object

更新环境请求。

名称 类型 说明
description

string

环境说明。 最大长度为 256 个字符。
displayName

string

环境显示名称。