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)	Идентификатор среды.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.

Ответы

Имя Тип Описание

200 OK

Имя	Тип	Описание
200 OK	Environment	Запрос успешно завершен. Возвращает объект Environment.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: UnknownError — произошла ошибка.

Environment

Запрос успешно завершен. Возвращает объект Environment.

429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

UnknownError — произошла ошибка.

Примеры

Get Environment Item example

Образец запроса

HTTP

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"
        }
      }
    }
  },
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Определения

Имя	Описание
ComponentPublishInfo	Публикация сведений для каждого компонента в среде.
Environment	Элемент среды.
EnvironmentProperties	Свойства среды.
EnvironmentPublishState	Состояние публикации. С течением времени могут добавляться дополнительные типы состояний.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
ItemTag	Представляет тег, примененный к элементу.
ItemType	Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
PublishDetails	Сведения об операции публикации.
SensitivityLabel	Представляет метку конфиденциальности, примененную к элементу.
SparkLibraries	Библиотеки Spark.
SparkSettings	Параметры Spark.

ComponentPublishInfo

Объект

Публикация сведений для каждого компонента в среде.

Имя	Тип	Описание
sparkLibraries	SparkLibraries	Библиотеки Spark публикуют сведения.
sparkSettings	SparkSettings	Параметры Spark публикуют сведения.

Environment

Объект

Элемент среды.

Имя	Тип	Описание
description	string	Описание элемента.
displayName	string	Отображаемое имя элемента.
folderId	string (uuid)	Идентификатор папки.
id	string (uuid)	Идентификатор элемента.
properties	EnvironmentProperties	Свойства среды.
sensitivityLabel	SensitivityLabel	Метка конфиденциальности элементов.
tags	ItemTag[]	Список примененных тегов.
type	ItemType	Тип элемента.
workspaceId	string (uuid)	Идентификатор рабочей области.

EnvironmentProperties

Объект

Свойства среды.

Имя	Тип	Описание
publishDetails	PublishDetails	Сведения об операции публикации среды.

EnvironmentPublishState

Перечисление

Состояние публикации. С течением времени могут добавляться дополнительные типы состояний.

Значение	Описание
Success	Публикация среды находится в состоянии успешности.
Cancelled	Публикация среды находится в отмененном состоянии.
Failed	Публикация среды находится в состоянии сбоя.
Cancelling	Публикация среды находится в состоянии отмены.
Running	Публикация среды находится в состоянии выполнения.
Waiting	Публикация среды находится в состоянии ожидания.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

ItemTag

Объект

Представляет тег, примененный к элементу.

Имя	Тип	Описание
displayName	string	Имя тега.
id	string (uuid)	Идентификатор тега.

ItemType

Перечисление

Тип элемента. С течением времени могут добавляться дополнительные типы элементов.

Значение	Описание
Dashboard	Панель мониторинга PowerBI.
Report	Отчет PowerBI.
SemanticModel	Семантическая модель PowerBI.
PaginatedReport	Отчет с разбивкой на страницы PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Озеро.
Eventhouse	Хранилище событий.
Environment	Среда.
KQLDatabase	База данных KQL.
KQLQueryset	Набор запросов KQL.
KQLDashboard	Панель мониторинга KQL.
DataPipeline	Конвейер данных.
Notebook	Записная книжка.
SparkJobDefinition	Определение задания Spark.
MLExperiment	Эксперимент машинного обучения.
MLModel	Модель машинного обучения.
Warehouse	Склад.
Eventstream	Поток событий.
SQLEndpoint	Конечная точка SQL.
MirroredWarehouse	Зеркальный склад.
MirroredDatabase	Зеркальная база данных.
Reflex	Рефлекс.
GraphQLApi	API для элемента GraphQL.
MountedDataFactory	ПодключеннаяdataFactory.
SQLDatabase	База данных SQLDatabase.
CopyJob	Задание копирования.
VariableLibrary	ПеременнаяLibrary.
Dataflow	Поток данных.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Моментальный снимок хранилища.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Поток Конструктора цифровых двойников.
MirroredAzureDatabricksCatalog	Зеркальный каталог azure databricks.
Map	Карта.
AnomalyDetector	Детектор аномалий.
UserDataFunction	Функция данных пользователя.
GraphModel	A GraphModel.
GraphQuerySet	Набор запросов Graph.
SnowflakeDatabase	База данных Snowflake для хранения таблиц Iceberg, созданных из учетной записи Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	База данных Cosmos DB.
Ontology	An Ontology.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.

PublishDetails

Объект

Сведения об операции публикации.

Имя	Тип	Описание
componentPublishInfo	ComponentPublishInfo	Сведения о публикации компонента среды.
endTime	string (date-time)	Время окончания операции публикации в формате UTC с использованием формата ГГГГ-ММ-ДДTHH:мм:ss.ssZ.
startTime	string (date-time)	Время начала операции публикации в формате UTC с помощью формата ГГГГ-ММ-ДДTHH:мм:ss.ssZ.
state	EnvironmentPublishState	Состояние публикации. С течением времени могут добавляться дополнительные типы состояний.
targetVersion	string (uuid)	Целевая версия для публикации.

SensitivityLabel

Объект

Представляет метку конфиденциальности, примененную к элементу.

Имя	Тип	Описание
id	string (uuid)	Идентификатор метки конфиденциальности.

SparkLibraries

Объект

Библиотеки Spark.

Имя	Тип	Описание
state	EnvironmentPublishState	Состояние публикации. С течением времени могут добавляться дополнительные типы состояний.

SparkSettings

Объект

Параметры Spark.

Имя	Тип	Описание
state	EnvironmentPublishState	Состояние публикации. С течением времени могут добавляться дополнительные типы состояний.

Поделиться через

Items - Get Environment

Разрешения

Обязательные делегированные области

поддерживаемые удостоверения Microsoft Entra

Интерфейс

Параметры URI

Ответы

Примеры

Get Environment Item example

Образец запроса

Пример ответа

Определения

ComponentPublishInfo

Environment

EnvironmentProperties

EnvironmentPublishState

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

PublishDetails

SensitivityLabel

SparkLibraries

SparkSettings