gallery_application_versions

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

Overview

Name	gallery_application_versions
Type	Resource
Id	azure.compute.gallery_application_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. Required.
replicationStatus	object	This is the replication status of the gallery image version.
safetyProfile	object	The safety profile of the Gallery Application Version.
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".

list_by_gallery_application

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. Required.
replicationStatus	object	This is the replication status of the gallery image version.
safetyProfile	object	The safety profile of the Gallery Application Version.
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".

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_application_name, gallery_application_version_name, subscription_id	$expand	Retrieves information about a gallery Application Version.
list_by_gallery_application	select	resource_group_name, gallery_name, gallery_application_name, subscription_id		List gallery Application Versions in a gallery Application Definition.
create_or_update	insert	resource_group_name, gallery_name, gallery_application_name, gallery_application_version_name, subscription_id, location		Create or update a gallery Application Version.
update	update	resource_group_name, gallery_name, gallery_application_name, gallery_application_version_name, subscription_id		Update a gallery Application Version.
create_or_update	replace	resource_group_name, gallery_name, gallery_application_name, gallery_application_version_name, subscription_id, location		Create or update a gallery Application Version.
delete	delete	resource_group_name, gallery_name, gallery_application_name, gallery_application_version_name, subscription_id		Delete a gallery Application 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_application_name	string	The name of the gallery Application Definition to be retrieved. Required.
gallery_application_version_name	string	The name of the gallery Application 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 Application Version.

SELECT
id,
name,
location,
provisioningState,
publishingProfile,
replicationStatus,
safetyProfile,
systemData,
tags,
type
FROM azure.compute.gallery_application_versions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gallery_name = '{{ gallery_name }}' -- required
AND gallery_application_name = '{{ gallery_application_name }}' -- required
AND gallery_application_version_name = '{{ gallery_application_version_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_gallery_application

List gallery Application Versions in a gallery Application Definition.

SELECT
id,
name,
location,
provisioningState,
publishingProfile,
replicationStatus,
safetyProfile,
systemData,
tags,
type
FROM azure.compute.gallery_application_versions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gallery_name = '{{ gallery_name }}' -- required
AND gallery_application_name = '{{ gallery_application_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a gallery Application Version.

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

Manifest

# Description fields are for documentation purposes
- name: gallery_application_versions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gallery_application_versions resource.
  - name: gallery_name
    value: "{{ gallery_name }}"
    description: Required parameter for the gallery_application_versions resource.
  - name: gallery_application_name
    value: "{{ gallery_application_name }}"
    description: Required parameter for the gallery_application_versions resource.
  - name: gallery_application_version_name
    value: "{{ gallery_application_version_name }}"
    description: Required parameter for the gallery_application_versions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the gallery_application_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 }}"
        source:
          mediaLink: "{{ mediaLink }}"
          defaultConfigurationLink: "{{ defaultConfigurationLink }}"
        manageActions:
          install: "{{ install }}"
          remove: "{{ remove }}"
          update: "{{ update }}"
        settings:
          packageFileName: "{{ packageFileName }}"
          configFileName: "{{ configFileName }}"
          scriptBehaviorAfterReboot: "{{ scriptBehaviorAfterReboot }}"
        advancedSettings: "{{ advancedSettings }}"
        enableHealthCheck: {{ enableHealthCheck }}
        customActions:
          - name: "{{ name }}"
            script: "{{ script }}"
            description: "{{ description }}"
            parameters: "{{ parameters }}"
      safetyProfile:
        allowDeletionOfReplicatedLocations: {{ allowDeletionOfReplicatedLocations }}
      provisioningState: "{{ provisioningState }}"
      replicationStatus:
        aggregatedState: "{{ aggregatedState }}"
        summary:
          - region: "{{ region }}"
            state: "{{ state }}"
            details: "{{ details }}"
            progress: {{ progress }}

UPDATE examples

update

Update a gallery Application Version.

UPDATE azure.compute.gallery_application_versions
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND gallery_application_name = '{{ gallery_application_name }}' --required
AND gallery_application_version_name = '{{ gallery_application_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 Application Version.

REPLACE azure.compute.gallery_application_versions
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND gallery_application_name = '{{ gallery_application_name }}' --required
AND gallery_application_version_name = '{{ gallery_application_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 Application Version.

DELETE FROM azure.compute.gallery_application_versions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND gallery_application_name = '{{ gallery_application_name }}' --required
AND gallery_application_version_name = '{{ gallery_application_version_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;