Управление средой с помощью общедоступных API

REST API Microsoft Fabric предоставляет конечную точку службы для операций создания, чтения, обновления и удаления (CRUD) элемента Fabric. В этой статье описываются доступные REST API экосистемы и их использование.

Перенос API окружения в их стабильную GA версию

Внимание

Выпуск общедоступной версии включает обновления в контракте запросов и ответа существующих API, устаревших API и новых API. Подробные сведения см. в следующих разделах.
Новый параметр beta запроса введен для облегчения процесса изменения контракта запроса/ответа. Параметр beta запроса по умолчанию используется до True30 апреля 2026 г., что делает предварительные контракты доступными. Установите значение на False, чтобы начать использовать стабильную релизную версию контрактов.
Preview Параметр запроса заменен beta. Для обратной совместимости предварительная версия по-прежнему поддерживается и ведет себя так же, как бета-версия.
Планируемые к устареванию API будут поддерживаться до 30 апреля 2026 года. Пожалуйста, используйте недавно представленные API для их замены как можно скорее.

Обновление контракта запроса и ответа в API

Категория	API (Интерфейс программирования приложений)	Описание	Примечания.	Предварительная версия Swagger	Релиз версии Swagger
Операция элемента	Среда публикации	Запустите операцию публикации среды с текущими ожидающими изменениями.	Обновление договора об ответных действиях.	Среда публикации (предварительная версия)	Среда публикации
Подготовка	Список подготовительных библиотек	Получите полный список промежуточной библиотеки. Этот список включает опубликованные и на рассмотрении библиотеки.	Обновление договора об ответных действиях.	Перечислить промежуточные библиотеки (предварительная версия)	Список промежуточных библиотек
Подготовка	Вывод списка промежуточных вычислений Spark	Получите полные промежуточные конфигурации вычислений. Промежуточные конфигурации включают конфигурации вычислений, которые были опубликованы и находятся в ожидании.	Обновление договора об ответных действиях.	Список этапов вычислений Spark (предварительная версия)	Список этапов вычислений в Spark
Подготовка	Обновление вычислений Spark	Обновите конфигурации вычислений и свойства Spark для среды.	Обновление контрактов запроса и ответа.	Обновление вычислений Spark (предварительная версия)	Обновление вычислений Spark
Опубликовано	Перечисление опубликованных библиотек	Получите библиотеки, опубликованные и действующие в сеансах Spark.	Обновление договора об ответных действиях.	Список опубликованных библиотек (предварительная версия)	Перечисление опубликованных библиотек
Опубликовано	Список опубликованных вычислений Spark	Получите конфигурации вычислений Spark и свойства Spark, опубликованные и эффективные в сеансах Spark.	Обновление договора об ответных действиях.	Список опубликованных библиотек (предварительная версия)	Перечисление опубликованных библиотек

Параметр beta по умолчанию равен True до 30 апреля 2026 г., т. е. система считает параметр True если запрос отправлен без указания этого параметра до даты прекращения поддержки. Настоятельно рекомендуем перенести ваши реализации на стабильную версию, явно установив параметр beta на False как можно скорее.

Использование API List staging libraries в качестве примера, которое содержит обновление в ответе API.

При отправке запроса с параметром beta в качестве True

Пример запроса:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=True

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

{
  "customLibraries": {
    "wheelFiles": [
      "samplewheel-0.18.0-py2.py3-none-any.whl"
    ],
    "pyFiles": [
      "samplepython.py"
    ],
    "jarFiles": [
      "samplejar.jar"
    ],
    "rTarFiles": [
      "sampleR.tar.gz"
    ]
  },
  "environmentYml": "name: sample-environment\ndependencies:\n  - fuzzywuzzy==0.0.1\n  - matplotlib==0.0.1"
}

При отправке запроса с параметром preview в качестве False

Пример запроса:

  GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/libraries?beta=False

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

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

Нерекомендуемые API

Внимание

Интерфейсы программирования приложений (API), которые будут выведены из использования, останутся поддерживаемыми до 30 апреля 2026 г. Мы настоятельно рекомендуем использовать недавно представленные API для замены реализаций как можно скорее.

Категория	API (Интерфейс программирования приложений)	Описание	Примечание.
Подготовка	Загрузить библиотеки для промежуточной среды	Добавьте в среду одну пользовательскую библиотеку или одну или несколько общедоступных библиотек.	Поддержка до 30 апреля 2026 г. используйте недавно представленные `Import external libraries`/`Upload custom library` API для замены.
Подготовка	Удалить промежуточные библиотеки	Удалите одну тестовую пользовательскую библиотеку или все общедоступные библиотеки.	Поддержка до 30 апреля 2026 г. используйте недавно представленные `Remove external library`/`Delete custom library` API для замены.

