gallery_scripts

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

Overview

Name	gallery_scripts
Type	Resource
Id	azure.compute.gallery_scripts

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.
description	string	The description of this gallery script definition resource. This property is updatable.
endOfLifeDate	string (date-time)	The end of life date of the gallery Script Definition. This property can be used for decommissioning purposes. This property is updatable.
eula	string	The Eula agreement (End User License Agreement) for the gallery Script Definition.
location	string	The geo-location where the resource lives. Required.
privacyStatementUri	string	The privacy statement uri.
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)
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.
description	string	The description of this gallery script definition resource. This property is updatable.
endOfLifeDate	string (date-time)	The end of life date of the gallery Script Definition. This property can be used for decommissioning purposes. This property is updatable.
eula	string	The Eula agreement (End User License Agreement) for the gallery Script Definition.
location	string	The geo-location where the resource lives. Required.
privacyStatementUri	string	The privacy statement uri.
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)
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_script_name, subscription_id		Retrieves information about a gallery script definition.
list_by_gallery	select	resource_group_name, gallery_name, subscription_id		List gallery Script Definitions in a gallery.
create_or_update	insert	resource_group_name, gallery_name, gallery_script_name, subscription_id, location		Create or update a Gallery Script Definition. Gallery scripts allow the storage, sharing and reuse of common scripts.
update	update	resource_group_name, gallery_name, gallery_script_name, subscription_id		Update a gallery Script Definition.
create_or_update	replace	resource_group_name, gallery_name, gallery_script_name, subscription_id, location		Create or update a Gallery Script Definition. Gallery scripts allow the storage, sharing and reuse of common scripts.
delete	delete	resource_group_name, gallery_name, gallery_script_name, subscription_id		Delete a gallery Script Definition.

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_name	string	The name of the Shared Image Gallery. Required.
gallery_script_name	string	The name of the gallery Script Definition to be retrieved. 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 script definition.

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

list_by_gallery

List gallery Script Definitions in a gallery.

SELECT
id,
name,
description,
endOfLifeDate,
eula,
location,
privacyStatementUri,
provisioningState,
releaseNoteUri,
supportedOSType,
systemData,
tags,
type
FROM azure.compute.gallery_scripts
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 Script Definition. Gallery scripts allow the storage, sharing and reuse of common scripts.

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

Manifest

# Description fields are for documentation purposes
- name: gallery_scripts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gallery_scripts resource.
  - name: gallery_name
    value: "{{ gallery_name }}"
    description: Required parameter for the gallery_scripts resource.
  - name: gallery_script_name
    value: "{{ gallery_script_name }}"
    description: Required parameter for the gallery_scripts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the gallery_scripts 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 Script Definition.
    value:
      description: "{{ description }}"
      eula: "{{ eula }}"
      privacyStatementUri: "{{ privacyStatementUri }}"
      releaseNoteUri: "{{ releaseNoteUri }}"
      endOfLifeDate: "{{ endOfLifeDate }}"
      supportedOSType: "{{ supportedOSType }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a gallery Script Definition.

UPDATE azure.compute.gallery_scripts
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND gallery_script_name = '{{ gallery_script_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 Script Definition. Gallery scripts allow the storage, sharing and reuse of common scripts.

REPLACE azure.compute.gallery_scripts
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND gallery_script_name = '{{ gallery_script_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 Script Definition.

DELETE FROM azure.compute.gallery_scripts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND gallery_script_name = '{{ gallery_script_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;