catalogs_device_groups

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

Overview

Name	catalogs_device_groups
Type	Resource
Id	azure.sphere.catalogs_device_groups

Fields

The following fields are returned by SELECT queries:

list

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
list	select	subscriptionId, resourceGroupName, catalogName	$filter, $top, $skip, $maxpagesize	List the device groups for the catalog.

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
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

list

List the device groups for the catalog.

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