Ниже приведены несколько примеров, охватывающих сценарии управления промежуточными библиотеками.

Добавление общедоступных библиотек в среду

Ранее можно использовать Upload staging libraries API для отправки обновленного YAML-файла, а теперь можно использовать Import external libraries API для импорта обновленного YAML.
Удалите одну общедоступную библиотеку в вашей среде

Ранее можно использовать Upload staging libraries API для отправки обновленного ФАЙЛА YAML, а теперь можно использовать Remove external library API для его удаления.
Удаление всей общедоступной библиотеки в вашей среде

Ранее можно использовать Delete staging libraries API для удаления всех общедоступных библиотек, а теперь можно использовать Remove external library API для удаления общедоступных библиотек по одному или для Import external libraries отправки пустого YAML-файла для достижения одинаковых функций.

Новые API

Категория	API (Интерфейс программирования приложений)	Описание	Примечание.
Операция элемента	Создание среды с определением	Создайте новую среду с определением.	Новый API.
Операция элемента	Получить определение среды	Получение определения среды.	Новый API.
Операция элемента	Обновление определения среды	Обновите определение среды.	Новый API.
Подготовка	Импорт внешних библиотек	Отправьте внешние библиотеки в виде файла environment.yml в среду. Он переопределяет список существующих внешних библиотек в среде.	Новый API.
Подготовка	Экспорт внешних библиотек	Получите полные внешние библиотеки в виде файла environment.yml .	Новый API.
Подготовка	Удаление внешней библиотеки	Удаление внешней библиотеки из среды. Этот API принимает одну библиотеку одновременно.	Новый API.
Подготовка	Отправка пользовательской библиотеки	Загрузите пользовательский пакет в среду. Этот API позволяет одновременно отправлять один файл. Поддерживаемые форматы файлов: .jar, .py, WHL и .tar.gz.	Новый API.
Подготовка	Удаление пользовательской библиотеки	Удалите пользовательский пакет из среды. Поместите полное имя пользовательского пакета с расширением в запрос API, чтобы удалить его.	Новый API.
Опубликовано	Экспорт внешних библиотек	Получите опубликованные внешние библиотеки в виде файла environment.yml .	Новый API.

API без обновления

Категория	API (Интерфейс программирования приложений)	Описание
Операция элемента	Создание среды	Создайте пустую среду в рабочей области.
Операция элемента	Получить окружение	Получение метаданных среды. Ответ включает состояние среды.
Операция элемента	Удаление среды	Удаление существующей среды.
Операция элемента	Список среды	Получите список сред в рабочей области.
Операция элемента	Обновление среды	Обновите метаданные среды, например имя и описание.
Операция элемента	Отмена среды публикации	Отмена текущей операции публикации среды.

Дополнительные сведения об общедоступных API среды см. в разделе API элементов — среда.

Варианты использования общедоступного API среды

Внимание

Этот раздел демонстрируется со стабильной версией API.

В этом разделе показано, как использовать API для достижения определенных сценариев при управлении средой. В следующих примерах вы можете заменить свойства {WORKSPACE_ID} и {ARTIFACT_ID} соответствующими значениями.

Создание новой среды

Чтобы создать пустую среду, используйте следующий API.

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

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

{
    "displayName": "Environment_1",
    "description": "An environment description"
}

Управление промежуточными библиотеками

Api-интерфейсы промежуточных библиотек отправки и удаления можно использовать для управления разделом библиотеки в среде.

Проверьте опубликованные библиотеки для среды

Перед добавлением или удалением библиотеки используйте API Get Published Libraryes, чтобы проверить, какие библиотеки в настоящее время эффективны.

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

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/libraries?beta=False

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

{
  "libraries": [
    {
      "name": "samplewheel-0.18.0-py2.py3-none-any.whl",
      "libraryType": "Custom"
    },
    {
      "name": "fuzzywuzzy",
      "libraryType": "External",
      "version": "0.0.1"
    }
  ],
  "continuationToken": "null",
  "continuationUri": "null"
}

Импорт общедоступных библиотек или отправка пользовательской библиотеки

Вы можете импортировать внешние библиотеки и отправить API пользовательской библиотеки для добавления новых общедоступных и пользовательских библиотек в среду. API импорта внешних библиотек принимает environment.yml файл, а поддерживаемые типы файлов — WHL, .jar, .tar.gz, .py для отправки пользовательского API библиотеки.

Примечание.

