Остановка выпуска для отправки приложенияHalt the rollout for an app submission

Используйте этот метод в API отправки Microsoft Store, чтобы остановить развертывание пакета для отправки приложения.Use this method in the Microsoft Store submission API to halt the package rollout for an app submission. Подробнее о процессе создания отправки приложения с помощью API отправки в Microsoft Store см. в статье Управление отправками приложений.For more information about the process of process of creating an app submission by using the Microsoft Store submission API, see Manage app submissions.

Примечание

Если вы остановили выпуск в составе отправки приложения, а затем создали новую отправку приложения, новая отправка будет являться клоном остановленной отправки.If you halt the rollout for an app submission and then create a new app submission, the new submission is a clone of the halted submission.

Предварительные требованияPrerequisites

Для использования этого метода сначала необходимо сделать следующее:To use this method, you need to first do the following:

  • Если вы еще не сделали этого, выполните все необходимые условия для API отправки в Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • Получите маркер доступа Azure AD, который будет использоваться в заголовке запроса этого метода.Obtain an Azure AD access token to use in the request header for this method. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия.After you obtain an access token, you have 60 minutes to use it before it expires. После истечения срока действия маркера можно получить новый маркер.After the token expires, you can obtain a new one.
  • Создайте отправку для одного из ваших приложений.Create a submission for one of your apps. Это можно сделать в центре партнеров, или же это можно сделать с помощью метода создания отправки приложения .You can do this in Partner Center, or you can do this by using the create an app submission method.
  • Включите постепенный выпуск пакета для отправки.Enable a gradual package rollout for the submission. Это можно сделать в центре партнеровили воспользоваться API отправки Microsoft Store.You can do this in Partner Center, or you can do this by using the Microsoft Store submission API.

ЗапросRequest

У этого метода следующий синтаксис.This method has the following syntax. Примеры использования и описание заголовка и параметров запроса приведены в следующих разделах.See the following sections for usage examples and descriptions of the header and request parameters.

МетодMethod Универсальный код ресурса (URI) запросаRequest URI
POSTPOST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout

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

ЗаголовокHeader ТипType ОписаниеDescription
АвторизацияAuthorization строкаstring Обязательный.Required. Маркер доступа Azure AD в формате Bearer <token>.The Azure AD access token in the form Bearer <token>.

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

НазваниеName ТипType ОписаниеDescription
applicationIdapplicationId строкаstring Обязательный.Required. Код продукта в Магазине для приложения, содержащего отправку с выпуском пакета, который требуется остановить.The Store ID of the app that contains the submission with the package rollout you want to halt. Дополнительные сведения о коде продукта в Магазине см. в разделе Просмотр сведений об идентификации приложения.For more information about the Store ID, see View app identity details.
submissionIdsubmissionId строкаstring Обязательный.Required. Идентификатор отправки с выпуском пакета, который необходимо остановить.The ID of the submission with the package rollout you want to halt. Этот идентификатор добавляется в данные ответов для запросов на создание отправки приложения.This ID is available in the response data for requests to create an app submission. Для отправки, созданной в центре партнеров, этот идентификатор также доступен в URL-адресе страницы отправки в центре партнеров.For a submission that was created in Partner Center, this ID is also available in the URL for the submission page in Partner Center.

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

Предоставлять текст запроса для этого метода не требуется.Do not provide a request body for this method.

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

Следующий пример демонстрирует остановку выпуска пакета для отправки приложения.The following example demonstrates how to halt the package rollout for an app submission.

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

ОтветResponse

В следующем примере представлено тело ответа JSON в случае успешного вызова этого метода.The following example demonstrates the JSON response body for a successful call to this method. Подробнее о значениях в тексте ответа см. в описании ресурса "Выпуск пакета".For more details about the values in the response body, see Package rollout resource.

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

Коды ошибокError codes

Если запрос не удается выполнить, ответ будет содержать один из следующих кодов ошибок HTTP.If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

Код ошибкиError code ОписаниеDescription
404404 Не удалось найти отправку.The submission could not be found.
409409 Этот код указывает на одну из следующих ошибок.This code indicates one of the following errors: