gallery_images

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

Overview

Name	gallery_images
Type	Resource
Id	azure_stack.azure_stack_hci_vm.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.
cloudInitDataSource	string	Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]. Known values are: "NoCloud" and "Azure". (NoCloud, Azure)
containerId	string	Storage ContainerID of the storage container to be used for gallery image.
extendedLocation	object	The extendedLocation of the resource.
hyperVGeneration	string	The hypervisor generation of the Virtual Machine [V1, V2]. Known values are: "V1" and "V2". (V1, V2)
identifier	object	This is the gallery image definition identifier.
imagePath	string	location of the image the gallery image should be created from.
location	string	The geo-location where the resource lives. Required.
osType	string	Operating system type that the gallery image uses [Windows, Linux]. Required. Known values are: "Windows" and "Linux". (Windows, Linux)
provisioningState	string	Provisioning state of the gallery image. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
sourceVirtualMachineId	string	Resource ID of the source virtual machine from whose OS disk the gallery image is created.
status	object	The observed state of gallery images.
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".
version	object	Specifies information about the gallery image version that you want to create or update.
vmImageRepositoryCredentials	object	The credentials used to login to the image repository that has access to the specified image.

list_by_resource_group

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.
cloudInitDataSource	string	Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]. Known values are: "NoCloud" and "Azure". (NoCloud, Azure)
containerId	string	Storage ContainerID of the storage container to be used for gallery image.
extendedLocation	object	The extendedLocation of the resource.
hyperVGeneration	string	The hypervisor generation of the Virtual Machine [V1, V2]. Known values are: "V1" and "V2". (V1, V2)
identifier	object	This is the gallery image definition identifier.
imagePath	string	location of the image the gallery image should be created from.
location	string	The geo-location where the resource lives. Required.
osType	string	Operating system type that the gallery image uses [Windows, Linux]. Required. Known values are: "Windows" and "Linux". (Windows, Linux)
provisioningState	string	Provisioning state of the gallery image. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
sourceVirtualMachineId	string	Resource ID of the source virtual machine from whose OS disk the gallery image is created.
status	object	The observed state of gallery images.
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".
version	object	Specifies information about the gallery image version that you want to create or update.
vmImageRepositoryCredentials	object	The credentials used to login to the image repository that has access to the specified image.

list_all

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.
cloudInitDataSource	string	Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]. Known values are: "NoCloud" and "Azure". (NoCloud, Azure)
containerId	string	Storage ContainerID of the storage container to be used for gallery image.
extendedLocation	object	The extendedLocation of the resource.
hyperVGeneration	string	The hypervisor generation of the Virtual Machine [V1, V2]. Known values are: "V1" and "V2". (V1, V2)
identifier	object	This is the gallery image definition identifier.
imagePath	string	location of the image the gallery image should be created from.
location	string	The geo-location where the resource lives. Required.
osType	string	Operating system type that the gallery image uses [Windows, Linux]. Required. Known values are: "Windows" and "Linux". (Windows, Linux)
provisioningState	string	Provisioning state of the gallery image. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
sourceVirtualMachineId	string	Resource ID of the source virtual machine from whose OS disk the gallery image is created.
status	object	The observed state of gallery images.
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".
version	object	Specifies information about the gallery image version that you want to create or update.
vmImageRepositoryCredentials	object	The credentials used to login to the image repository that has access to the specified image.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, gallery_image_name, subscription_id		Gets a gallery image.
list_by_resource_group	select	resource_group_name, subscription_id		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	subscription_id		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	resource_group_name, gallery_image_name, subscription_id, location		The operation to create or update a gallery image. Please note some properties can be set only during gallery image creation.
update	update	resource_group_name, gallery_image_name, subscription_id		The operation to update a gallery image.
create_or_update	replace	resource_group_name, gallery_image_name, subscription_id, location		The operation to create or update a gallery image. Please note some properties can be set only during gallery image creation.
delete	delete	resource_group_name, gallery_image_name, subscription_id		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
gallery_image_name	string	Name of the gallery image. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a gallery image.

SELECT
id,
name,
cloudInitDataSource,
containerId,
extendedLocation,
hyperVGeneration,
identifier,
imagePath,
location,
osType,
provisioningState,
sourceVirtualMachineId,
status,
systemData,
tags,
type,
version,
vmImageRepositoryCredentials
FROM azure_stack.azure_stack_hci_vm.gallery_images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gallery_image_name = '{{ gallery_image_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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
id,
name,
cloudInitDataSource,
containerId,
extendedLocation,
hyperVGeneration,
identifier,
imagePath,
location,
osType,
provisioningState,
sourceVirtualMachineId,
status,
systemData,
tags,
type,
version,
vmImageRepositoryCredentials
FROM azure_stack.azure_stack_hci_vm.gallery_images
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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
id,
name,
cloudInitDataSource,
containerId,
extendedLocation,
hyperVGeneration,
identifier,
imagePath,
location,
osType,
provisioningState,
sourceVirtualMachineId,
status,
systemData,
tags,
type,
version,
vmImageRepositoryCredentials
FROM azure_stack.azure_stack_hci_vm.gallery_images
WHERE subscription_id = '{{ subscription_id }}' -- 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_vm.gallery_images (
tags,
location,
properties,
extendedLocation,
resource_group_name,
gallery_image_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ gallery_image_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
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_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: |
      The resource-specific properties for this resource.
    value:
      containerId: "{{ containerId }}"
      imagePath: "{{ imagePath }}"
      osType: "{{ osType }}"
      cloudInitDataSource: "{{ cloudInitDataSource }}"
      hyperVGeneration: "{{ hyperVGeneration }}"
      vmImageRepositoryCredentials:
        username: "{{ username }}"
        password: "{{ password }}"
      identifier:
        publisher: "{{ publisher }}"
        offer: "{{ offer }}"
        sku: "{{ sku }}"
      version:
        name: "{{ name }}"
        properties:
          storageProfile:
            osDiskImage:
              sizeInMB: {{ sizeInMB }}
      provisioningState: "{{ provisioningState }}"
      status:
        errorCode: "{{ errorCode }}"
        errorMessage: "{{ errorMessage }}"
        provisioningStatus:
          operationId: "{{ operationId }}"
          status: "{{ status }}"
        downloadStatus:
          downloadSizeInMB: {{ downloadSizeInMB }}
        progressPercentage: {{ progressPercentage }}
      sourceVirtualMachineId: "{{ sourceVirtualMachineId }}"
  - name: extendedLocation
    description: |
      The extendedLocation of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

The operation to update a gallery image.

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

REPLACE 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.

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

DELETE examples

delete

The operation to delete a gallery image.

DELETE FROM azure_stack.azure_stack_hci_vm.gallery_images
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND gallery_image_name = '{{ gallery_image_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;