Для более эффективного управления общедоступной библиотекой рекомендуется создавать все ожидаемые библиотеки из PyPI и Conda в файле environment.yml .

API отправки позволяет получить до 200 МБ-файла в одном запросе. Библиотека, превышающая это ограничение размера, в настоящее время не поддерживается в общедоступных API.

Примеры запросов

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/importExternalLibraries

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

Удаление пользовательской библиотеки

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

Примечание.

Если вы хотите удалить подмножество существующих общедоступных библиотек или всех из них, импортируйте обновленный ФАЙЛ YAML через Import public libraries API.

Примеры запросов

DELETE https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries/samplelibrary.jar

Управление промежуточными вычислениями Spark

Можно использовать обновляемый этап вычислений Spark для управления вычислительными ресурсами Spark.

Проверка опубликованных вычислений Spark для среды

Прежде чем изменять конфигурации среды, используйте API вычислений Get Published Spark, чтобы проверить, какие конфигурации вычислений Spark в настоящее время эффективны.

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

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/sparkcompute?beta=False

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

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    }
  ],
  "runtimeVersion": "1.2"
}

Обновление конфигураций вычислений

Вы можете обновить среду выполнения Spark, переключиться в другой пул, уточнить конфигурацию вычислений и добавить или удалить свойства Spark, изменив текст запроса этого API.

Вы можете переключить подключенный пул, указав его имя и сам пул. Укажите имя пула как Starter Pool, чтобы переключить пул на параметры по умолчанию. Полный список доступных настраиваемых пулов рабочей области с помощью REST API см. в разделе "Настраиваемые пулы — список настраиваемых пулов рабочей области".

Если вы хотите удалить существующее свойство Spark, укажите значение, как null и ключ, который требуется удалить.

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

PATCH https://api.fabric.microsoft.com/v1/workspaces/aaaabbbb-0000-cccc-1111-dddd2222eeee/environments/bbbbcccc-1111-dddd-2222-eeee3333ffff/staging/sparkcompute?beta=False

{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": [
    {
      "key": "spark.acls.enable",
      "value": "false"
    },
    {
      "key": "spark.admin.acls",
      "value": null
    }
  ],
  "runtimeVersion": "1.2"
}

Внесение изменений в силу

Используйте следующие наборы API для публикации изменений.

Подготовка к операции публикации

Среда может принимать одновременно только одну операцию публикации. Перед публикацией среды проверьте состояние среды и проведите окончательный обзор изменений, внесённых на этапе подготовки. После успешной публикации среды все конфигурации в промежуточном состоянии становятся эффективными.

Шаг 1. Получение метаданных среды.
```
GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/
```
В теле отклика можно четко определить состояние среды. Прежде чем перейти к следующему шагу, убедитесь, что операция публикации не выполняется.

Шаг 2. Подготовьте промежуточные библиотеки и вычислительные ресурсы Spark для окончательного обзора.

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/libraries?beta=False

GET https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/sparkcompute?beta=False

Запустите операцию публикации среды

Изменения, внесенные в промежуточные библиотеки и вычисления Spark, кэшируются, но их необходимо опубликовать, чтобы они вступили в силу. Используйте следующий пример для активации операции публикации. Ответ следует шаблону длительных операций (LRO), и код ответа HTTP 202 может быть возвращен.

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

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/publish?beta=False

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

Location: https://api.fabric.microsoft.com/v1/operations/ccccdddd-2222-eeee-3333-ffff4444aaaa
x-ms-operation-id: ccccdddd-2222-eeee-3333-ffff4444aaaa
Retry-After: 120

Во время операции публикации можно также вызвать следующий API, чтобы отменить его.

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

POST https://api.fabric.microsoft.com/v1/workspaces/{{WORKSPACE_ID}}/environments/{{ARTIFACT_ID}}/staging/cancelPublish

Кері байланыс

Бет пайдалы болды ма?

Last updated on 2026-03-06

Бөлісу құралы:

Управление средой с помощью общедоступных API

Перенос API окружения в их стабильную GA версию

Обновление контракта запроса и ответа в API

Нерекомендуемые API

Новые API

API без обновления

Варианты использования общедоступного API среды

Создание новой среды

Управление промежуточными библиотеками

Проверьте опубликованные библиотеки для среды

Импорт общедоступных библиотек или отправка пользовательской библиотеки

Удаление пользовательской библиотеки

Управление промежуточными вычислениями Spark

Проверка опубликованных вычислений Spark для среды

Обновление конфигураций вычислений

Внесение изменений в силу

Подготовка к операции публикации

Запустите операцию публикации среды

Связанный контент

Кері байланыс

Қосымша ресурстар