images

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

Overview

Name	images
Type	Resource
Id	azure_stack.disconnected_operations.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.
compatibleVersions	array	The versions that are compatible for this update package.
provisioningState	string	The resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
releaseDate	string (date)	The release date. Required.
releaseDisplayName	string	The release name. Required.
releaseNotes	string	The release notes. Required.
releaseType	string	The release type. Required. Known values are: "Install" and "Update". (Install, Update)
releaseVersion	string	The version of the package in the format 1.1.1. Required.
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".
updateProperties	object	Image update properties for update release type image.

list_by_disconnected_operation

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.
compatibleVersions	array	The versions that are compatible for this update package.
provisioningState	string	The resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
releaseDate	string (date)	The release date. Required.
releaseDisplayName	string	The release name. Required.
releaseNotes	string	The release notes. Required.
releaseType	string	The release type. Required. Known values are: "Install" and "Update". (Install, Update)
releaseVersion	string	The version of the package in the format 1.1.1. Required.
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".
updateProperties	object	Image update properties for update release type image.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, name, image_name, subscription_id		Get the resource.
list_by_disconnected_operation	select	resource_group_name, name, subscription_id	$filter, $top, $skip	List by disconnected operation.
list_download_uri	exec	resource_group_name, name, image_name, subscription_id		Get the URI to download the image.

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
image_name	string	The name of the Image. Required.
name	string	Name of the resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	Filter the result list using the given expression. Default value is None.
$skip	integer	The number of result items to skip. Default value is None.
$top	integer	The number of result items to return. Default value is None.

SELECT examples

get

Get the resource.

SELECT
id,
name,
compatibleVersions,
provisioningState,
releaseDate,
releaseDisplayName,
releaseNotes,
releaseType,
releaseVersion,
systemData,
type,
updateProperties
FROM azure_stack.disconnected_operations.images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND image_name = '{{ image_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_disconnected_operation

List by disconnected operation.

SELECT
id,
name,
compatibleVersions,
provisioningState,
releaseDate,
releaseDisplayName,
releaseNotes,
releaseType,
releaseVersion,
systemData,
type,
updateProperties
FROM azure_stack.disconnected_operations.images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

Lifecycle Methods

list_download_uri

Get the URI to download the image.

EXEC azure_stack.disconnected_operations.images.list_download_uri 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@image_name='{{ image_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;