Delen via

Een nieuw migratieschema voor commerce ophalen

  • Artikel

Van toepassing op: Partnercentrum | Partnercentrum beheerd door 21Vianet | Partnercentrum voor Microsoft Cloud voor de Amerikaanse overheid

In dit artikel wordt beschreven hoe u een nieuw migratieschema voor commerce kunt krijgen.

Belangrijk

Deze API is momenteel alleen beschikbaar in de Sandbox-tenant.

Vereisten

  • Referenties zoals beschreven in verificatie in partnercentrum. Dit scenario ondersteunt verificatie met zowel zelfstandige app- als app+gebruikersreferenties.

  • Een klant-id (customer-tenant-id). Als u de klant-id niet weet, kunt u deze opzoeken in het Partnercentrum door de werkruimte Klanten te selecteren, vervolgens de klant in de lijst met klanten en vervolgens Account. Zoek op de pagina Account van de klant naar de Microsoft-id in de sectie Klantaccountgegevens . De Microsoft-id is hetzelfde als de klant-id (customer-tenant-id).

  • Een huidige abonnements-id

REST-aanvraag

Er zijn twee verschillende manieren waarop partners query's kunnen uitvoeren.

  • Partners kunnen een query uitvoeren om een bepaalde planning op te halen
  • Partners kunnen een query uitvoeren om de lijst met planningen voor specifieke criteria op te halen

Aanvraagsyntaxis

Methode Aanvraag-URI
GET {baseURL}/v1/customers/{customer-tenant-id}/migrations/newcommerce/schedules/{scheduleID}

URI-parameter

Deze tabel bevat de vereiste queryparameters voor het maken van een nieuwe commercemigratie.

Naam Type Vereist Beschrijving
klant-tenant-id tekenreeks Ja Een tekenreeks met GUID-indeling die de klant identificeert.
Methode Aanvraag-URI
GET {baseURL}/v1/migrations/newcommerce/schedules? CustomerTenantId={customer-tenant-id}

URI-parameter

Deze tabel bevat de vereiste queryparameters voor het maken van een nieuwe commercemigratie. Iedereen van de queryparameter kan worden gebruikt.

Naam Type Beschrijving
customerTenantId tekenreeks Een tekenreeks met GUID-indeling die de klant identificeert.
currentSubscriptionID tekenreeks Een tekenreeks met GUID-indeling die de huidige abonnements-id identificeert
externalReferenceID tekenreeks Een tekenreeks met GUID-indeling die de migratiebatch identificeert

Aanvraagheaders

Zie Rest-headers in Partnercentrum voor meer informatie.

Hoofdtekst van de reactie

In deze tabel worden de abonnementseigenschappen in het antwoord beschreven.

Eigenschappen Type Vereist Beschrijving
currentSubscriptionId tekenreeks Ja Een abonnements-id die aangeeft welk abonnement validatie voor migratie vereist.
termDuration tekenreeks Nee Duur van de term die is toegepast op de migratie.
billingCycle tekenreeks Nee Factureringscyclus die is toegepast op de migratie.
purchaseFullTerm bool Nee Of de migratie nu een nieuwe term start of niet.
quantity int Nee De licentiehoeveelheid voor een abonnement kan worden verhoogd of verlaagd bij de migratie.
customTermEndDate datetime Nee Een einddatum kan worden ingesteld om te worden afgestemd op een bestaand niet-trial OnlineServicesNCE-abonnement of kalendermaand. Hier vindt u meer informatie over het uitlijnen van de einddatums van het abonnement: Einddatums van het abonnement uitlijnen in het Partnercentrum
targetDate datetime Nee Doeldatum waarop de migratie moet worden gepland.
migrateOnRenewal bool Nee Geeft aan of het schema moet worden uitgevoerd bij verlenging
status tekenreeks Nee Status van de planningsmigratie
createdTime datetime Nee Wanneer de planning is gemaakt
lastModifiedTime datetime Nee Wanneer de planning voor het laatst is gewijzigd

REST-antwoord

Als dit lukt, retourneert deze methode details van de abonnementen die worden gemigreerd (migratieobject) in de hoofdtekst van het antwoord.

Geslaagde antwoorden en foutcodes

Elk antwoord wordt geleverd met een HTTP-statuscode die aangeeft dat de fout is geslaagd of mislukt met verdere foutopsporingsgegevens. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en meer parameters te lezen. Zie rest-foutcodes in Partnercentrum voor de volledige lijst.

Antwoordvoorbeelden

[
{
"id": "f016c025-a873-47af-8b52-2516fbef4c65",
"currentSubscriptionId": "c6105a9c-36cb-4f88-92ea-9573040725c4",
"subscriptionEndDate": "2023-07-19T00:00:00Z",
"status": "Created",
"customerTenantId": "6f297517-16e6-4313-8c6d-4e10496d2871",
"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"
}
]

Zie ook