gallery_image_versions

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

Overview

Name	gallery_image_versions
Type	Resource
Id	azure.compute.gallery_image_versions

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.
location	string	The geo-location where the resource lives. Required.
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)
publishingProfile	object	The publishing profile of a gallery image Version.
replicationStatus	object	This is the replication status of the gallery image version.
restore	boolean	Indicates if this is a soft-delete resource restoration request.
safetyProfile	object	This is the safety profile of the Gallery Image Version.
securityProfile	object	The security profile of a gallery image version.
storageProfile	object	This is the storage profile of a Gallery Image Version. Required.
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".
validationsProfile	object	This is the validations profile of a Gallery Image Version.

list_by_gallery_image

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.
location	string	The geo-location where the resource lives. Required.
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)
publishingProfile	object	The publishing profile of a gallery image Version.
replicationStatus	object	This is the replication status of the gallery image version.
restore	boolean	Indicates if this is a soft-delete resource restoration request.
safetyProfile	object	This is the safety profile of the Gallery Image Version.
securityProfile	object	The security profile of a gallery image version.
storageProfile	object	This is the storage profile of a Gallery Image Version. Required.
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".
validationsProfile	object	This is the validations profile of a Gallery Image Version.

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, gallery_image_version_name, subscription_id	$expand	Retrieves information about a gallery image version.
list_by_gallery_image	select	resource_group_name, gallery_name, gallery_image_name, subscription_id		List gallery image versions in a gallery image definition.
create_or_update	insert	resource_group_name, gallery_name, gallery_image_name, gallery_image_version_name, subscription_id, location		Create or update a gallery image version.
update	update	resource_group_name, gallery_name, gallery_image_name, gallery_image_version_name, subscription_id		Update a gallery image version.
create_or_update	replace	resource_group_name, gallery_name, gallery_image_name, gallery_image_version_name, subscription_id, location		Create or update a gallery image version.
delete	delete	resource_group_name, gallery_name, gallery_image_name, gallery_image_version_name, subscription_id		Delete a gallery image version.

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_image_version_name	string	The name of the gallery image version 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
$expand	string	The expand expression to apply on the operation. Known values are: "ReplicationStatus" and "UefiSettings". Default value is None.

SELECT examples

get

Retrieves information about a gallery image version.

SELECT
id,
name,
location,
provisioningState,
publishingProfile,
replicationStatus,
restore,
safetyProfile,
securityProfile,
storageProfile,
systemData,
tags,
type,
validationsProfile
FROM azure.compute.gallery_image_versions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gallery_name = '{{ 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
AND $expand = '{{ $expand }}'
;

list_by_gallery_image

List gallery image versions in a gallery image definition.

SELECT
id,
name,
location,
provisioningState,
publishingProfile,
replicationStatus,
restore,
safetyProfile,
securityProfile,
storageProfile,
systemData,
tags,
type,
validationsProfile
FROM azure.compute.gallery_image_versions
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
;

INSERT examples

create_or_update

Create or update a gallery image version.

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

Manifest

# Description fields are for documentation purposes
- name: gallery_image_versions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gallery_image_versions resource.
  - name: gallery_name
    value: "{{ gallery_name }}"
    description: Required parameter for the gallery_image_versions resource.
  - name: gallery_image_name
    value: "{{ gallery_image_name }}"
    description: Required parameter for the gallery_image_versions resource.
  - name: gallery_image_version_name
    value: "{{ gallery_image_version_name }}"
    description: Required parameter for the gallery_image_versions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the gallery_image_versions 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 version.
    value:
      publishingProfile:
        targetRegions:
          - name: "{{ name }}"
            regionalReplicaCount: {{ regionalReplicaCount }}
            storageAccountType: "{{ storageAccountType }}"
            encryption:
              osDiskImage:
                diskEncryptionSetId: "{{ diskEncryptionSetId }}"
                securityProfile: "{{ securityProfile }}"
              dataDiskImages:
                - diskEncryptionSetId: "{{ diskEncryptionSetId }}"
                  lun: {{ lun }}
            excludeFromLatest: {{ excludeFromLatest }}
            additionalReplicaSets: "{{ additionalReplicaSets }}"
        replicaCount: {{ replicaCount }}
        excludeFromLatest: {{ excludeFromLatest }}
        publishedDate: "{{ publishedDate }}"
        endOfLifeDate: "{{ endOfLifeDate }}"
        storageAccountType: "{{ storageAccountType }}"
        replicationMode: "{{ replicationMode }}"
        targetExtendedLocations:
          - name: "{{ name }}"
            extendedLocation:
              name: "{{ name }}"
              type: "{{ type }}"
            extendedLocationReplicaCount: {{ extendedLocationReplicaCount }}
            storageAccountType: "{{ storageAccountType }}"
            encryption:
              osDiskImage:
                diskEncryptionSetId: "{{ diskEncryptionSetId }}"
                securityProfile: "{{ securityProfile }}"
              dataDiskImages:
                - diskEncryptionSetId: "{{ diskEncryptionSetId }}"
                  lun: {{ lun }}
        storageAccountStrategy: "{{ storageAccountStrategy }}"
      provisioningState: "{{ provisioningState }}"
      storageProfile:
        source:
          id: "{{ id }}"
          communityGalleryImageId: "{{ communityGalleryImageId }}"
          virtualMachineId: "{{ virtualMachineId }}"
        osDiskImage:
          sizeInGB: {{ sizeInGB }}
          hostCaching: "{{ hostCaching }}"
          source:
            id: "{{ id }}"
            uri: "{{ uri }}"
            storageAccountId: "{{ storageAccountId }}"
        dataDiskImages:
          - sizeInGB: {{ sizeInGB }}
            hostCaching: "{{ hostCaching }}"
            source:
              id: "{{ id }}"
              uri: "{{ uri }}"
              storageAccountId: "{{ storageAccountId }}"
            lun: {{ lun }}
      safetyProfile:
        allowDeletionOfReplicatedLocations: {{ allowDeletionOfReplicatedLocations }}
        reportedForPolicyViolation: {{ reportedForPolicyViolation }}
        policyViolations:
          - category: "{{ category }}"
            details: "{{ details }}"
        blockDeletionBeforeEndOfLife: {{ blockDeletionBeforeEndOfLife }}
      replicationStatus:
        aggregatedState: "{{ aggregatedState }}"
        summary:
          - region: "{{ region }}"
            state: "{{ state }}"
            details: "{{ details }}"
            progress: {{ progress }}
      securityProfile:
        uefiSettings:
          signatureTemplateNames:
            - "{{ signatureTemplateNames }}"
          additionalSignatures:
            pk:
              type: "{{ type }}"
              value: "{{ value }}"
            kek:
              - type: "{{ type }}"
                value: "{{ value }}"
            db:
              - type: "{{ type }}"
                value: "{{ value }}"
            dbx:
              - type: "{{ type }}"
                value: "{{ value }}"
      restore: {{ restore }}
      validationsProfile:
        validationEtag: "{{ validationEtag }}"
        executedValidations:
          - type: "{{ type }}"
            status: "{{ status }}"
            version: "{{ version }}"
            executionTime: "{{ executionTime }}"
        platformAttributes:
          - name: "{{ name }}"
            value: "{{ value }}"

UPDATE examples

update

Update a gallery image version.

UPDATE azure.compute.gallery_image_versions
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 gallery_image_version_name = '{{ gallery_image_version_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 version.

REPLACE azure.compute.gallery_image_versions
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 gallery_image_version_name = '{{ gallery_image_version_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 version.

DELETE FROM azure.compute.gallery_image_versions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ 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
;