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

list_by_gallery

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Describes the properties of a gallery image definition.
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		Retrieves information about a gallery image definition.
list_by_gallery	select	subscriptionId, resourceGroupName, galleryName		List gallery image definitions in a gallery.
create_or_update	insert	subscriptionId, resourceGroupName, galleryName, galleryImageName		Create or update a gallery image definition.
update	update	subscriptionId, resourceGroupName, galleryName, galleryImageName		Update a gallery image definition.
delete	delete	subscriptionId, resourceGroupName, galleryName, galleryImageName		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
galleryImageName	string	The name of the gallery image definition to be deleted.
galleryName	string	The name of the Shared Image Gallery in which the Image Definition is to be deleted.
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.

SELECT examples

get

Retrieves information about a gallery image definition.

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

list_by_gallery

List gallery image definitions in a gallery.

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

INSERT examples

create_or_update

Create or update a gallery image definition.

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

Manifest

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

UPDATE examples

update

Update a gallery image definition.

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

DELETE examples

delete

Delete a gallery image.

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