shared_gallery_images

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

Overview

Name	shared_gallery_images
Type	Resource
Id	azure.compute.shared_gallery_images

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Resource name.
architecture	string	The architecture of the image. Applicable to OS disks only. Known values are: "x64" and "Arm64". (x64, Arm64)
artifactTags	object	The artifact tags of a shared gallery resource.
disallowed	object	Describes the disallowed disk types.
endOfLifeDate	string (date-time)	The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
eula	string	End-user license agreement for the current community gallery image.
features	array	A list of gallery image features.
hyperVGeneration	string	The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: "V1" and "V2". (V1, V2)
identifier	object	The identifier information of shared gallery.
location	string	Resource location.
osState	string	This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. Required. Known values are: "Generalized" and "Specialized". (Generalized, Specialized)
osType	string	This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.. Required. Known values are: "Windows" and "Linux". (Windows, Linux)
privacyStatementUri	string	Privacy statement uri for the current community gallery image.
purchasePlan	object	Describes the gallery image definition purchase plan. This is used by marketplace images.
recommended	object	The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.

list

Name	Datatype	Description
name	string	Resource name.
architecture	string	The architecture of the image. Applicable to OS disks only. Known values are: "x64" and "Arm64". (x64, Arm64)
artifactTags	object	The artifact tags of a shared gallery resource.
disallowed	object	Describes the disallowed disk types.
endOfLifeDate	string (date-time)	The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable.
eula	string	End-user license agreement for the current community gallery image.
features	array	A list of gallery image features.
hyperVGeneration	string	The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: "V1" and "V2". (V1, V2)
identifier	object	The identifier information of shared gallery.
location	string	Resource location.
osState	string	This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. Required. Known values are: "Generalized" and "Specialized". (Generalized, Specialized)
osType	string	This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: Windows, Linux.. Required. Known values are: "Windows" and "Linux". (Windows, Linux)
privacyStatementUri	string	Privacy statement uri for the current community gallery image.
purchasePlan	object	Describes the gallery image definition purchase plan. This is used by marketplace images.
recommended	object	The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.

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, subscription_id		Get a shared gallery image by subscription id or tenant id.
list	select	location, gallery_unique_name, subscription_id	sharedTo	List shared gallery images 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_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 by subscription id or tenant id.

SELECT
name,
architecture,
artifactTags,
disallowed,
endOfLifeDate,
eula,
features,
hyperVGeneration,
identifier,
location,
osState,
osType,
privacyStatementUri,
purchasePlan,
recommended
FROM azure.compute.shared_gallery_images
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
;

list

List shared gallery images by subscription id or tenant id.

SELECT
name,
architecture,
artifactTags,
disallowed,
endOfLifeDate,
eula,
features,
hyperVGeneration,
identifier,
location,
osState,
osType,
privacyStatementUri,
purchasePlan,
recommended
FROM azure.compute.shared_gallery_images
WHERE location = '{{ location }}' -- required
AND gallery_unique_name = '{{ gallery_unique_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND sharedTo = '{{ sharedTo }}'
;