Dela via

Stoppa distributionen för en flygning

Använd den här metoden i Microsoft Store-api:et för överföring för att stoppa distributionen av ett paketflyg. Mer information om processen för att skapa en paketflygsinsändning med hjälp av Microsoft Store-insändnings-API:et finns i Hantera paketflyginsändningar.

Anmärkning

Om du stoppar distributionen för en paketflygningsinlämning och sedan skapar en ny inlämning av paketflygningen, kommer den nya inlämningen att vara en klon av den stoppade inlämningen.

Förutsättningar

Om du vill använda den här metoden måste du först göra följande:

  • Slutför alla krav för Microsoft Store API:et för inlämning, om du inte redan har gjort det.
  • Hämta en Azure AD-åtkomsttoken som ska användas i begärandehuvudet för den här metoden. När du har fått en åtkomsttoken har du 60 minuter på dig att använda den innan den upphör att gälla. När token har upphört att gälla kan du skaffa en ny.
  • Skapa en sändning för en av dina appar. Du kan göra detta i Partnercenter eller med hjälp av metoden skapa en appinlämning.
  • Aktivera en gradvis paketdistribution för insändningen. Du kan göra detta i Partnercenter, eller så kan du göra det med hjälp av Microsoft Store-api:et för överföring.

Begäran

Den här metoden har följande syntax. Se följande avsnitt för användningsexempel och beskrivningar av parametrarna för sidhuvud och begäran.

Metod Begäran om URI
Posten https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/flights/{flightId}/submissions/{submissionId}/haltpackagerollout

Förfrågningshuvudrad

Rubrik Typ Beskrivning
Auktorisering snöre Obligatoriskt. Azure AD-åtkomsttoken i formatet Bearer-token<>.

Parametrar för begäran

Namn Typ Beskrivning
applicationId snöre Obligatoriskt. Store-ID för appen som innehåller paketflyginskickning med den utrullning av paket som du vill stoppa. Mer information om Store-ID finns i Visa information om appidentitet.
flightId snöre Obligatoriskt. ID:t för paketflygningen som innehåller sändningen med den paketdistribution som du vill stoppa. Det här ID:t är tillgängligt i svarsdata för begäranden om att skapa en paketflygning och hämta paketflygningar för en app. För en flygning som har skapats i Partnercenter är det här ID:t också tillgängligt i URL:en för flygsidan i Partnercenter.
insändningsID snöre Obligatoriskt. ID för inlämningen som ska stoppa paketdistributionen. Det här ID:t är tillgängligt i svarsdata för förfrågningar om att skapa en paketflyginskickning. För en inlämning som har skapats i Partnercenter är detta ID också tillgängligt i URL:en för insändningssidan i Partnercenter.

begäranens innehåll

Ange ingen begärandetext för den här metoden.

Exempel på begäran

I följande exempel visas hur du avbryter paketdistributionen för en paketflygningsinsändning.

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>

Svar

I följande exempel visas JSON-svarstexten för ett lyckat anrop till den här metoden. Mer information om värdena i svarstexten finns i Resurs för paketdistribution.

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

Felkoder

Om begäran inte kan slutföras innehåller svaret någon av följande HTTP-felkoder.

Felkod Beskrivning
404 Det gick inte att hitta inlämningsordern för paketflyget.
409 Den här koden anger något av följande fel: