os_images

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

Overview

Name	os_images
Type	Resource
Id	azure_stack.azure_stack_hci.os_images

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.
composedImageIsoHash	string	Represents composed image iso hash of a os image.
composedImageIsoUrl	string	Represents composed image iso download url of a os image.
composedImageVersion	string	Represents composed image version of a os image.
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".
validatedSolutionRecipeVersion	string	Represents validated solution recipe version of a os image.

list_by_subscription_location_resource

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.
composedImageIsoHash	string	Represents composed image iso hash of a os image.
composedImageIsoUrl	string	Represents composed image iso download url of a os image.
composedImageVersion	string	Represents composed image version of a os image.
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".
validatedSolutionRecipeVersion	string	Represents validated solution recipe version of a os image.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, os_image_name, subscription_id		Get a os image.
list_by_subscription_location_resource	select	location, subscription_id		List all os images.

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
location	string	The name of the Azure region. Required.
os_image_name	string	The name of the OsImage. Required.
subscription_id	string

SELECT examples

get

Get a os image.

SELECT
id,
name,
composedImageIsoHash,
composedImageIsoUrl,
composedImageVersion,
systemData,
type,
validatedSolutionRecipeVersion
FROM azure_stack.azure_stack_hci.os_images
WHERE location = '{{ location }}' -- required
AND os_image_name = '{{ os_image_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription_location_resource

List all os images.

SELECT
id,
name,
composedImageIsoHash,
composedImageIsoUrl,
composedImageVersion,
systemData,
type,
validatedSolutionRecipeVersion
FROM azure_stack.azure_stack_hci.os_images
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;