gallery_images

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

Overview

Name	gallery_images
Type	Resource
Id	azure.compute.gallery_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.
allowUpdateImage	boolean	Optional. Must be set to true if the gallery image features are being updated.
architecture	string	The architecture of the image. Applicable to OS disks only. Known values are: "x64" and "Arm64". (x64, Arm64)
description	string	The description of this gallery image definition resource. This property is updatable.
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	The Eula agreement for the gallery image definition.
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	This is the gallery image definition identifier. Required.
location	string	The geo-location where the resource lives. Required.
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	The privacy statement uri.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating". (Creating, Updating, Failed, Succeeded, Deleting, Migrating)
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.
releaseNoteUri	string	The release note uri.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_gallery

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.
allowUpdateImage	boolean	Optional. Must be set to true if the gallery image features are being updated.
architecture	string	The architecture of the image. Applicable to OS disks only. Known values are: "x64" and "Arm64". (x64, Arm64)
description	string	The description of this gallery image definition resource. This property is updatable.
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	The Eula agreement for the gallery image definition.
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	This is the gallery image definition identifier. Required.
location	string	The geo-location where the resource lives. Required.
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	The privacy statement uri.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating". (Creating, Updating, Failed, Succeeded, Deleting, Migrating)
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.
releaseNoteUri	string	The release note uri.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, gallery_name, gallery_image_name, subscription_id		Retrieves information about a gallery image definition.
list_by_gallery	select	resource_group_name, gallery_name, subscription_id		List gallery image definitions in a gallery.
create_or_update	insert	resource_group_name, gallery_name, gallery_image_name, subscription_id, location		Create or update a gallery image definition.
update	update	resource_group_name, gallery_name, gallery_image_name, subscription_id		Update a gallery image definition.
create_or_update	replace	resource_group_name, gallery_name, gallery_image_name, subscription_id, location		Create or update a gallery image definition.
delete	delete	resource_group_name, gallery_name, gallery_image_name, subscription_id		Delete a gallery 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 gallery image definition to be retrieved. Required.
gallery_name	string	The name of the Shared Image Gallery. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieves information about a gallery image definition.

SELECT
id,
name,
allowUpdateImage,
architecture,
description,
disallowed,
endOfLifeDate,
eula,
features,
hyperVGeneration,
identifier,
location,
osState,
osType,
privacyStatementUri,
provisioningState,
purchasePlan,
recommended,
releaseNoteUri,
systemData,
tags,
type
FROM azure.compute.gallery_images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gallery_name = '{{ gallery_name }}' -- required
AND gallery_image_name = '{{ gallery_image_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_gallery

List gallery image definitions in a gallery.

SELECT
id,
name,
allowUpdateImage,
architecture,
description,
disallowed,
endOfLifeDate,
eula,
features,
hyperVGeneration,
identifier,
location,
osState,
osType,
privacyStatementUri,
provisioningState,
purchasePlan,
recommended,
releaseNoteUri,
systemData,
tags,
type
FROM azure.compute.gallery_images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gallery_name = '{{ gallery_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a gallery image definition.

INSERT INTO azure.compute.gallery_images (
tags,
location,
properties,
resource_group_name,
gallery_name,
gallery_image_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ gallery_name }}',
'{{ gallery_image_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: gallery_images
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gallery_images resource.
  - name: gallery_name
    value: "{{ gallery_name }}"
    description: Required parameter for the gallery_images resource.
  - name: gallery_image_name
    value: "{{ gallery_image_name }}"
    description: Required parameter for the gallery_images resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the gallery_images resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Describes the properties of a gallery image definition.
    value:
      description: "{{ description }}"
      eula: "{{ eula }}"
      privacyStatementUri: "{{ privacyStatementUri }}"
      releaseNoteUri: "{{ releaseNoteUri }}"
      osType: "{{ osType }}"
      osState: "{{ osState }}"
      hyperVGeneration: "{{ hyperVGeneration }}"
      endOfLifeDate: "{{ endOfLifeDate }}"
      identifier:
        publisher: "{{ publisher }}"
        offer: "{{ offer }}"
        sku: "{{ sku }}"
      recommended:
        vCPUs:
          min: {{ min }}
          max: {{ max }}
        memory:
          min: {{ min }}
          max: {{ max }}
      disallowed:
        diskTypes:
          - "{{ diskTypes }}"
      purchasePlan:
        name: "{{ name }}"
        publisher: "{{ publisher }}"
        product: "{{ product }}"
      provisioningState: "{{ provisioningState }}"
      features:
        - name: "{{ name }}"
          value: "{{ value }}"
          startsAtVersion: "{{ startsAtVersion }}"
      architecture: "{{ architecture }}"
      allowUpdateImage: {{ allowUpdateImage }}

UPDATE examples

update

Update a gallery image definition.

UPDATE azure.compute.gallery_images
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND gallery_image_name = '{{ gallery_image_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a gallery image definition.

REPLACE azure.compute.gallery_images
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND gallery_image_name = '{{ gallery_image_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a gallery image.

DELETE FROM azure.compute.gallery_images
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND gallery_image_name = '{{ gallery_image_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;