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


Catalogs - List Device Groups

Выведите список групп устройств для каталога.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceGroups?api-version=2024-04-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceGroups?api-version=2024-04-01&$filter={$filter}&$top={$top}&$skip={$skip}&$maxpagesize={$maxpagesize}

Параметры URI

Имя В Обязательно Тип Описание
catalogName
path True

string

Имя каталога

Шаблон регулярного выражения: ^[A-Za-z0-9_-]{1,50}$

resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

Версия API, используемая для данной операции.

$filter
query

string

Фильтрация списка результатов с помощью заданного выражения

$maxpagesize
query

integer

int32

Максимальное количество элементов результатов на странице.

$skip
query

integer

int32

Количество элементов результатов, которые нужно пропустить.

$top
query

integer

int32

Количество возвращаемых элементов результатов.

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

Имя Тип Описание
deviceGroupName

string

Имя группы устройств.

Ответы

Имя Тип Описание
200 OK

DeviceGroupListResult

Операция Azure успешно завершена.

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Catalogs_ListDeviceGroups

Образец запроса

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/listDeviceGroups?api-version=2024-04-01

{
  "deviceGroupName": "MyDeviceGroup1"
}

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

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1",
      "name": "MyDeviceGroup1",
      "type": "microsoft.azureSphere/catalogs/products/devicegroups"
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct2/devicegroups/MyDeviceGroup2",
      "name": "MyDeviceGroup2",
      "type": "microsoft.azureSphere/catalogs/products/devicegroups"
    }
  ]
}

Определения

Имя Описание
AllowCrashDumpCollection

Разрешить значения аварийных дампов.

createdByType

Тип удостоверения, создавшего ресурс.

DeviceGroup

Ресурс группы устройств, принадлежащий ресурсу продукта.

DeviceGroupListResult

Ответ операции со списком DeviceGroup.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Сообщение об ошибке

ListDeviceGroupsRequest

Запрос действия для вывода списка групп устройств для каталога.

OSFeedType

Значения типов веб-канала ОС.

ProvisioningState

Состояние подготовки ресурса.

RegionalDataBoundary

Значения границ региональных данных.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

UpdatePolicy

Обновление значений политики.

AllowCrashDumpCollection

Разрешить значения аварийных дампов.

Имя Тип Описание
Disabled

string

Сбор аварийных дампов отключен

Enabled

string

Сбор аварийных дампов включен

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

DeviceGroup

Ресурс группы устройств, принадлежащий ресурсу продукта.

Имя Тип Описание
id

string

Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Имя ресурса.

properties.allowCrashDumpsCollection

AllowCrashDumpCollection

Флаг, определяющий, разрешает ли пользователь сбор аварийных дампов.

properties.description

string

Описание группы устройств.

properties.hasDeployment

boolean

Состояние развертывания для группы устройств.

properties.osFeedType

OSFeedType

Тип веб-канала операционной системы для группы устройств.

properties.provisioningState

ProvisioningState

Состояние последней операции.

properties.regionalDataBoundary

RegionalDataBoundary

Граница региональных данных для группы устройств.

properties.updatePolicy

UpdatePolicy

Политика обновления группы устройств.

systemData

systemData

Метаданные Azure Resource Manager, содержащие сведения createdBy и modifiedBy.

type

string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

DeviceGroupListResult

Ответ операции со списком DeviceGroup.

Имя Тип Описание
nextLink

string

Ссылка на следующую страницу элементов

value

DeviceGroup[]

Элементы DeviceGroup на этой странице

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект error.

ListDeviceGroupsRequest

Запрос действия для вывода списка групп устройств для каталога.

Имя Тип Описание
deviceGroupName

string

Имя группы устройств.

OSFeedType

Значения типов веб-канала ОС.

Имя Тип Описание
Retail

string

Тип веб-канала ОС для розничной торговли.

RetailEval

string

Тип веб-канала ОС для оценки розничной торговли.

ProvisioningState

Состояние подготовки ресурса.

Имя Тип Описание
Accepted

string

Запрос на создание ресурса принят

Canceled

string

Создание ресурса было отменено.

Deleting

string

Ресурс удаляется

Failed

string

Не удалось создать ресурс.

Provisioning

string

Ресурс подготавливается

Succeeded

string

Ресурс создан.

Updating

string

Ресурс обновляется

RegionalDataBoundary

Значения границ региональных данных.

Имя Тип Описание
EU

string

Граница данных ЕС

None

string

Нет границы данных

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Удостоверение, которое последним изменял ресурс.

lastModifiedByType

createdByType

Тип удостоверения, которое последним изменял ресурс.

UpdatePolicy

Обновление значений политики.

Имя Тип Описание
No3rdPartyAppUpdates

string

Нет обновлений для политики сторонних приложений.

UpdateAll

string

Обновите всю политику.