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