products

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

Overview

Name	products
Type	Resource
Id	azure_stack.azure_stack.products

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
billingPartNumber	string	The part number used for billing purposes.
compatibility	object	Product compatibility with current device.
description	string	The description of the product.
displayName	string	The display name of the product.
etag	string	The entity tag used for optimistic concurrency when modifying the resource.
galleryItemIdentity	string	The identifier of the gallery item corresponding to the product.
iconUris	object	Additional links available for this product.
legalTerms	string	The legal terms.
links	array	Additional links available for this product.
offer	string	The offer representing the product.
offerVersion	string	The version of the product offer.
payloadLength	integer	The length of product content.
privacyPolicy	string	The privacy policy.
productKind	string	The kind of the product (virtualMachine or virtualMachineExtension).
productProperties	object	Additional properties for the product.
publisherDisplayName	string	The user-friendly name of the product publisher.
publisherIdentifier	string	Publisher identifier.
sku	string	The product SKU.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Type of Resource.
vmExtensionType	string	The type of the Virtual Machine Extension.

list

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
billingPartNumber	string	The part number used for billing purposes.
compatibility	object	Product compatibility with current device.
description	string	The description of the product.
displayName	string	The display name of the product.
etag	string	The entity tag used for optimistic concurrency when modifying the resource.
galleryItemIdentity	string	The identifier of the gallery item corresponding to the product.
iconUris	object	Additional links available for this product.
legalTerms	string	The legal terms.
links	array	Additional links available for this product.
offer	string	The offer representing the product.
offerVersion	string	The version of the product offer.
payloadLength	integer	The length of product content.
privacyPolicy	string	The privacy policy.
productKind	string	The kind of the product (virtualMachine or virtualMachineExtension).
productProperties	object	Additional properties for the product.
publisherDisplayName	string	The user-friendly name of the product publisher.
publisherIdentifier	string	Publisher identifier.
sku	string	The product SKU.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Type of Resource.
vmExtensionType	string	The type of the Virtual Machine Extension.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group, registration_name, product_name, subscription_id		Returns the specified product.
list	select	resource_group, registration_name, subscription_id		Returns a list of products.
list_details	exec	resource_group, registration_name, product_name, subscription_id		Returns the extended properties of a product.
get_products	exec	resource_group, registration_name, product_name, subscription_id		Returns a list of products.
get_product	exec	resource_group, registration_name, product_name, subscription_id		Returns the specified product.
upload_log	exec	resource_group, registration_name, product_name, subscription_id		Returns the specified 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
product_name	string	Name of the product. Required.
registration_name	string	Name of the Azure Stack registration. Required.
resource_group	string	Name of the resource group. Required.
subscription_id	string

SELECT examples

get

Returns the specified product.

SELECT
id,
name,
billingPartNumber,
compatibility,
description,
displayName,
etag,
galleryItemIdentity,
iconUris,
legalTerms,
links,
offer,
offerVersion,
payloadLength,
privacyPolicy,
productKind,
productProperties,
publisherDisplayName,
publisherIdentifier,
sku,
systemData,
type,
vmExtensionType
FROM azure_stack.azure_stack.products
WHERE resource_group = '{{ resource_group }}' -- required
AND registration_name = '{{ registration_name }}' -- required
AND product_name = '{{ product_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a list of products.

SELECT
id,
name,
billingPartNumber,
compatibility,
description,
displayName,
etag,
galleryItemIdentity,
iconUris,
legalTerms,
links,
offer,
offerVersion,
payloadLength,
privacyPolicy,
productKind,
productProperties,
publisherDisplayName,
publisherIdentifier,
sku,
systemData,
type,
vmExtensionType
FROM azure_stack.azure_stack.products
WHERE resource_group = '{{ resource_group }}' -- required
AND registration_name = '{{ registration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

list_details

Returns the extended properties of a product.

EXEC azure_stack.azure_stack.products.list_details 
@resource_group='{{ resource_group }}' --required, 
@registration_name='{{ registration_name }}' --required, 
@product_name='{{ product_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_products

Returns a list of products.

EXEC azure_stack.azure_stack.products.get_products 
@resource_group='{{ resource_group }}' --required, 
@registration_name='{{ registration_name }}' --required, 
@product_name='{{ product_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"deviceVersion": "{{ deviceVersion }}", 
"identitySystem": "{{ identitySystem }}"
}'
;

get_product

Returns the specified product.

EXEC azure_stack.azure_stack.products.get_product 
@resource_group='{{ resource_group }}' --required, 
@registration_name='{{ registration_name }}' --required, 
@product_name='{{ product_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"deviceVersion": "{{ deviceVersion }}", 
"identitySystem": "{{ identitySystem }}"
}'
;

upload_log

Returns the specified product.

EXEC azure_stack.azure_stack.products.upload_log 
@resource_group='{{ resource_group }}' --required, 
@registration_name='{{ registration_name }}' --required, 
@product_name='{{ product_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"operation": "{{ operation }}", 
"status": "{{ status }}", 
"error": "{{ error }}", 
"details": "{{ details }}"
}'
;