Items - Publish Environment

Служба:: Environment

Версия API:: v1

Активируйте операцию публикации среды.

Замечание

Этот API является версией бета-версии из-за нерекомендуемой версии 31 августа 2026 года. При вызове этого API вызывающие должны задать параметр beta запроса значением. false

Этот API поддерживает длительные операции (LRO).

Permissions

Разрешение на запись для элемента среды.

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

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

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

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

Идентичность	Support
User	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/staging/publish?beta={beta}

Параметры URI

Имя	В	Обязательно	Тип	Описание
environmentId	path	True	string (uuid)	Идентификатор среды.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
beta	query	True	boolean	Этот параметр задает используемую версию API. Установите для `false` использования версии выпуска.

Ответы

Имя	Тип	Описание
200 OK	EnvironmentProperties	Запрос на операцию публикации успешно отправлен.
202 Accepted		Запрос принят, операция публикации выполняется. Возвращает контракт ga, когда `beta=false` (по умолчанию после 31 августа 2026 г.). Заголовки Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: InvalidEnvironmentPublish — операция публикации среды для < версии неудачной операции> публикации завершилась ошибкой: Code = EnvironmentAnotherOngoingPublishProcess.

Примеры

Publish environment example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/publish?beta=false

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

Код состояния:: 200

{
  "publishDetails": {
    "state": "Running",
    "targetVersion": "46838a80-5450-4414-bea0-40fb6f3e0c0d",
    "startTime": "2024-03-29T14:17:09.0697022Z",
    "componentPublishInfo": {
      "sparkLibraries": {
        "state": "Running"
      },
      "sparkSettings": {
        "state": "Running"
      }
    }
  }
}

Код состояния:: 202

Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69
x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69
Retry-After: 120

Определения

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

ComponentPublishInfo

Объект

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

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

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	Сведения об ошибках, связанных с ресурсом.

PublishDetails

Объект

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

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

SparkLibraries

Объект

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

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

SparkSettings

Объект

Параметры Spark.

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