Items - List Environments

参考

服务:: Environment

API 版本:: v1

从指定的工作区返回环境列表。
此 API 支持分页。

权限

调用方必须具有 查看器 或更高版本的工作区角色。

所需的委派范围

Workspace.Read.All 或 Workspace.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

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

具有可选参数:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments?continuationToken={continuationToken}

URI 参数

名称	在	必需	类型	说明
workspaceId	path	True	string uuid	工作区 ID。
continuationToken	query		string	用于检索下一页结果的令牌。

响应

名称	类型	说明
200 OK	Environments	请求成功完成。
Other Status Codes	ErrorResponse	常见错误代码： InvalidItemType - 项类型无效

名称

类型

说明

200 OK

Environments

请求成功完成。

Other Status Codes

ErrorResponse

常见错误代码：

InvalidItemType - 项类型无效

示例

List environments in workspace example

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Environment_1",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Failed",
          "targetVersion": "14ece8b5-68a1-4130-a9e7-074c04537588",
          "startTime": "2024-03-30T14:17:09.0697022Z",
          "endTime": "2024-03-30T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Failed"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    },
    {
      "id": "a8a1bffa-7eea-49dc-a1d2-6281c1d031f1",
      "displayName": "Environment_2",
      "description": "A environment description.",
      "type": "Environment",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "publishDetails": {
          "state": "Success",
          "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
          "startTime": "2024-03-29T14:17:09.0697022Z",
          "endTime": "2024-03-29T14:48:09.0697022Z",
          "componentPublishInfo": {
            "sparkLibraries": {
              "state": "Success"
            },
            "sparkSettings": {
              "state": "Success"
            }
          }
        }
      }
    }
  ]
}

定义

名称	说明
ComponentPublishInfo	发布环境中每个组件的信息。
Environment	环境项。
EnvironmentPublishInfo	环境发布信息。
EnvironmentPublishState	发布状态。可能会随着时间的推移添加其他状态类型。
Environments	环境列表。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ItemType	项的类型。可能会随着时间的推移添加其他项类型。
PublishDetails	发布作的详细信息。
SparkLibraries	Spark 库。
SparkSettings	Spark 设置。

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

Environments

Object

环境列表。

名称	类型	说明
continuationToken	string	下一个结果集批处理的令牌。如果没有更多记录，则会从响应中删除该记录。
continuationUri	string	下一个结果集批处理的 URI。如果没有更多记录，则会从响应中删除该记录。
value	Environment[]	环境列表。

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

通过

Items - List Environments

权限

所需的委派范围

Microsoft Entra 支持的标识

接口

URI 参数

响应

示例

List environments in workspace example

示例请求

示例响应

定义

ComponentPublishInfo

Environment

EnvironmentPublishInfo

EnvironmentPublishState

Environments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemType

PublishDetails

SparkLibraries

SparkSettings

其他资源