gallery_applications

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

Overview

Name	gallery_applications
Type	Resource
Id	azure.compute.gallery_applications

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.
customActions	array	A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application.
description	string	The description of this gallery Application Definition resource. This property is updatable.
endOfLifeDate	string (date-time)	The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
eula	string	The Eula agreement for the gallery Application Definition.
location	string	The geo-location where the resource lives. Required.
privacyStatementUri	string	The privacy statement uri.
releaseNoteUri	string	The release note uri.
supportedOSType	string	This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux.. Required. Known values are: "Windows" and "Linux". (Windows, Linux)
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

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.
customActions	array	A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application.
description	string	The description of this gallery Application Definition resource. This property is updatable.
endOfLifeDate	string (date-time)	The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable.
eula	string	The Eula agreement for the gallery Application Definition.
location	string	The geo-location where the resource lives. Required.
privacyStatementUri	string	The privacy statement uri.
releaseNoteUri	string	The release note uri.
supportedOSType	string	This property allows you to specify the supported type of the OS that application is built for. Possible values are: Windows, Linux.. Required. Known values are: "Windows" and "Linux". (Windows, Linux)
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, subscription_id		Retrieves information about a gallery Application Definition.
list_by_gallery	select	resource_group_name, gallery_name, subscription_id		List gallery Application Definitions in a gallery.
create_or_update	insert	resource_group_name, gallery_name, gallery_application_name, subscription_id, location		Create or update a gallery Application Definition.
update	update	resource_group_name, gallery_name, gallery_application_name, subscription_id		Update a gallery Application Definition.
create_or_update	replace	resource_group_name, gallery_name, gallery_application_name, subscription_id, location		Create or update a gallery Application Definition.
delete	delete	resource_group_name, gallery_name, gallery_application_name, subscription_id		Delete a gallery Application.

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_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

SELECT examples

get

Retrieves information about a gallery Application Definition.

SELECT
id,
name,
customActions,
description,
endOfLifeDate,
eula,
location,
privacyStatementUri,
releaseNoteUri,
supportedOSType,
systemData,
tags,
type
FROM azure.compute.gallery_applications
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
;

list_by_gallery

List gallery Application Definitions in a gallery.

SELECT
id,
name,
customActions,
description,
endOfLifeDate,
eula,
location,
privacyStatementUri,
releaseNoteUri,
supportedOSType,
systemData,
tags,
type
FROM azure.compute.gallery_applications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gallery_name = '{{ gallery_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a gallery Application Definition.

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

Manifest

# Description fields are for documentation purposes
- name: gallery_applications
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gallery_applications resource.
  - name: gallery_name
    value: "{{ gallery_name }}"
    description: Required parameter for the gallery_applications resource.
  - name: gallery_application_name
    value: "{{ gallery_application_name }}"
    description: Required parameter for the gallery_applications resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the gallery_applications 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 Application Definition.
    value:
      description: "{{ description }}"
      eula: "{{ eula }}"
      privacyStatementUri: "{{ privacyStatementUri }}"
      releaseNoteUri: "{{ releaseNoteUri }}"
      endOfLifeDate: "{{ endOfLifeDate }}"
      supportedOSType: "{{ supportedOSType }}"
      customActions:
        - name: "{{ name }}"
          script: "{{ script }}"
          description: "{{ description }}"
          parameters: "{{ parameters }}"

UPDATE examples

update

Update a gallery Application Definition.

UPDATE azure.compute.gallery_applications
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a gallery Application Definition.

REPLACE azure.compute.gallery_applications
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 subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a gallery Application.

DELETE FROM azure.compute.gallery_applications
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
;