通过

Items - Get Environment

服务:
Environment
API 版本:
v1

返回指定环境的属性。

权限

调用方必须具有环境的 读取 权限。

所需的委派范围

Environment.Read.All 或 Item.Read.All 或 Environment.ReadWrite.All 或 Item.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

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

URI 参数

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

string (uuid)

环境 ID。
workspaceId
 path True

string (uuid)

工作区 ID。

响应

名称 类型 说明
200 OK

Environment

请求成功完成。 返回 Environment 对象。
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误。

示例

Get Environment Item example

示例请求

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87

示例响应

状态代码:
200 
{
  "displayName": "Environment_1",
  "description": "An Environment description",
  "type": "Environment",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "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

环境项。
EnvironmentProperties

环境属性。
EnvironmentPublishState

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

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
ItemTag

表示应用于项的标记。
ItemType

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

发布作的详细信息。
SparkLibraries

Spark 库。
SparkSettings

Spark 设置。

ComponentPublishInfo

对象

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

名称 类型 说明
sparkLibraries

SparkLibraries

Spark 库发布信息。
sparkSettings

SparkSettings

Spark 设置发布信息。

Environment

对象

环境项。

名称 类型 说明
description

string

项说明。
displayName

string

项显示名称。
folderId

string (uuid)

文件夹 ID。
id

string (uuid)

项 ID。
properties

EnvironmentProperties

环境属性。
tags

ItemTag[]

已应用的标记列表。
type

ItemType

项类型。
workspaceId

string (uuid)

工作区 ID。

EnvironmentProperties

对象

环境属性。

名称 类型 说明
publishDetails

PublishDetails

环境发布作详细信息。

EnvironmentPublishState

枚举

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

值 说明
Success

环境发布处于成功状态。
Cancelled

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

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

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

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

环境发布处于等待状态。

ErrorRelatedResource

对象

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

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

对象

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

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

string

与错误关联的请求的 ID。

ErrorResponseDetails

对象

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

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

ItemTag

对象

表示应用于项的标记。

名称 类型 说明
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

用户数据函数。
GraphModel

GraphModel。
GraphQuerySet

图形查询集。
SnowflakeDatabase

用于存储从 Snowflake 帐户创建的 Iceberg 表的 Snowflake 数据库。
OperationsAgent

OperationsAgent。

PublishDetails

对象

发布作的详细信息。

名称 类型 说明
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

对象

Spark 库。

名称 类型 说明
state

EnvironmentPublishState

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

SparkSettings

对象

Spark 设置。

名称 类型 说明
state

EnvironmentPublishState

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