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	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Describes the properties of a gallery image version.
tags	object	Resource tags
type	string	Resource type

list_by_gallery_image

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Describes the properties of a gallery image version.
tags	object	Resource tags
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, galleryName, galleryImageName, galleryImageVersionName	$expand	Retrieves information about a gallery image version.
list_by_gallery_image	select	subscriptionId, resourceGroupName, galleryName, galleryImageName		List gallery image versions in a gallery image definition.
create_or_update	insert	subscriptionId, resourceGroupName, galleryName, galleryImageName, galleryImageVersionName		Create or update a gallery image version.
update	update	subscriptionId, resourceGroupName, galleryName, galleryImageName, galleryImageVersionName		Update a gallery image version.
delete	delete	subscriptionId, resourceGroupName, galleryName, galleryImageName, galleryImageVersionName		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
galleryImageName	string	The name of the gallery image definition in which the Image Version resides.
galleryImageVersionName	string	The name of the gallery image version to be deleted.
galleryName	string	The name of the Shared Image Gallery in which the Image Definition resides.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$expand	string	The expand expression to apply on the operation.

SELECT examples

get

Retrieves information about a gallery image version.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.compute.gallery_image_versions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND galleryName = '{{ galleryName }}' -- required
AND galleryImageName = '{{ galleryImageName }}' -- required
AND galleryImageVersionName = '{{ galleryImageVersionName }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_gallery_image

List gallery image versions in a gallery image definition.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.compute.gallery_image_versions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND galleryName = '{{ galleryName }}' -- required
AND galleryImageName = '{{ galleryImageName }}' -- required
;

INSERT examples

create_or_update

Create or update a gallery image version.

INSERT INTO azure.compute.gallery_image_versions (
data__properties,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
galleryName,
galleryImageName,
galleryImageVersionName
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ galleryName }}',
'{{ galleryImageName }}',
'{{ galleryImageVersionName }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: gallery_image_versions
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the gallery_image_versions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the gallery_image_versions resource.
    - name: galleryName
      value: string
      description: Required parameter for the gallery_image_versions resource.
    - name: galleryImageName
      value: string
      description: Required parameter for the gallery_image_versions resource.
    - name: galleryImageVersionName
      value: string
      description: Required parameter for the gallery_image_versions resource.
    - name: properties
      value: object
      description: |
        Describes the properties of a gallery image version.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

UPDATE examples

update

Update a gallery image version.

UPDATE azure.compute.gallery_image_versions
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND galleryName = '{{ galleryName }}' --required
AND galleryImageName = '{{ galleryImageName }}' --required
AND galleryImageVersionName = '{{ galleryImageVersionName }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete a gallery image version.

DELETE FROM azure.compute.gallery_image_versions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND galleryName = '{{ galleryName }}' --required
AND galleryImageName = '{{ galleryImageName }}' --required
AND galleryImageVersionName = '{{ galleryImageVersionName }}' --required
;