community_gallery_image_versions

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

Overview

Name	community_gallery_image_versions
Type	Resource
Id	azure.compute.community_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 community gallery resource.
disclaimer	string	The disclaimer for a community 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 community 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.
type	string	Resource type.

list

Name	Datatype	Description
name	string	Resource name.
artifactTags	object	The artifact tags of a community gallery resource.
disclaimer	string	The disclaimer for a community 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 community 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.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, public_gallery_name, gallery_image_name, gallery_image_version_name, subscription_id		Get a community gallery image version.
list	select	location, public_gallery_name, gallery_image_name, subscription_id		List community gallery image versions inside an 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
gallery_image_name	string	The name of the community gallery image definition. Required.
gallery_image_version_name	string	The name of the community gallery image version. 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.
location	string	The name of the Azure region. Required.
public_gallery_name	string	The public name of the community gallery. Required.
subscription_id	string

SELECT examples

get

Get a community gallery image version.

SELECT
name,
artifactTags,
disclaimer,
endOfLifeDate,
excludeFromLatest,
identifier,
location,
publishedDate,
storageProfile,
type
FROM azure.compute.community_gallery_image_versions
WHERE location = '{{ location }}' -- required
AND public_gallery_name = '{{ public_gallery_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 community gallery image versions inside an image.

SELECT
name,
artifactTags,
disclaimer,
endOfLifeDate,
excludeFromLatest,
identifier,
location,
publishedDate,
storageProfile,
type
FROM azure.compute.community_gallery_image_versions
WHERE location = '{{ location }}' -- required
AND public_gallery_name = '{{ public_gallery_name }}' -- required
AND gallery_image_name = '{{ gallery_image_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;