Interromper a distribuição para um envio de aplicativo

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. 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.

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.

Pré-requisitos

Para usar este método, primeiro você precisa do seguinte:

• Se você não tiver feito isso, conclua todos os pré-requisitos para a API de envio da Microsoft Store.
• Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para este método. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. Depois que o token expirar, você poderá obter um novo.
• Crie um envio para um de seus aplicativos. Você pode fazer isso no Partner Center ou pode fazer isso usando o método criar um envio de aplicativo .
• Habilite uma distribuição de pacote gradual para o envio. Você pode fazer isso no Partner Center ou pode fazer isso usando a API de envio da Microsoft Store.

Solicitação

Esse método tem a seguinte sintaxe. Veja as seções a seguir para obter exemplos de uso e descrições dos parâmetros do cabeçalho e da solicitação.

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

Cabeçalho da solicitação

parâmetro	Tipo	Descrição
Autorização	string	Obrigatórios. O token de acesso Azure AD notoken> de portador< do formulário.

Parâmetros da solicitação

Nome	Type	Descrição
applicationId	string	Obrigatórios. A ID da Loja do aplicativo que contém o envio com a porcentagem da distribuição de pacote que você deseja parar. Para saber mais informações sobre a ID da Loja, consulte Exibir detalhes de identidade de aplicativo.
submissionId	string	Obrigatórios. A ID do envio com a distribuição de pacote que você deseja parar. Esse ID está disponível nos dados de resposta para solicitações para criar um envio de aplicativo. Para um envio criado no Partner Center, essa ID também está disponível na URL para a página de envio no Partner Center.

Corpo da solicitação

Não forneça um corpo da solicitação para esse método.

Exemplo de solicitação

O exemplo a seguir demonstra como parar a distribuição de pacote para um envio de aplicativo.

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

Resposta

O exemplo a seguir demonstra o corpo da resposta JSON para uma chamada bem-sucedida para esse método. Para obter mais detalhes sobre os valores no corpo da resposta, consulte Recurso da distribuição de pacote.

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

Códigos do Erro

Se não for possível concluir a solicitação, a resposta conterá um dos seguintes códigos de erro HTTP.

Código do erro	Descrição
404	O envio não foi encontrado.
409	Este código indica um dos seguintes erros: O envio não está em um estado válido para a operação de distribuição gradual (antes de chamar esse método, o envio deve ser publicado, e o valor packageRolloutStatus deve ser definido como PackageRolloutInProgress). O envio não pertence ao aplicativo especificado. O aplicativo usa um recurso do Partner Center que atualmente não é compatível com a API de envio da Microsoft Store.

Tópicos relacionados

• Distribuição de pacote gradual
• Gerenciar envios de app usando a API de envio da Microsoft Store
• Criar e gerenciar envios usando serviços da Microsoft Store