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

Остановка выпуска для отправки приложения

  • Статья

Используйте этот метод в API отправки Microsoft Store, чтобы остановить развертывание пакета для отправки приложения. Дополнительные сведения о процессе создания отправки приложения с помощью API отправки в Microsoft Store см. в разделе "Управление отправкой приложений".

Примечание.

Если вы остановите развертывание для отправки приложения, а затем создадите новую отправку приложения, новая отправка является клоном остановленной отправки.

Необходимые компоненты

Чтобы использовать этот метод, сначала необходимо выполнить следующие действия:

  • Если вы этого еще не сделали, выполните все предварительные требования для API отправки Microsoft Store.
  • Получите маркер доступа Azure AD для использования в заголовке запроса для этого метода. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия. После истечения срока действия маркера можно получить новый.
  • Создайте отправку для одного из приложений. Это можно сделать в Центре партнеров или сделать это с помощью метода отправки приложения.
  • Включите постепенное развертывание пакета для отправки. Это можно сделать в Центре партнеров или сделать это с помощью API отправки в Microsoft Store.

Запросить

Этот метод имеет следующий синтаксис. В следующих разделах приведены примеры использования и описания параметров заголовка и запроса.

Способ URI запроса
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout

Заголовок запроса

Верхний колонтитул Тип Описание
Авторизация строка Обязательный. Маркер доступа Azure AD в маркере> носителя<формы.

Параметры запроса

Имя. Тип Описание
applicationId строка Обязательный. Идентификатор магазина приложения, содержащего отправку с развертыванием пакета, который требуется остановить. Дополнительные сведения об идентификаторе Магазина см. в разделе "Просмотр сведений об удостоверении приложения".
submissionId строка Обязательный. Идентификатор отправки с развертыванием пакета, который требуется остановить. Этот идентификатор доступен в данных ответа для запросов на создание отправки приложения. Для отправки, созданной в Центре партнеров, этот идентификатор также доступен в URL-адресе страницы отправки в Центре партнеров.

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

Не предоставляйте текст запроса для этого метода.

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

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

POST https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/submissions/1152921504621243680/haltpackagerollout HTTP/1.1
Authorization: Bearer <your access token>

Response

В следующем примере показан текст ответа JSON для успешного вызова этого метода. Дополнительные сведения о значениях в тексте ответа см. в разделе "Развертывание пакета".

{
    "isPackageRollout": true,
    "packageRolloutPercentage": 0.0,
    "packageRolloutStatus": "PackageRolloutStopped",
    "fallbackSubmissionId": "1212922684621243058"
}

Коды ошибок

Если запрос не может быть выполнен успешно, ответ будет содержать один из следующих кодов ошибок HTTP.

Код ошибки Description
404 Не удалось найти отправку.
409 Этот код указывает на одну из следующих ошибок:

  • Отправка не находится в допустимом состоянии для постепенной операции развертывания (перед вызовом этого метода отправка должна быть опубликована, а значение packageRolloutStatus должно иметь значение PackageRolloutInProgress).
  • Отправка не принадлежит указанному приложению.
  • Приложение использует функцию Центра партнеров, которая в настоящее время не поддерживается API отправки Microsoft Store.