Compartilhar via


Interromper o lançamento de uma submissão de aplicativo

Use esse método na API de envio da Microsoft Store para interromper o de distribuição do 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ê suspender a distribuição de uma submissão de aplicativo e criar uma nova submissão de aplicativo, a nova submissão será um clone da submissão suspensa.

Pré-requisitos

Para usar esse método, primeiro você precisa fazer o seguinte:

  • Se você ainda não fez 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 esse método. Depois de obter um token de acesso, você terá 60 minutos para usá-lo antes que ele expire. Depois que o token expirar, você poderá obter um novo.
  • Crie uma submissão 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 .
  • Permita uma distribuição gradual do pacote durante o envio. Você pode fazer isso no Partner Center, ou você pode fazer isso usando a API de envio da Microsoft Store.

Solicitação

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

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

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização corda Obrigatório O token de acesso do Azure AD no formato Bearer<token>.

Parâmetros de solicitação

Nome Tipo Descrição
ID do aplicativo corda Obrigatório A ID da Loja do aplicativo que contém o envio com a distribuição do pacote que você deseja interromper. Para obter mais informações sobre a ID da Loja, consulte Exibir detalhes da identidade do aplicativo.
ID de submissão corda Obrigatório A ID do envio com a distribuição do pacote que você deseja interromper. Esta ID está disponível nos dados de resposta para solicitações para criar uma submissão 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 de solicitação para este método.

Exemplo de solicitação

O exemplo a seguir demonstra como interromper 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 de uma chamada bem-sucedida a este método. Para mais detalhes sobre os valores no corpo da resposta, veja o recurso de lançamento de pacote .

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

Códigos de erro

Se a solicitação não puder ser concluída com êxito, a resposta conterá um dos seguintes códigos de erro HTTP.

Código do erro Descrição
404 Não foi possível encontrar o envio.
409 Esse código indica um dos seguintes erros: