gallery_script_versions

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

Overview

Name	gallery_script_versions
Type	Resource
Id	azure.compute.gallery_script_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 Script 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_script

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 Script 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_script_name, gallery_script_version_name, subscription_id		Custom ArmResourceRead operation template with CloudError as Error.
list_by_gallery_script	select	resource_group_name, gallery_name, gallery_script_name, subscription_id		List gallery Script Versions in a gallery Script Definition.
create_or_update	insert	resource_group_name, gallery_name, gallery_script_name, gallery_script_version_name, subscription_id, location		Create or update a gallery Script Version.
update	update	resource_group_name, gallery_name, gallery_script_name, gallery_script_version_name, subscription_id		Update a gallery Script Version.
create_or_update	replace	resource_group_name, gallery_name, gallery_script_name, gallery_script_version_name, subscription_id, location		Create or update a gallery Script Version.
delete	delete	resource_group_name, gallery_name, gallery_script_name, gallery_script_version_name, subscription_id		Delete a gallery Script 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_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.
gallery_script_version_name	string	The name of the gallery Script Version 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

Custom ArmResourceRead operation template with CloudError as Error.

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

list_by_gallery_script

List gallery Script Versions in a gallery Script Definition.

SELECT
id,
name,
location,
provisioningState,
publishingProfile,
replicationStatus,
safetyProfile,
systemData,
tags,
type
FROM azure.compute.gallery_script_versions
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
;

INSERT examples

create_or_update

Create or update a gallery Script Version.

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

Manifest

# Description fields are for documentation purposes
- name: gallery_script_versions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gallery_script_versions resource.
  - name: gallery_name
    value: "{{ gallery_name }}"
    description: Required parameter for the gallery_script_versions resource.
  - name: gallery_script_name
    value: "{{ gallery_script_name }}"
    description: Required parameter for the gallery_script_versions resource.
  - name: gallery_script_version_name
    value: "{{ gallery_script_version_name }}"
    description: Required parameter for the gallery_script_versions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the gallery_script_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 Script 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:
          scriptLink: "{{ scriptLink }}"
          parameters:
            - name: "{{ name }}"
              required: {{ required }}
              defaultValue: "{{ defaultValue }}"
              description: "{{ description }}"
              type: "{{ type }}"
              minValue: "{{ minValue }}"
              maxValue: "{{ maxValue }}"
              enumValues: "{{ enumValues }}"
      safetyProfile:
        allowDeletionOfReplicatedLocations: {{ allowDeletionOfReplicatedLocations }}
      provisioningState: "{{ provisioningState }}"
      replicationStatus:
        aggregatedState: "{{ aggregatedState }}"
        summary:
          - region: "{{ region }}"
            state: "{{ state }}"
            details: "{{ details }}"
            progress: {{ progress }}

UPDATE examples

update

Update a gallery Script Version.

UPDATE azure.compute.gallery_script_versions
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 gallery_script_version_name = '{{ gallery_script_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 Script Version.

REPLACE azure.compute.gallery_script_versions
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 gallery_script_version_name = '{{ gallery_script_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 Script Version.

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