Hämta ett nytt handelsmigreringsschema
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 hämtar ett nytt handelsmigreringsschema.
Viktigt!
Det här API:et är för närvarande endast tillgängligt i sandbox-klientorganisationen.
Förutsättningar
Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder autentisering med både fristående app- och App+User-autentiseringsuppgifter.
Ett kund-ID (
customer-tenant-id
). Om du inte känner till kundens ID kan du söka efter det i Partnercenter genom att välja arbetsytan Kunder , sedan kunden från kundlistan och sedan Konto. På kundens kontosida letar du efter Microsoft-ID :t i avsnittet Kundkontoinformation . Microsoft-ID:t är samma som kund-ID :t (customer-tenant-id
).Ett aktuellt prenumerations-ID
REST-begäran
Det finns två olika sätt som partner kan köra frågor på.
- Partner kan fråga för att hämta ett visst schema
- Partner kan fråga för att hämta listan över scheman för specifika kriterier
Syntax för begäran
Metod | Begärande-URI |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id}/migrations/newcommerce/schedules/{scheduleID} |
URI-parameter
Den här tabellen visar de frågeparametrar som krävs för att skapa en ny handelsmigrering.
Namn | Typ | Obligatoriskt | Beskrivning |
---|---|---|---|
customer-tenant-id | sträng | Ja | En GUID-formaterad sträng som identifierar kunden. |
Metod | Begärande-URI |
---|---|
GET | {baseURL}/v1/migrations/newcommerce/schedules? CustomerTenantId={customer-tenant-id} |
URI-parameter
Den här tabellen visar de frågeparametrar som krävs för att skapa en ny handelsmigrering. Vem som helst av frågeparametern kan användas.
Namn | Typ | Beskrivning |
---|---|---|
customerTenantId | sträng | En GUID-formaterad sträng som identifierar kunden. |
currentSubscriptionID | sträng | En GUID-formaterad sträng som identifierar det aktuella prenumerations-ID:t |
externalReferenceID | sträng | En GUID-formaterad sträng som identifierar migreringsbatchen |
Begärandehuvuden
Mer information finns i REST-huvuden för Partnercenter.
Själva svaret
Den här tabellen beskriver prenumerationsegenskaperna i svaret.
Property | Typ | Obligatoriskt | Beskrivning |
---|---|---|---|
currentSubscriptionId | sträng | Ja | En prenumerationsidentifierare som anger vilken prenumeration som kräver validering för migrering. |
termDuration | sträng | Nej | Termvaraktighet som tillämpas på migreringen. |
billingCycle | sträng | Nej | Faktureringscykel som tillämpas på migreringen. |
purchaseFullTerm | bool | Nej | Om migreringen startar en ny term eller inte. |
kvantitet | heltal | Nej | Licenskvantiteten för en prenumeration kan ökas eller minskas vid migrering. |
customTermEndDate | datetime | Nej | Ett slutdatum kan anges så att det överensstämmer med en befintlig onlinetjänstprenumeration eller kalendermånad. Det finns mer information om hur du justerar prenumerationens slutdatum här: Justera prenumerationens slutdatum i Partnercenter |
targetDate | datetime | Nej | Måldatum när migreringen ska schemaläggas. |
migrateOnRenewal | bool | Nej | Anger om schemat måste ske vid förnyelse |
status | sträng | Nej | Status för schemamigreringen |
createdTime | datetime | Nej | När schemat skapades |
lastModifiedTime | datetime | Nej | När schemat senast ändrades |
REST-svar
Om det lyckas returnerar den här metoden information om de prenumerationer som migreras (migreringsobjekt ) i svarstexten.
Svarsframgång och felkoder
Varje svar levereras med en HTTP-statuskod som indikerar framgång eller fel med ytterligare felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och fler parametrar. Den fullständiga listan finns i Rest-felkoder för Partnercenter.
Svarsexempel
[
{
"id": "f016c025-a873-47af-8b52-2516fbef4c65",
"currentSubscriptionId": "c6105a9c-36cb-4f88-92ea-9573040725c4",
"subscriptionEndDate": "2023-07-19T00:00:00Z",
"status": "Created",
"customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"quantity": 25,
"termDuration": "P1Y",
"billingCycle": "Monthly",
"purchaseFullTerm": false,
"targetDate": "2022-10-30T00:00:00",
"createdTime": "2022-10-18T21:20:50.9668605+00:00",
"lastModifiedTime": "2022-10-18T21:29:32.8992819+00:00"
}
]