Получение информации об использовании лицензий по подпискам Microsoft

Метод используется для получения информации об использовании лицензий по подпискам Microsoft для аккаунта, к которому есть доступ у текущего пользователя. Для вызова метода у аккаунта в платформе должны быть сохранены Tenant Name и Tenant ID. В результате вызова метода модуль MicrosoftCSPProductsPlugin запрашивает информацию о тенанте аккаунта на стороне Microsoft (см. Получение списка доступных лицензий).

GET {reseller_domain}/plugin_microsoft_csp_products/internal_api/usage_licenses

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	query	integer	Обязательный	ID аккаунта, для которого запрашивается информация об использовании лицензий по подпискам Microsoft

Модель ответа

Название			Тип данных	Описание	Параметр ответа от Microsoft
data			array of objects	Данные ответа. Список подписок Microsoft с информацией о лицензиях
	available_units		integer	Количество доступных лицензий. Рассчитывается как разность между общим количеством и назначенными лицензиями	items.availableUnits
	active_units		integer	Количество активных лицензий	items.activeUnits
	consumed_units		integer	Количество назначенных лицензий	items.consumedUnits
	suspended_units		integer	Количество остановленных лицензий	items.suspendedUnits
	total_units		integer	Общее количество лицензий. Рассчитывается как сумма активных лицензий и лицензий с предупреждением	items.totalUnits
	warning_units		integer	Количество лицензий с предупреждением	items.warningUnits
	product_sku		object	Информация о продукте (лицензии)
		id	string	ID продукта (лицензии)	items.productSku.id
		name	string	Название продукта (лицензии)	items.productSku.name
		sku_part_number	string	SKU продукта (лицензии)	items.productSku.skuPartNumber
		license_group_id	string	Идентификатор группы лицензий: group1 — все продукты, лицензии которых могут управляться через Azure Active Directory (AAD). group2 — продукты, лицензии которых не могут управляться через Azure Active Directory (AAD).	items.productSku.licenseGroupId
		target_type	string	Целевой тип продукта. Это свойство определяет, применяется ли продукт к объекту User или объекту Tenant	items.productSku.targetType
meta			object	Дополнительная информация
	logotype		string	Ссылка на логотип продукта

Пример запроса

Bash

curl --location --request GET 'https://test.activeplatform.com/plugin_microsoft_csp_products/internal_api/usage_licenses?account_id=1938' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

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

JSON

{
  "data": [
    {
      "available_units": 1,
      "active_units": 1,
      "consumed_units": 0,
      "suspended_units": 1,
      "total_units": 1,
      "warning_units": 0,
      "product_sku": {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "name": "Microsoft Viva Suite",
        "sku_part_number": "VIVA",
        "license_group_id": "group1",
        "target_type": "User"
      }
    },
    {
      "available_units": 1,
      "active_units": 1,
      "consumed_units": 0,
      "suspended_units": 0,
      "total_units": 1,
      "warning_units": 0,
      "product_sku": {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "name": "Windows 365 Enterprise 2 vCPU, 8 GB, 128 GB",
        "sku_part_number": "CPC_E_2C_8GB_128GB",
        "license_group_id": "group1",
        "target_type": "User"
      }
    }
  ],
  "meta": {
    "logotype": null
  }
}