Получите новое расписание миграции коммерции
Область применения: Центр партнеров | Центр партнеров, управляемый 21Vianet | Центр партнеров для облака Microsoft для правительства США
В этой статье описывается, как получить новое расписание перехода на торговую платформу.
Внимание
Этот API в настоящее время доступен только для среды Sandbox.
Предварительные условия
Учетные данные, описанные в разделе Центра партнеров, посвященном аутентификации. Этот сценарий поддерживает аутентификацию с использованием как автономных учетных данных приложения, так и учетных данных приложения и пользователя.
Идентификатор клиента (
customer-tenant-id). Если вы не знаете идентификатор клиента, его можно найти в Центре партнеров, выбрав рабочую область "Клиенты" , затем клиент из списка клиентов, а затем учетная запись. На странице учетной записи клиента найдите Идентификатор Майкрософт в разделе Сведения об учетной записи клиента. Идентификатор Майкрософт совпадает с идентификатором клиента (customer-tenant-id).Идентификатор текущей подписки
Запрос REST
Существует два разных способа отправки запросов партнерам.
- Партнеры могут запрашивать, чтобы получить определенное расписание
- Партнеры могут запрашивать список расписаний для определенных критериев
Синтаксис запроса
| Method | URI запроса |
|---|---|
| GET | {baseURL}/v1/customers/{customer-tenant-id}/migrations/newcommerce/schedules/{scheduleID} |
Параметр URI
В этой таблице перечислены необходимые параметры запроса для создания новой миграции в сфере коммерции.
| Имя | Тип | Обязательное поле | Description |
|---|---|---|---|
| идентификатор-клиента-арендатора | строка | Да | Строка в формате GUID, идентифицирующая клиента. |
| Method | URI запроса |
|---|---|
| GET | {baseURL}/v1/migrations/newcommerce/schedules?CustomerTenantId={customer-tenant-id} |
Параметр идентификатора ресурса (URI)
В этой таблице перечислены необходимые параметры запроса для создания новой коммерческой миграции. Любой из параметров запроса можно использовать.
| Имя | Тип | Description |
|---|---|---|
| ИдентификаторАрендатораКлиента | строка | Строка в формате GUID, определяющая клиента. |
| идентификаторТекущейПодписки | строка | Строка с форматированием GUID, определяющая текущий идентификатор подписки |
| внешний идентификатор ссылки | строка | Строка в формате GUID, идентифицирующая пакет миграции |
Заголовки запросов
Дополнительные сведения см. в статье о заголовках REST Центра партнеров.
Текст ответа
В этой таблице описываются свойства подписки в ответе.
| Свойство | Тип | Обязательное поле | Description |
|---|---|---|---|
| текущийИдентификаторПодписки | строка | Да | Идентификатор подписки, указывающий, какая подписка требует проверки для миграции. |
| длительность срока | строка | Нет | Длительность, применяемая к миграции. |
| billingCycle | строка | Нет | Цикл выставления счетов, применяемый к миграции. |
| приобретениеFullTerm | bool | Нет | Начинается ли миграция с нового термина или нет. |
| количество | INT | Нет | Количество лицензий для подписки может быть увеличено или уменьшено при миграции. |
| дата окончания пользовательского срока | дата и время | Нет | Можно установить дату окончания, чтобы она соответствовала существующей подписке OnlineServicesNCE или календарному месяцу. Дополнительные сведения о выравнивании дат окончания подписки см. здесь: выравнивание дат окончания подписки в Центре партнеров |
| целевая дата | дата и время | Нет | Целевая дата, когда необходимо запланировать миграцию. |
| миграцияПриОбновлении | bool | Нет | Указывает, нужно ли выполнить расписание при продлении |
| статус | строка | Нет | Состояние миграции расписания |
| createdTime | дата и время | Нет | При создании расписания |
| время последнего изменения | дата и время | Нет | После последнего изменения расписания |
Ответ REST
В случае успешного выполнения этот метод возвращает сведения о переносе подписок (объект миграции) в тексте ответа.
Коды успешного и ошибочного ответа
Каждый ответ содержит код состояния HTTP, указывающий на успех или сбой с дополнительными сведениями об отладке. Используйте средство трассировки сети для чтения этого кода, типа ошибки и других параметров. Полный список ответов есть в статье Коды ошибок REST в Центре партнеров.
Примеры ответов
[
{
"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"
}
]