devices

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

Overview

Name	devices
Type	Resource
Id	azure.sphere.devices

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_device_group

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, deviceName		Get a Device. Use '.unassigned' or '.default' for the device group and product names when a device does not belong to a device group and product.
list_by_device_group	select	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName		List Device resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
create_or_update	insert	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName, deviceName		Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only.
update	update	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName, deviceName		Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level.
delete	delete	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName, deviceName		Delete a Device
generate_capability_image	exec	subscriptionId, resourceGroupName, catalogName, productName, deviceGroupName, deviceName, capabilities		Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.

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.
deviceName	string	Device name
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.

SELECT examples

get

Get a Device. Use '.unassigned' or '.default' for the device group and product names when a device does not belong to a device group and product.

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

list_by_device_group

List Device resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

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

INSERT examples

create_or_update

Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only.

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

Manifest

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

UPDATE examples

update

Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level.

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

DELETE examples

delete

Delete a Device

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

Lifecycle Methods

generate_capability_image

Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.

EXEC azure.sphere.devices.generate_capability_image 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@catalogName='{{ catalogName }}' --required, 
@productName='{{ productName }}' --required, 
@deviceGroupName='{{ deviceGroupName }}' --required, 
@deviceName='{{ deviceName }}' --required 
@@json=
'{
"capabilities": "{{ capabilities }}"
}'
;