Items - Update Environment Definition

Служба:: Environment

Версия API:: v1

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

Обновление определения среды не влияет на метку конфиденциальности.

Permissions

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

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

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

Идентификаторы, поддерживаемые Microsoft Entra

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

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

Интерфейс

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

С использованием необязательных параметров:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/updateDefinition?updateMetadata={updateMetadata}

Параметры URI

Имя	В	Обязательно	Тип	Описание
environmentId	path	True	string (uuid)	Идентификатор среды.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
updateMetadata	query		boolean	Если задано значение true и файл платформы предоставляется в рамках определения, метаданные элемента обновляются с помощью метаданных в файле платформы.

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

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

Ответы

Имя	Тип	Описание
200 OK		Запрос успешно завершен.
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	Распространенные коды ошибок: OperationNotSupportedForItem — операция не поддерживается для запрошенного элемента. Поврежденный Payload — предоставленные полезные данные повреждены.

Примеры

Update a environment definition example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/environments/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "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"
      }
    ]
  }
}

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

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

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

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Определения

Имя	Описание
EnvironmentDefinition	Объект общедоступного определения среды. Дополнительные сведения о структуре определения среды см. в этой статье .
EnvironmentDefinitionPart	Объект части определения среды.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
PayloadType	Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.
UpdateEnvironmentDefinitionRequest	Обновление полезных данных запроса общедоступного определения среды.

EnvironmentDefinition

Объект

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

Имя	Тип	Описание
format	string	Формат определения среды.
parts	EnvironmentDefinitionPart[]	Список частей определения.

EnvironmentDefinitionPart

Объект

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

Имя	Тип	Описание
path	string	Путь к части среды.
payload	string	Полезные данные части среды.
payloadType	PayloadType	Тип полезных данных.

ErrorRelatedResource

Объект

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

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

ErrorResponse

Объект

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

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

ErrorResponseDetails

Объект

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

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

PayloadType

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

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

Значение	Описание
InlineBase64	Встроенная база 64.

UpdateEnvironmentDefinitionRequest

Объект

Обновление полезных данных запроса общедоступного определения среды.

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

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

Items - Update Environment Definition

Permissions

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

Идентификаторы, поддерживаемые Microsoft Entra

Интерфейс

Параметры URI

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

Ответы

Примеры

Update a environment definition example

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

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

Определения

EnvironmentDefinition

EnvironmentDefinitionPart

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

PayloadType

UpdateEnvironmentDefinitionRequest