Interrompere l'implementazione per un invio dell'appHalt the rollout for an app submission

Usare questo metodo nell'API di invio Microsoft Store per interrompere l'implementazione del pacchetto per l'invio di un'app.Use this method in the Microsoft Store submission API to halt the package rollout for an app submission. Per altre informazioni sul processo di creazione di un invio di app usando l'API di invio Microsoft Store, vedere gestire gli invii di app.For more information about the process of process of creating an app submission by using the Microsoft Store submission API, see Manage app submissions.

Nota

Se si interrompe l'implementazione per l'invio di un'app e quindi si Crea un nuovo invio dell'app, il nuovo invio è un clone dell'invio interrotto.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.

PrerequisitiPrerequisites

Per usare questo metodo, devi prima eseguire le operazioni seguenti:To use this method, you need to first do the following:

  • Se non è già stato fatto, completare tutti i prerequisiti per l'API di invio Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • Ottieni un token di accesso di Azure AD da usare nell'intestazione della richiesta per questo metodo.Obtain an Azure AD access token to use in the request header for this method. Dopo aver ottenuto un token di accesso, questo sarà disponibile per 60 minuti prima della scadenza.After you obtain an access token, you have 60 minutes to use it before it expires. Dopo la scadenza del token, puoi ottenerne uno nuovo.After the token expires, you can obtain a new one.
  • Creare un invio per una delle app.Create a submission for one of your apps. Questa operazione può essere eseguita nel centro per i partner oppure è possibile usare il metodo Create an app Submission .You can do this in Partner Center, or you can do this by using the create an app submission method.
  • Abilita un'implementazione graduale del pacchetto per l'invio.Enable a gradual package rollout for the submission. Questa operazione può essere eseguita nel centroper i partner oppure è possibile usare l'API di invio Microsoft Store.You can do this in Partner Center, or you can do this by using the Microsoft Store submission API.

RichiestaRequest

La sintassi di questo metodo è la seguente.This method has the following syntax. Vedi le sezioni seguenti per esempi di uso e descrizioni dell'intestazione e dei parametri della richiesta.See the following sections for usage examples and descriptions of the header and request parameters.

MetodoMethod URI richiestaRequest URI
POSTPOST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout

Intestazione della richiestaRequest header

IntestazioneHeader TipoType DescrizioneDescription
AutorizzazioneAuthorization stringstring Obbligatorio.Required. Il token di accesso Azure ad nel token di connessione del modulo < token > .The Azure AD access token in the form Bearer <token>.

Parametri della richiestaRequest parameters

NomeName TipoType DescrizioneDescription
applicationIdapplicationId stringstring Obbligatorio.Required. ID dello Store dell'app che contiene l'invio con l'implementazione del pacchetto che vuoi interrompere.The Store ID of the app that contains the submission with the package rollout you want to halt. Per altre informazioni sull'ID dello Store, vedi Visualizzare i dettagli dell'identità dell'app.For more information about the Store ID, see View app identity details.
submissionIdsubmissionId stringstring Obbligatorio.Required. ID dell'invio con l'implementazione del pacchetto che vuoi interrompere.The ID of the submission with the package rollout you want to halt. Questo ID è disponibile nei dati della risposta per le richieste di creazione di un invio dell'app.This ID is available in the response data for requests to create an app submission. Per un invio creato in Partner Center, questo ID è disponibile anche nell'URL per la pagina di invio nel centro per i partner.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 della richiestaRequest body

Non includere il contenuto della richiesta per questo metodo.Do not provide a request body for this method.

Esempio di richiestaRequest example

L'esempio seguente illustra come interrompere l'implementazione del pacchetto per un invio di app.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>

RispostaResponse

L'esempio seguente illustra il contenuto della risposta JSON per una chiamata a questo metodo.The following example demonstrates the JSON response body for a successful call to this method. Per altri dettagli sui valori nel contenuto della risposta, vedi la risorsa implementazione del pacchetto.For more details about the values in the response body, see Package rollout resource.

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

Codici di erroreError codes

Se la richiesta non può essere completata, la risposta conterrà uno dei seguenti codici di errore HTTP.If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

Codice di erroreError code DescrizioneDescription
404404 Non è possibile trovare l'invio.The submission could not be found.
409409 Questo codice indica uno degli errori seguenti:This code indicates one of the following errors: