Interromper a distribuição para um envio de aplicativoHalt the rollout for an app submission

Use esse método na API de envio da Microsoft Store a fim de parar a distribuição de pacote para um envio de aplicativo.Use this method in the Microsoft Store submission API to halt the package rollout for an app submission. Para obter mais informações sobre o processo de criação de um envio de aplicativo, usando a API de envio da Microsoft Store, consulte Gerenciar envios de aplicativo.For more information about the process of process of creating an app submission by using the Microsoft Store submission API, see Manage app submissions.

Observação

Se você interromper a distribuição de um envio de aplicativo e depois criar um novo envio de aplicativo, o novo envio será um clone do interrompido.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.

Pré-requisitosPrerequisites

Para usar este método, primeiro você precisa do seguinte:To use this method, you need to first do the following:

SolicitaçãoRequest

Esse método tem a seguinte sintaxe.This method has the following syntax. Veja as seções a seguir para obter exemplos de uso e descrições dos parâmetros do cabeçalho e da solicitação.See the following sections for usage examples and descriptions of the header and request parameters.

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout

Cabeçalho da solicitaçãoRequest header

CabeçalhoHeader TipoType DescriçãoDescription
AutorizaçãoAuthorization stringstring Obrigatórios.Required. O token de acesso do Azure AD no formulário Bearer <token>.The Azure AD access token in the form Bearer <token>.

Parâmetros da solicitaçãoRequest parameters

NomeName TipoType DescriçãoDescription
applicationIdapplicationId stringstring Obrigatórios.Required. A ID da Loja do aplicativo que contém o envio com a porcentagem da distribuição de pacote que você deseja parar.The Store ID of the app that contains the submission with the package rollout you want to halt. Para saber mais informações sobre a ID da Loja, consulte Exibir detalhes de identidade de aplicativo.For more information about the Store ID, see View app identity details.
submissionIdsubmissionId stringstring Obrigatórios.Required. A ID do envio com a distribuição de pacote que você deseja parar.The ID of the submission with the package rollout you want to halt. Esse ID está disponível nos dados de resposta para solicitações para criar um envio de aplicativo.This ID is available in the response data for requests to create an app submission. Para um envio criado no Partner Center, essa ID também está disponível na URL da página de envio no Partner Center.For a submission that was created in Partner Center, this ID is also available in the URL for the submission page in Partner Center.

Corpo da solicitaçãoRequest body

Não forneça um corpo da solicitação para esse método.Do not provide a request body for this method.

Exemplo de solicitaçãoRequest example

O exemplo a seguir demonstra como parar a distribuição de pacote para um envio de aplicativo.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>

RespostaResponse

O exemplo a seguir demonstra o corpo da resposta JSON para uma chamada bem-sucedida para esse método.The following example demonstrates the JSON response body for a successful call to this method. Para obter mais detalhes sobre os valores no corpo da resposta, consulte Recurso da distribuição de pacote.For more details about the values in the response body, see Package rollout resource.

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

Códigos do ErroError codes

Se não for possível concluir a solicitação, a resposta conterá um dos seguintes códigos de erro HTTP.If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

Código do erroError code DescriçãoDescription
404404 O envio não foi encontrado.The submission could not be found.
409409 Este código indica um dos seguintes erros:This code indicates one of the following errors: