Device Group - List By Name

Служба:

Azure Sphere Public API

Версия API:

v2

Возвращает все группы устройств с указанным именем.

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/devicegroups/name/{deviceGroupName}

С использованием необязательных параметров:

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/devicegroups/name/{deviceGroupName}?maxPageSize={maxPageSize}

Параметры URI

Имя	В	Обязательно	Тип	Описание
deviceGroupName	path	True	string	Имя DeviceGroup.
tenantId	path	True	string uuid	Идентификатор клиента Azure Sphere.
maxPageSize	query		integer int32	Максимальное количество результатов, которое должно быть включено в ответ.

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

Имя	Обязательно	Тип	Описание
Sphere-Continuation		string	Маркер продолжения, используемый для продолжения с предыдущей страницы результатов.

Ответы

Имя	Тип	Описание
200 OK	DeviceGroupV2ItemCollectionResponse	Успех.

Определения

Имя	Описание
Deployment
DeviceGroupV2
DeviceGroupV2ItemCollectionResponse

Deployment

Имя	Тип	Описание
DeployedImages	string[]	Идентификаторы образов, которые в настоящее время находятся в этом развертывании.
DeploymentDateUtc	string	Дата и время создания развертывания.
Id	string	Уникальный идентификатор развертывания.
TenantId	string	Уникальный идентификатор клиента, которому принадлежит развертывание.

DeviceGroupV2

Имя	Тип	Описание
AllowCrashDumpsCollection	boolean	Включает сбор аварийных дампов для определенной группы устройств
CurrentDeployment	Deployment
Description	string	Описание группы устройств.
Id	string	Уникальный идентификатор группы устройств.
Name	string	Имя группы устройств.
OsFeedType	enum: 0 - Retail 1 - RetailEval	Тип osfeed, который используется этой группой устройств для обновлений ОС.
ProductId	string	Уникальный идентификатор продукта, к которому принадлежит эта группа устройств.
TenantId	string	Уникальный идентификатор клиента, которому принадлежит группа устройств.
UpdatePolicy	enum: 0 - UpdateAll 1 - No3rdPartyAppUpdates	Политика обновления, которая определяет, какое программное обеспечение обновляется.

DeviceGroupV2ItemCollectionResponse

Имя	Тип	Описание
ContinuationToken	string	Маркер продолжения, который можно использовать для получения следующего набора элементов.
Items	DeviceGroupV2[]	Список элементов.