Freigeben über

Anhalten des Rollouts für ein Flight

  • Artikel

Verwenden Sie diese Methode in der Microsoft Store-Übermittlungs-API, um das Rollout für eine Flight-Paket-Übermittlung anzuhalten. Weitere Informationen zum Prozess des Erstellens einer Flight-Paketübermittlung mithilfe der Microsoft Store-Übermittlungs-API finden Sie unter Verwalten von Flight-Paketübermittlungen.

Hinweis

Wenn Sie das Rollout für eine Flight-Paket-Übermittlung anhalten und dann eine neue Flight-Paket-Übermittlung erstellen, ist die neue Übermittlung ein Klon der angehaltenen Übermittlung.

Voraussetzungen

Um diese Methode zu verwenden, müssen Sie zuerst Folgendes tun:

Anfordern

Diese Methode weist die folgende Syntax auf. In den folgenden Abschnitten finden Sie Verwendungsbeispiele und Beschreibungen der Header- und Anforderungsparameter.

Methode Anforderungs-URI
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/flights/{flightId}/submissions/{submissionId}/haltpackagerollout

Anforderungsheader

Header Typ Beschreibung
Autorisierung Zeichenfolge Erforderlich. Das Azure AD-Zugriffstoken im Formular Bearer<-Token>.

Anforderungsparameter

Name Typ Beschreibung
applicationId Zeichenfolge Erforderlich. Die Store-ID der App, die die Flight-Paketübermittlung enthält, mit dem Paketrollout, das Sie anhalten möchten. Weitere Informationen zur Store-ID finden Sie unter Anzeigen von App-Identitätsdetails.
flightId Zeichenfolge Erforderlich. Die ID des Flight-Pakets, das die Übermittlung mit dem Paketrollout enthält, das Sie anhalten möchten. Diese ID steht in den Antwortdaten für Anforderungen zum Erstellen eines Flight-Pakets und zum Abrufen von Flight-Paketen für eine App zur Verfügung. Für einen Test-Flight, der im Partner Center erstellt wurde, steht diese ID auch in der URL für die Flight-Seite im Partner Center zur Verfügung.
submissionId Zeichenfolge Erforderlich. Die ID der Übermittlung mit dem Paketrollout, das angehalten werden soll. Diese ID ist in den Antwortdaten für Anforderungen zum Erstellen einer Flight-Paketübermittlung verfügbar. Für eine Übermittlung, die im Partner Center erstellt wurde, ist diese ID auch in der URL für die Übermittlungsseite im Partner Center verfügbar.

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Anforderungsbeispiel

Das folgende Beispiel veranschaulicht, wie das Paketrollout für eine Flight-Paketübermittlung angehalten wird.

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>

Antwort

Im folgenden Beispiel wird der JSON-Antworttext für einen erfolgreichen Aufruf dieser Methode veranschaulicht. Weitere Informationen zu den Werten im Antworttext finden Sie in der Paketrollout-Ressource.

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

Fehlercodes

Wenn die Anforderung nicht erfolgreich abgeschlossen werden kann, enthält die Antwort einen der folgenden HTTP-Fehlercodes.

Fehlercode BESCHREIBUNG
404 Die Flight-Paketübermittlung konnte nicht gefunden werden.
409 Dieser Code gibt einen der folgenden Fehler an:

  • Die Übermittlung befindet sich nicht in einem gültigen Zustand für den schrittweisen Rolloutvorgang (vor dem Aufrufen dieser Methode muss die Übermittlung veröffentlicht werden, und der PackageRolloutStatus-Wert muss auf PackageRolloutInProgress festgelegt werden).
  • Die Übermittlung gehört nicht zur angegebenen App.
  • Die App verwendet ein Partner Center-Feature, das derzeit von der Microsoft Store-Übermittlungs-API nicht unterstützt wird.