gallery_images

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

Overview

Name	gallery_images
Type	Resource
Id	azure_stack.azure_stack_hci.gallery_images

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the gallery image resource
tags	object	Resource tags.

list

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the gallery image resource
tags	object	Resource tags.

list_all

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the gallery image resource
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, galleryImageName		Gets a gallery image
list	select	subscriptionId, resourceGroupName		Lists all of the gallery images in the specified resource group. Use the nextLink property in the response to get the next page of gallery images.
list_all	select	subscriptionId		Lists all of the gallery images in the specified subscription. Use the nextLink property in the response to get the next page of gallery images.
create_or_update	insert	subscriptionId, resourceGroupName, galleryImageName		The operation to create or update a gallery image. Please note some properties can be set only during gallery image creation.
update	update	subscriptionId, resourceGroupName, galleryImageName		The operation to update a gallery image.
delete	delete	subscriptionId, resourceGroupName, galleryImageName		The operation to 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	Name of the gallery image
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets a gallery image

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.gallery_images
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND galleryImageName = '{{ galleryImageName }}' -- required
;

list

Lists all of the gallery images in the specified resource group. Use the nextLink property in the response to get the next page of gallery images.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.gallery_images
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_all

Lists all of the gallery images in the specified subscription. Use the nextLink property in the response to get the next page of gallery images.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.gallery_images
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

The operation to create or update a gallery image. Please note some properties can be set only during gallery image creation.

INSERT INTO azure_stack.azure_stack_hci.gallery_images (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
galleryImageName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ galleryImageName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: gallery_images
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the gallery_images resource.
    - name: resourceGroupName
      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: |
        Properties under the gallery image resource
    - name: extendedLocation
      value: object
      description: |
        The extendedLocation of the resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

The operation to update a gallery image.

UPDATE azure_stack.azure_stack_hci.gallery_images
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND galleryImageName = '{{ galleryImageName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

The operation to delete a gallery image.

DELETE FROM azure_stack.azure_stack_hci.gallery_images
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND galleryImageName = '{{ galleryImageName }}' --required
;