Compartilhar via

Interromper o lançamento de um voo

  • Artigo

Use esse método na API de envio da Microsoft Store para interromper a distribuição de um envio de pacote de pré-lançamento. Para obter mais informações sobre o processo de criação de um envio de pacote de pré-lançamento usando a API de envio da Microsoft Store, consulte Gerenciar envios de pacote de pré-lançamento.

Observação

Se você interromper a distribuição de um envio de pacote de pré-lançamento e, em seguida, criar um novo envio de pacote de pré-lançamento, o novo envio será um clone do envio interrompido.

Pré-requisitos

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

  • Se você ainda 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 esse 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 de criação de um envio de aplicativo.
  • Habilite uma distribuição gradual do pacote para o envio. Você pode fazer isso no Partner Center ou pode fazer isso usando a API de envio da Microsoft Store.

Solicitar

Esse método tem a seguinte sintaxe. 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 da solicitação
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/flights/{flightId}/submissions/{submissionId}/haltpackagerollout

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização string Obrigatório. O token de acesso do Azure AD no Token<de portador> do formulário.

Parâmetros da solicitação

Nome Tipo Descrição
applicationId string Obrigatória. A ID da Loja do aplicativo que contém o envio do pacote de pré-lançamento 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 do voo string Obrigatória. A ID do pacote de pré-lançamento que contém o envio com a distribuição do pacote que você deseja interromper. Essa ID está disponível nos dados de resposta para solicitações para criar um pacote de pré-lançamento e obter pacotes de pré-lançamento para um aplicativo. Para um voo criado no Partner Center, essa ID também está disponível na URL da página de voo no Partner Center.
submissionId string Obrigatória. A ID do envio com a distribuição do pacote a ser interrompida. Essa ID está disponível nos dados de resposta para solicitações para criar um envio de pacote de pré-lançamento. Para um envio criado no Partner Center, essa ID também está disponível na URL da página de envio no Partner Center.

Corpo da solicitação

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

Exemplo de solicitação

O exemplo a seguir demonstra como interromper a distribuição do pacote para um envio de pacote de pré-lançamento.

POST https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/flights/43e448df-97c9-4a43-a0bc-2a445e736bcd/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 de distribuição do pacote.

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

Códigos do 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 do pacote de pré-lançamento.
409 Esse 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.