device_groups

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

Overview

Name	device_groups
Type	Resource
Id	azure_extras.sphere.device_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
allowCrashDumpsCollection	string	Flag to define if the user allows for crash dump collection. Known values are: "Enabled" and "Disabled".
description	string	Description of the device group.
hasDeployment	boolean	Deployment status for the device group.
osFeedType	string	Operating system feed type of the device group. Known values are: "Retail" and "RetailEval".
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
regionalDataBoundary	string	Regional data boundary for the device group. Known values are: "None" and "EU".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updatePolicy	string	Update policy of the device group. Known values are: "UpdateAll" and "No3rdPartyAppUpdates".

list_by_product

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
allowCrashDumpsCollection	string	Flag to define if the user allows for crash dump collection. Known values are: "Enabled" and "Disabled".
description	string	Description of the device group.
hasDeployment	boolean	Deployment status for the device group.
osFeedType	string	Operating system feed type of the device group. Known values are: "Retail" and "RetailEval".
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
regionalDataBoundary	string	Regional data boundary for the device group. Known values are: "None" and "EU".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updatePolicy	string	Update policy of the device group. Known values are: "UpdateAll" and "No3rdPartyAppUpdates".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, catalog_name, product_name, device_group_name, subscription_id		Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
list_by_product	select	resource_group_name, catalog_name, product_name, subscription_id	$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	resource_group_name, catalog_name, product_name, device_group_name, subscription_id		Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
update	update	resource_group_name, catalog_name, product_name, device_group_name, subscription_id		Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
create_or_update	replace	resource_group_name, catalog_name, product_name, device_group_name, subscription_id		Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
delete	delete	resource_group_name, catalog_name, product_name, device_group_name, subscription_id		Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
claim_devices	exec	resource_group_name, catalog_name, product_name, device_group_name, subscription_id, 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	resource_group_name, catalog_name, product_name, device_group_name, subscription_id		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
catalog_name	string	Name of catalog. Required.
device_group_name	string	Name of device group. Required.
product_name	string	Name of product. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	Filter the result list using the given expression. Default value is None.
$maxpagesize	integer	The maximum number of result items per page. Default value is None.
$skip	integer	The number of result items to skip. Default value is None.
$top	integer	The number of result items to return. Default value is None.

SELECT examples

get

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

SELECT
id,
name,
allowCrashDumpsCollection,
description,
hasDeployment,
osFeedType,
provisioningState,
regionalDataBoundary,
systemData,
type,
updatePolicy
FROM azure_extras.sphere.device_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND product_name = '{{ product_name }}' -- required
AND device_group_name = '{{ device_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_product

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

SELECT
id,
name,
allowCrashDumpsCollection,
description,
hasDeployment,
osFeedType,
provisioningState,
regionalDataBoundary,
systemData,
type,
updatePolicy
FROM azure_extras.sphere.device_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND product_name = '{{ product_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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_extras.sphere.device_groups (
properties,
resource_group_name,
catalog_name,
product_name,
device_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ catalog_name }}',
'{{ product_name }}',
'{{ device_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: device_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the device_groups resource.
  - name: catalog_name
    value: "{{ catalog_name }}"
    description: Required parameter for the device_groups resource.
  - name: product_name
    value: "{{ product_name }}"
    description: Required parameter for the device_groups resource.
  - name: device_group_name
    value: "{{ device_group_name }}"
    description: Required parameter for the device_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the device_groups resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      description: "{{ description }}"
      osFeedType: "{{ osFeedType }}"
      updatePolicy: "{{ updatePolicy }}"
      allowCrashDumpsCollection: "{{ allowCrashDumpsCollection }}"
      regionalDataBoundary: "{{ regionalDataBoundary }}"
      hasDeployment: {{ hasDeployment }}
      provisioningState: "{{ provisioningState }}"

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_extras.sphere.device_groups
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND product_name = '{{ product_name }}' --required
AND device_group_name = '{{ device_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

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

REPLACE azure_extras.sphere.device_groups
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND product_name = '{{ product_name }}' --required
AND device_group_name = '{{ device_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

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_extras.sphere.device_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND catalog_name = '{{ catalog_name }}' --required
AND product_name = '{{ product_name }}' --required
AND device_group_name = '{{ device_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --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_extras.sphere.device_groups.claim_devices 
@resource_group_name='{{ resource_group_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@product_name='{{ product_name }}' --required, 
@device_group_name='{{ device_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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_extras.sphere.device_groups.count_devices 
@resource_group_name='{{ resource_group_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@product_name='{{ product_name }}' --required, 
@device_group_name='{{ device_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;