Compartir a través de

Detener el lanzamiento del envío de una aplicación

  • Artículo

Usa este método en la API de envío de Microsoft Store para detener el lanzamiento del paquete para un envío de aplicación. Para obtener más información sobre el proceso de creación de un envío de aplicación mediante la API de envío de Microsoft Store, consulta Administrar envíos de aplicaciones.

Nota:

Si detienes el lanzamiento de un envío de aplicación y, a continuación , creas un nuevo envío de aplicación, el nuevo envío es un clon del envío detenido.

Requisitos previos

Para usar este método, primero debes hacer lo siguiente:

  • Si aún no lo ha hecho, complete todos los requisitos previos para la API de envío de Microsoft Store.
  • Consigue un token de acceso a Azure AD para utilizarlo en el encabezado de solicitud de este método. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire. Una vez que expire el token, puede obtener uno nuevo.
  • Cree un envío para una de las aplicaciones. Puede hacerlo en el Centro de partners o puede hacerlo mediante el método de creación de una aplicación de envío .
  • Habilite una implementación gradual de paquetes para el envío. Puedes hacerlo en el Centro de partners o puedes hacerlo mediante la API de envío de Microsoft Store.

Solicitar

Este método tiene la sintaxis siguiente. Consulte las secciones siguientes para ver ejemplos de uso y descripciones de los parámetros de encabezado y solicitud.

Método URI de solicitud
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout

Encabezado de solicitud

Encabezado Tipo Descripción
Autorización string Necesario. Token de acceso de Azure AD con el formato Token<de portador>.

Parámetros de solicitud

Nombre Escribir Descripción
applicationId string Necesario. El identificador de la Tienda de la aplicación que contiene el envío con el lanzamiento del paquete que quiere detener. Para obtener más información sobre el identificador de la Tienda, consulta Ver los detalles de la identidad de la aplicación.
submissionId string Necesario. Identificador del envío con el lanzamiento del paquete que desea detener. Este identificador está disponible en los datos de respuesta de las solicitudes para crear un envío de aplicación. Para un envío creado en el Centro de partners, este identificador también está disponible en la dirección URL de la página de envío en el Centro de partners.

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Ejemplo de solicitud

En el ejemplo siguiente se muestra cómo detener el lanzamiento del paquete para un envío de aplicación.

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

Respuesta

En el ejemplo siguiente se muestra el cuerpo de la respuesta JSON para una llamada correcta a este método. Para obtener más información sobre los valores en el cuerpo de la respuesta, consulte Recurso de lanzamiento de paquetes.

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

Códigos de error

Si la solicitud no se puede completar correctamente, la respuesta contendrá uno de los siguientes códigos de error HTTP.

Código de error Descripción
404 No se encontró el envío.
409 Este código indica uno de los siguientes errores:

  • El envío no está en un estado válido para la operación de lanzamiento gradual (antes de llamar a este método, el envío debe publicarse y el valor packageRolloutStatus debe establecerse en PackageRolloutInProgress).
  • El envío no pertenece a la aplicación especificada.
  • La aplicación usa una característica del Centro de partners que actualmente no es compatible con la API de envío de Microsoft Store.