Получение пользовательских дат окончания срока

Статья
02/19/2024

Область применения: Центр партнеров | Центр партнеров, управляемый 21Vianet | Центр партнеров для Microsoft Cloud for US Government

Партнеры могут просматривать пользовательские даты окончания срока для подписок на основе лицензий на основе NCE, которые они покупают для своих клиентов. Партнеры могут просматривать даты окончания, которые соответствуют концу календарного месяца или с существующими подписками клиентов.

API поддерживают только вычисление пользовательских дат окончания срока покупки новых подписок, а не для продления существующих подписок.

Необходимые компоненты

Учетные данные, описанные в статье о проверке подлинности в Центре партнеров. Этот сценарий поддерживает проверку подлинности с помощью автономных учетных данных приложения и приложения и пользователя.
A CustomerTenantId. Если вы не знаете идентификатор клиента, его можно найти в Центре партнеров, выбрав рабочую область "Клиенты" , затем клиент из списка клиентов, а затем учетная запись. На странице "Учетная запись клиента" найдите идентификатор Майкрософт в разделе "Сведения о учетной записи клиента". Идентификатор Майкрософт совпадает с идентификатором клиента.

Запрос REST

Синтаксис запроса

Способ	URI запроса
GET	{baseURL}/v1/customers/{customerId}/subscriptions/customTermEndDates

Строки запроса

В этой таблице перечислены строки запроса, необходимые для фильтрации и получения пользовательских дат окончания термина.

Имя:	Нужно:	Описание.
term_duration	Да	Представление срока действия термина ISO 8601. Текущие поддерживаемые значения: P1M (1 месяц), P1Y (1 год) и P3Y (3 года).
term_start_date	No	Предполагаемая дата покупки. Это не может быть в прошлом.
target_coterm_subscription_id	No	Строка с форматом GUID, определяющая подписку для coterm.

Заголовки запросов

Дополнительные сведения см. в статье о заголовках REST Центра партнеров. Ответ API возвращает не более 300 записей страниц. Если в входном запросе возвращаются более 300 записей, маркер продолжения предоставляется в заголовке ответа. Маркер продолжения можно ввести в заголовок следующего запроса, чтобы вернуть дополнительные записи страниц, запрашиваемые.

Текст запроса

Нет.

Ответ REST

В случае успешного выполнения этот метод возвращает сведения о подписках, перенесенных (объект миграции) в тексте ответа. Это включает идентификатор миграции.

Коды успешного выполнения и ошибок в ответе

Каждый ответ сопровождается кодом состояния HTTP, обозначающим успешное или неудачное выполнение, и дополнительными сведениями для отладки. Используйте средство трассировки сети, чтобы просматривать этот код, тип ошибки и дополнительные параметры. Полный список ответов есть в статье Коды ошибок REST в Центре партнеров.

Примеры URL-адресов запроса

baseurl/v1/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M

Примеры ответов

 {
    "totalCount": 2,
    "items": [
        {
            "allowedCustomTermEndDateType": "calendarMonthAligned",
            "allowedCustomTermEndDate": "2023-07-31T00:00:00"
        },
        {
            "allowedCustomTermEndDateType": "subscriptionAligned",
            "cotermSubscriptionIds": [
               "5fcf618b-1daa-4604-da99-cc3e1c9ee422",
               "d30a9ff9-713e-4546-c97e-f06b9dcf6ef6"
            ],
            "allowedCustomTermEndDate": "2023-08-01T00:00:00"
        }
    ],
    "links": {
        "self": {
            "uri": "/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
 }

Поделиться через