products

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

Overview

Name	products
Type	Resource
Id	azure_extras.sphere.products

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.
description	string	Description of the product.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
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".

list_by_catalog

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.
description	string	Description of the product.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
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".

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, subscription_id		Get a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
list_by_catalog	select	resource_group_name, catalog_name, subscription_id		List Product resources by Catalog.
create_or_update	insert	resource_group_name, catalog_name, product_name, subscription_id		Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
update	update	resource_group_name, catalog_name, product_name, subscription_id		Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
create_or_update	replace	resource_group_name, catalog_name, product_name, subscription_id		Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
delete	delete	resource_group_name, catalog_name, product_name, subscription_id		Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name'.
count_devices	exec	resource_group_name, catalog_name, product_name, subscription_id		Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
generate_default_device_groups	exec	resource_group_name, catalog_name, product_name, subscription_id		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
catalog_name	string	Name of catalog. 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

SELECT examples

get

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

SELECT
id,
name,
description,
provisioningState,
systemData,
type
FROM azure_extras.sphere.products
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
;

list_by_catalog

List Product resources by Catalog.

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

Manifest

# Description fields are for documentation purposes
- name: products
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the products resource.
  - name: catalog_name
    value: "{{ catalog_name }}"
    description: Required parameter for the products resource.
  - name: product_name
    value: "{{ product_name }}"
    description: Required parameter for the products resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the products resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      description: "{{ description }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

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

UPDATE azure_extras.sphere.products
SET 
properties = '{{ properties }}'
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
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

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

REPLACE azure_extras.sphere.products
SET 
properties = '{{ properties }}'
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
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

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

DELETE FROM azure_extras.sphere.products
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
;

Lifecycle Methods

count_devices

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

EXEC azure_extras.sphere.products.count_devices 
@resource_group_name='{{ resource_group_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@product_name='{{ product_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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_extras.sphere.products.generate_default_device_groups 
@resource_group_name='{{ resource_group_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@product_name='{{ product_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;