shared_gallery_image_versions

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

Overview

Name	shared_gallery_image_versions
Type	Resource
Id	azure.compute.shared_gallery_image_versions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Resource name.
artifactTags	object	The artifact tags of a shared gallery resource.
endOfLifeDate	string (date-time)	The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
excludeFromLatest	boolean	If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.
identifier	object	The identifier information of shared gallery.
location	string	Resource location.
publishedDate	string (date-time)	The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
storageProfile	object	Describes the storage profile of the image version.

list

Name	Datatype	Description
name	string	Resource name.
artifactTags	object	The artifact tags of a shared gallery resource.
endOfLifeDate	string (date-time)	The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
excludeFromLatest	boolean	If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.
identifier	object	The identifier information of shared gallery.
location	string	Resource location.
publishedDate	string (date-time)	The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable.
storageProfile	object	Describes the storage profile of the image version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, gallery_unique_name, gallery_image_name, gallery_image_version_name, subscription_id		Get a shared gallery image version by subscription id or tenant id.
list	select	location, gallery_unique_name, gallery_image_name, subscription_id	sharedTo	List shared gallery image versions by subscription id or tenant id.

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
gallery_image_name	string	The name of the Shared Gallery Image Definition from which the Image Versions are to be listed. Required.
gallery_image_version_name	string	The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: ... Required.
gallery_unique_name	string	The unique name of the Shared Gallery. Required.
location	string	The name of the Azure region. Required.
subscription_id	string
sharedTo	string	The query parameter to decide what shared galleries to fetch when doing listing operations. "tenant" Default value is None.

SELECT examples

get

Get a shared gallery image version by subscription id or tenant id.

SELECT
name,
artifactTags,
endOfLifeDate,
excludeFromLatest,
identifier,
location,
publishedDate,
storageProfile
FROM azure.compute.shared_gallery_image_versions
WHERE location = '{{ location }}' -- required
AND gallery_unique_name = '{{ gallery_unique_name }}' -- required
AND gallery_image_name = '{{ gallery_image_name }}' -- required
AND gallery_image_version_name = '{{ gallery_image_version_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List shared gallery image versions by subscription id or tenant id.

SELECT
name,
artifactTags,
endOfLifeDate,
excludeFromLatest,
identifier,
location,
publishedDate,
storageProfile
FROM azure.compute.shared_gallery_image_versions
WHERE location = '{{ location }}' -- required
AND gallery_unique_name = '{{ gallery_unique_name }}' -- required
AND gallery_image_name = '{{ gallery_image_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND sharedTo = '{{ sharedTo }}'
;