Items - Create Environment

Служба:
Environment
Версия API:
v1

Создает среду в указанной рабочей области.
Этот API поддерживает длительные операции (LRO).

Разрешения

Вызывающий объект должен иметь роль рабочей области участника .

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

Environment.ReadWrite.All или Item.ReadWrite.All

Ограничения

  • Чтобы создать среду, рабочая область должна находиться в поддерживаемой Fabric емкости.

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

Этот API поддерживает Microsoft identities, перечисленных в этом разделе.

Тождество Поддержка
Пользователь Да
Представитель службы и управляемые удостоверения Да

Интерфейс

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

Параметры URI

Имя В Обязательно Тип Описание
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.

Текст запроса

Имя Обязательно Тип Описание
displayName True

string

Отображаемое имя среды.
definition

EnvironmentDefinition

Общедоступное определение среды.
description

string

Описание среды. Максимальная длина — 256 символов.
folderId

string (uuid)

Идентификатор папки. Если среда не указана или значение NULL, среда создается в рабочей области в качестве папки.
sensitivityLabelSettings

SensitivityLabelSettings

Параметры метки конфиденциальности для среды.

Ответы

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

Environment

Успешно создано
202 Accepted

Запрос принят, подготовка среды выполняется

Заголовки

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

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

Заголовки

Retry-After: integer
Other Status Codes

ErrorResponse

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

  • InvalidItemType — тип элемента недопустим

  • ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется

  • Поврежденный Payload — предоставленные полезные данные повреждены.

  • WorkspaceItemsLimitExceed — превышено ограничение элемента рабочей области.

Примеры

Create an environment example
Create an environment with public definition example

Create an environment example

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

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",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}
Код состояния:
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

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

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",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}
Код состояния:
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

Создание полезных данных запроса среды.
EntireTenantPrincipal

Представляет субъект клиента
Environment

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

Объект общедоступного определения среды. Дополнительные сведения о структуре определения среды см. в этой статье .
EnvironmentDefinitionPart

Объект части определения среды.
EnvironmentProperties

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

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

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

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

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

Группировка конкретных сведений. Применимо, если тип субъекта Group.
GroupPrincipal

Представляет группу безопасности.
GroupType

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

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

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

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

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

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

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

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

Параметры метки конфиденциальности.
ServicePrincipalDetails

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.
ServicePrincipalPrincipal

Представляет субъект-службу Microsoft Entra.
ServicePrincipalProfileDetails

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Представляет профиль субъекта-службы.
SparkLibraries

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

Параметры Spark.
UserDetails

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.
UserPrincipal

Представляет субъект пользователя Microsoft Entra.

ComponentPublishInfo

Объект

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

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

SparkLibraries

Библиотеки Spark публикуют сведения.
sparkSettings

SparkSettings

Параметры Spark публикуют сведения.

CreateEnvironmentRequest

Объект

Создание полезных данных запроса среды.

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

EnvironmentDefinition

Общедоступное определение среды.
description

string

Описание среды. Максимальная длина — 256 символов.
displayName

string

Отображаемое имя среды.
folderId

string (uuid)

Идентификатор папки. Если среда не указана или значение NULL, среда создается в рабочей области в качестве папки.
sensitivityLabelSettings

SensitivityLabelSettings

Параметры метки конфиденциальности для среды.

EntireTenantPrincipal

Объект

Представляет субъект клиента

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

string

Отображаемое имя субъекта.
id

string (uuid)

Идентификатор субъекта.
type string:

EntireTenant

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

Environment

Объект

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

Имя Тип Описание
defaultIdentity Principal:

Удостоверение элемента по умолчанию.
description

string

Описание элемента.
displayName

string

Отображаемое имя элемента.
folderId

string (uuid)

Идентификатор папки.
id

string (uuid)

Идентификатор элемента.
properties

EnvironmentProperties

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

SensitivityLabel

Метка конфиденциальности элементов.
tags

ItemTag[]

Список примененных тегов.
type

ItemType

Тип элемента.
workspaceId

string (uuid)

Идентификатор рабочей области.

EnvironmentDefinition

Объект

Объект общедоступного определения среды. Дополнительные сведения о структуре определения среды см. в этой статье .

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

string

Формат определения среды.
parts

