device_groups

Overview

Name	device_groups
Type	Resource
Id	azure.sphere.device_groups

Fields

Methods

Name	Accessible by	Required Params	Description
get	SELECT	catalogName, deviceGroupName, productName, resourceGroupName, subscriptionId	Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
list_by_product	SELECT	catalogName, productName, resourceGroupName, subscriptionId	List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
create_or_update	INSERT	catalogName, deviceGroupName, productName, resourceGroupName, subscriptionId	Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
delete	DELETE	catalogName, deviceGroupName, productName, resourceGroupName, subscriptionId	Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
_list_by_product	EXEC	catalogName, productName, resourceGroupName, subscriptionId	List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
claim_devices	EXEC	catalogName, deviceGroupName, productName, resourceGroupName, subscriptionId, data__deviceIdentifiers	Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.
count_devices	EXEC	catalogName, deviceGroupName, productName, resourceGroupName, subscriptionId	Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
update	EXEC	catalogName, deviceGroupName, productName, resourceGroupName, subscriptionId	Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.