offers

Creates, updates, deletes, gets or lists an offers resource.

Overview

Name	offers
Type	Resource
Id	azure_stack.azure_stack_hci.offers

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}.
name	string	The name of the resource.
content	string	JSON serialized catalog content of the offer.
contentVersion	string	The API version of the catalog service used to serve the catalog content.
provisioningState	string	Provisioning State.
publisherId	string	Identifier of the Publisher for the offer.
skuMappings	array	Array of SKU mappings.
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_publisher

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
content	string	JSON serialized catalog content of the offer.
contentVersion	string	The API version of the catalog service used to serve the catalog content.
provisioningState	string	Provisioning State.
publisherId	string	Identifier of the Publisher for the offer.
skuMappings	array	Array of SKU mappings.
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_cluster

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
content	string	JSON serialized catalog content of the offer.
contentVersion	string	The API version of the catalog service used to serve the catalog content.
provisioningState	string	Provisioning State.
publisherId	string	Identifier of the Publisher for the offer.
skuMappings	array	Array of SKU mappings.
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, cluster_name, publisher_name, offer_name, subscription_id	$expand	Get Offer resource details within a publisher of HCI Cluster.
list_by_publisher	select	resource_group_name, cluster_name, publisher_name, subscription_id	$expand	List Offers available for a publisher within the HCI Cluster.
list_by_cluster	select	resource_group_name, cluster_name, subscription_id	$expand	List Offers available across publishers for the HCI Cluster.

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
cluster_name	string	The name of the cluster. Required.
offer_name	string	The name of the offer available within HCI cluster. Required.
publisher_name	string	The name of the publisher available within HCI cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$expand	string	Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. Default value is None.

SELECT examples

get

Get Offer resource details within a publisher of HCI Cluster.

SELECT
id,
name,
content,
contentVersion,
provisioningState,
publisherId,
skuMappings,
systemData,
type
FROM azure_stack.azure_stack_hci.offers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND offer_name = '{{ offer_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_publisher

List Offers available for a publisher within the HCI Cluster.

SELECT
id,
name,
content,
contentVersion,
provisioningState,
publisherId,
skuMappings,
systemData,
type
FROM azure_stack.azure_stack_hci.offers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_cluster

List Offers available across publishers for the HCI Cluster.

SELECT
id,
name,
content,
contentVersion,
provisioningState,
publisherId,
skuMappings,
systemData,
type
FROM azure_stack.azure_stack_hci.offers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;