EnvironmentDefinitionPart[]

Список частей определения.

EnvironmentDefinitionPart

Объект

Объект части определения среды.

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

string

Путь к части среды.
payload

string

Полезные данные части среды.
payloadType

PayloadType

Тип полезных данных.

EnvironmentProperties

Объект

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

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

PublishDetails

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

EnvironmentPublishState

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

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

Значение Описание
Success

Публикация среды находится в состоянии успешности.
Cancelled

Публикация среды находится в отмененном состоянии.
Failed

Публикация среды находится в состоянии сбоя.
Cancelling

Публикация среды находится в состоянии отмены.
Running

Публикация среды находится в состоянии выполнения.
Waiting

Публикация среды находится в состоянии ожидания.

ErrorRelatedResource

Объект

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

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

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

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

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

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
isRetriable

boolean

Если задано значение true, запрос можно получить. Retry-After Используйте заголовок ответа, чтобы определить задержку, если она доступна.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string (uuid)

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

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

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

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

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

GroupDetails

Объект

Группировка конкретных сведений. Применимо, если тип субъекта Group.

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

GroupType

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

GroupPrincipal

Объект

Представляет группу безопасности.

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

string

Отображаемое имя субъекта.
groupDetails

GroupDetails

Группировка конкретных сведений. Применимо, если тип субъекта Group.
id

string (uuid)

Идентификатор субъекта.
type string:

Group

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

GroupType

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

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

Значение Описание
Unknown

Тип основной группы неизвестен.
SecurityGroup

Субъект — это группа безопасности.
DistributionList

Субъект — это список рассылки.

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.
MirroredCatalog

ЗеркальныйCatalog.
AppBackend

An AppBackend.

PayloadType

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

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

Значение Описание
InlineBase64

Встроенная база 64.

PrincipalType

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

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

Значение Описание
User

Субъект является субъектом-пользователем Microsoft Entra.
ServicePrincipal

Субъект является субъектом-службой Microsoft Entra.
Group

Субъект — это группа безопасности.
ServicePrincipalProfile

Субъект — это профиль субъекта-службы.
EntireTenant

Субъект представляет всех пользователей клиента.

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)

Идентификатор метки конфиденциальности.

SensitivityLabelApplyStrategy

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

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

Значение Описание
ApplyOrFail

Примените метку конфиденциальности или сбой операции, если она не может быть применена.
Ignore

Игнорируйте метку конфиденциальности, если ее нельзя применить и продолжить операцию без применения метки.

SensitivityLabelSettings

Объект

Параметры метки конфиденциальности.

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

string (uuid)

Идентификатор метки конфиденциальности.
sensitivityLabelApplyStrategy

SensitivityLabelApplyStrategy

Стратегия применения метки конфиденциальности.

ServicePrincipalDetails

Объект

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.

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

string (uuid)

Microsoft Entra AppId субъекта-службы.

ServicePrincipalPrincipal

Объект

Представляет субъект-службу Microsoft Entra.

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

string

Отображаемое имя субъекта.
id

string (uuid)

Идентификатор субъекта.
servicePrincipalDetails

ServicePrincipalDetails

Сведения о субъекте-службе. Применимо, если тип субъекта ServicePrincipal.
type string:

ServicePrincipal

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

ServicePrincipalProfileDetails

Объект

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.

Имя Тип Описание
parentPrincipal Principal:

Родительский субъект профиля субъекта-службы.

ServicePrincipalProfilePrincipal

Объект

Представляет профиль субъекта-службы.

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

string

Отображаемое имя субъекта.
id

string (uuid)

Идентификатор субъекта.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Сведения о профиле субъекта-службы. Применимо, если тип субъекта ServicePrincipalProfile.
type string:

ServicePrincipalProfile

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

SparkLibraries

Объект

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

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

EnvironmentPublishState

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

SparkSettings

Объект

Параметры Spark.

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

EnvironmentPublishState

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

UserDetails

Объект

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.

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

string

Основное имя пользователя.

UserPrincipal

Объект

Представляет субъект пользователя Microsoft Entra.

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

string

Отображаемое имя субъекта.
id

string (uuid)

Идентификатор субъекта.
type string:

User

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

UserDetails

Сведения о субъекте-пользователе. Применимо, если тип субъекта User.