Avbryt en beställning från sandbox-miljön för integrering med hjälp av Partnercenter-API:er
gäller för: Partnercenter | Partnercenter som drivs av 21Vianet | Partnercenter för Microsoft Cloud for US Government
Den här artikeln beskriver hur du använder API:er för Partnercenter för att avbryta olika typer av prenumerationsbeställningar från integrationssandbox-konton. Sådana beställningar kan omfatta reserverade instanser, programvara och SaaS-prenumerationsbeställningar (Software as a Service, Programvara som en tjänst).
I följande tabell visas avbokningsordning i sandbox-miljö och produktionsmiljö.
Produkttyp | Uppdateringsordning för Sandbox-miljö | Sandbox-uppdateringsprenumeration | Produktionsuppdateringsordning | Prenumeration på produktionsuppdatering |
---|---|---|---|---|
Azure-reserverade instanser | Y | N | N | N |
Programvara med evig licens | Y | N | Y | N |
Programvaruprenumerationer | Y | Y | Y | Y |
Ny handel | N | Y | N | Y |
Kommersiell marknadsplats | N | Y | N | Y |
Azureplanen | N | Y | N | Y |
Not
Annulleringar av en reserverad instans eller SaaS-prenumerationsbeställningar på kommersiella marknadsplatsen kan endast göras från konton i en integreringssandbox. Alla sandbox-beställningar som är äldre än 60 dagar kan inte avbrytas från Partnercenter.
Om du vill avbryta produktionsbeställningar av programvara via API använder du avbryt programvaruköp. Du kan också avbryta produktionsorder av programvara via instrumentpanelen genom att använda avbryta ett köp.
Förutsättningar
Autentiseringsuppgifter enligt beskrivningen i Partner Center-autentisering. Det här scenariot stöder autentisering med både fristående app- och App+User-autentiseringsuppgifter.
Ett partnerkonto i en sandbox-för integreringar med en kund som har en aktiv reserverad instans-/programvara-/prenumerationsbeställning av SaaS från tredje part.
C#
Om du vill avbryta en beställning från integreringssandlådan skickar du autentiseringsuppgifterna för ditt konto till metoden CreatePartnerOperations
för att få ett IPartner
gränssnitt för att utföra partneroperationer.
Om du vill välja en viss Orderanvänder du partneråtgärderna och anropar Customers.ById()
-metoden med kundidentifieraren för att ange kunden, följt av Orders.ById()
med orderidentifierare för att ange beställningen och slutligen Get
eller GetAsync
metod för att hämta den.
Ange egenskapen Order.Status
till cancelled
och använd metoden Patch()
för att uppdatera ordningen.
// IPartnerCredentials tipAccountCredentials;
// Customer tenant Id to be deleted.
// string customerTenantId;
IPartner tipAccountPartnerOperations = PartnerService.Instance.CreatePartnerOperations(tipAccountCredentials);
// Cancel order
var order = tipAccountPartnerOperations.Customers.ById(customerTenantId).Orders.ById(orderId).Get();
order.Status = "cancelled";
order = tipAccountPartnerOperations.Customers.ById(customerTenantId).Orders.ById(orderId).Patch(order);
REST-begäran
Syntax för begäran
Metod | Begärande-URI |
---|---|
PATCH | {baseURL}/v1/customers/{customer-tenant-id}/orders/{order-id} HTTP/1.1 |
URI-parametrar
Använd följande frågeparameter för att ta bort en kund.
Namn | Typ | Krävs | Beskrivning |
---|---|---|---|
kund-hyresgäst-id | guid | Y | Värdet är ett GUID-formaterat customer-tenant-id som gör att återförsäljaren kan filtrera resultatet för en viss kund som tillhör återförsäljaren. |
order-id | sträng | Y | Värdet är en sträng som anger order-ID:t som måste avbrytas. |
Begärandehuvuden
Mer information finns i REST-huvuden för Partnercenter.
Begärandetext
{
"id": "UKXASSO1dezh3HdxClHxSp5UEFXGbAnt1",
"status": "cancelled",
}
Exempel på begäran
PATCH https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>/orders/<order-id> HTTP/1.1
Accept: application/json
MS-RequestId: 655890ba-4d2b-4d09-a95f-4ea1348686a5
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
{
"id": "UKXASSO1dezh3HdxClHxSp5UEFXGbAnt1",
"status": "cancelled",
}
REST-svar
Om det lyckas returnerar den här metoden den avbrutna ordern.
Svarsframgång och felkoder
Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och mer felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och andra parametrar. Den fullständiga listan finns i Partner Center REST-felkoder.
Svarsexempel
HTTP/1.1 200 OK
Content-Length: 866
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 655890ba-4d2b-4d09-a95f-4ea1348686a5
{
"id": "UKXASSO1dezh3HdxClHxSp5UEFXGbAnt1",
"alternateId": "11fc4bdfd47a",
"referenceCustomerId": "bd59b416-37f9-4d8f-8df3-5750111fc615",
"billingCycle": "one_time",
"currencyCode": "USD",
"currencySymbol": "$",
"lineItems": [
{
"lineItemNumber": 0,
"offerId": "DG7GMGF0DWT0:0001:DG7GMGF0DSQR",
"termDuration": "",
"transactionType": "New",
"friendlyName": "Microsoft Identity Manager 2016 - 1 User CAL",
"quantity": 1,
"links": {
"product": {
"uri": "/products/DG7GMGF0DWT0?country=US",
"method": "GET",
"headers": []
},
"sku": {
"uri": "/products/DG7GMGF0DWT0/skus/0001?country=US",
"method": "GET",
"headers": []
},
"availability": {
"uri": "/products/DG7GMGF0DWT0/skus/0001/availabilities/DG7GMGF0DSQR?country=US",
"method": "GET",
"headers": []
}
}
}
],
"creationDate": "2019-02-21T17:56:21.1335741Z",
"status": "cancelled",
"transactionType": "UserPurchase",
"attributes": {
"objectType": "Order"
}
}