products

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

Overview

Name	products
Type	Resource
Id	azure.sphere.products

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_catalog

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		Get a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
list_by_catalog	select	subscriptionId, resourceGroupName, catalogName		List Product resources by Catalog
create_or_update	insert	subscriptionId, resourceGroupName, catalogName, productName		Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
update	update	subscriptionId, resourceGroupName, catalogName, productName		Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
delete	delete	subscriptionId, resourceGroupName, catalogName, productName		Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name'
count_devices	exec	subscriptionId, resourceGroupName, catalogName, productName		Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
generate_default_device_groups	exec	subscriptionId, resourceGroupName, catalogName, productName		Generates default device groups for the product. '.default' and '.unassigned' are system defined values and cannot be used for product 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
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 Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.

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

list_by_catalog

List Product resources by Catalog

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

INSERT examples

create_or_update

Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.

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

Manifest

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

UPDATE examples

update

Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.

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

DELETE examples

delete

Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name'

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

Lifecycle Methods

count_devices

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

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

generate_default_device_groups

Generates default device groups for the product. '.default' and '.unassigned' are system defined values and cannot be used for product name.

EXEC azure.sphere.products.generate_default_device_groups 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@catalogName='{{ catalogName }}' --required, 
@productName='{{ productName }}' --required
;