device_groups

Creates, updates, deletes, gets or lists a device_groups resource.

Overview

Name	device_groups
Type	Resource
Id	azure.sphere.device_groups

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list_by_product

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName		Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
list_by_product	select	subscriptionId, resourceGroupName, catalogName, productName	$filter, $top, $skip, $maxpagesize	List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
create_or_update	insert	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName		Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
update	update	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName		Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
delete	delete	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName		Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
claim_devices	exec	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName, 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	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName		Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
catalogName	string	Name of catalog
deviceGroupName	string	Name of device group.
productName	string	Name of product.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$filter	string	Filter the result list using the given expression
$maxpagesize	integer (int32)	The maximum number of result items per page.
$skip	integer (int32)	The number of result items to skip.
$top	integer (int32)	The number of result items to return.

SELECT examples

get

Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

SELECT
properties
FROM azure.sphere.device_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND catalogName = '{{ catalogName }}' -- required
AND productName = '{{ productName }}' -- required
AND deviceGroupName = '{{ deviceGroupName }}' -- required
;

list_by_product

List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.

SELECT
properties
FROM azure.sphere.device_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND catalogName = '{{ catalogName }}' -- required
AND productName = '{{ productName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND $maxpagesize = '{{ $maxpagesize }}'
;

INSERT examples

create_or_update

Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

INSERT INTO azure.sphere.device_groups (
data__properties,
subscriptionId,
resourceGroupName,
catalogName,
productName,
deviceGroupName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ catalogName }}',
'{{ productName }}',
'{{ deviceGroupName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: device_groups
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the device_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the device_groups resource.
    - name: catalogName
      value: string
      description: Required parameter for the device_groups resource.
    - name: productName
      value: string
      description: Required parameter for the device_groups resource.
    - name: deviceGroupName
      value: string
      description: Required parameter for the device_groups resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.

UPDATE examples

update

Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

UPDATE azure.sphere.device_groups
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND catalogName = '{{ catalogName }}' --required
AND productName = '{{ productName }}' --required
AND deviceGroupName = '{{ deviceGroupName }}' --required
RETURNING
properties;

DELETE examples

delete

Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

DELETE FROM azure.sphere.device_groups
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND catalogName = '{{ catalogName }}' --required
AND productName = '{{ productName }}' --required
AND deviceGroupName = '{{ deviceGroupName }}' --required
;

Lifecycle Methods

claim_devices

Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.

EXEC azure.sphere.device_groups.claim_devices 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@catalogName='{{ catalogName }}' --required, 
@productName='{{ productName }}' --required, 
@deviceGroupName='{{ deviceGroupName }}' --required 
@@json=
'{
"deviceIdentifiers": "{{ deviceIdentifiers }}"
}'
;

count_devices

Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

EXEC azure.sphere.device_groups.count_devices 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@catalogName='{{ catalogName }}' --required, 
@productName='{{ productName }}' --required, 
@deviceGroupName='{{ deviceGroupName }}' --required
;