template_spec_versions

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

Overview

Name	template_spec_versions
Type	Resource
Id	azure.resource.template_spec_versions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
description	string	Template Spec version description.
linkedTemplates	array	An array of linked template artifacts.
location	string	The location of the Template Spec Version. It must match the location of the parent Template Spec. Required.
mainTemplate	object	The main Azure Resource Manager template content.
metadata	object	The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	Type of this resource.
uiFormDefinition	object	The Azure Resource Manager template UI definition content.

list

Name	Datatype	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
description	string	Template Spec version description.
linkedTemplates	array	An array of linked template artifacts.
location	string	The location of the Template Spec Version. It must match the location of the parent Template Spec. Required.
mainTemplate	object	The main Azure Resource Manager template content.
metadata	object	The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	Type of this resource.
uiFormDefinition	object	The Azure Resource Manager template UI definition content.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, template_spec_name, template_spec_version, subscription_id		Gets a Template Spec version from a specific Template Spec.
list	select	resource_group_name, template_spec_name, subscription_id		Lists all the Template Spec versions in the specified Template Spec.
create_or_update	insert	resource_group_name, template_spec_name, template_spec_version, subscription_id, location		Creates or updates a Template Spec version.
update	update	resource_group_name, template_spec_name, template_spec_version, subscription_id		Updates Template Spec Version tags with specified values.
create_or_update	replace	resource_group_name, template_spec_name, template_spec_version, subscription_id, location		Creates or updates a Template Spec version.
delete	delete	resource_group_name, template_spec_name, template_spec_version, subscription_id		Deletes a specific version from a Template Spec. When operation completes, status code 200 returned without content.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
template_spec_name	string	Name of the Template Spec. Required.
template_spec_version	string	The version of the Template Spec. Required.

SELECT examples

get

Gets a Template Spec version from a specific Template Spec.

SELECT
id,
name,
description,
linkedTemplates,
location,
mainTemplate,
metadata,
systemData,
tags,
type,
uiFormDefinition
FROM azure.resource.template_spec_versions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND template_spec_name = '{{ template_spec_name }}' -- required
AND template_spec_version = '{{ template_spec_version }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the Template Spec versions in the specified Template Spec.

SELECT
id,
name,
description,
linkedTemplates,
location,
mainTemplate,
metadata,
systemData,
tags,
type,
uiFormDefinition
FROM azure.resource.template_spec_versions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND template_spec_name = '{{ template_spec_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Template Spec version.

INSERT INTO azure.resource.template_spec_versions (
location,
tags,
properties,
resource_group_name,
template_spec_name,
template_spec_version,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ template_spec_name }}',
'{{ template_spec_version }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: template_spec_versions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the template_spec_versions resource.
  - name: template_spec_name
    value: "{{ template_spec_name }}"
    description: Required parameter for the template_spec_versions resource.
  - name: template_spec_version
    value: "{{ template_spec_version }}"
    description: Required parameter for the template_spec_versions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the template_spec_versions resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the Template Spec Version. It must match the location of the parent Template Spec. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    value:
      description: "{{ description }}"
      linkedTemplates:
        - path: "{{ path }}"
          template: "{{ template }}"
      metadata: "{{ metadata }}"
      mainTemplate: "{{ mainTemplate }}"
      uiFormDefinition: "{{ uiFormDefinition }}"

UPDATE examples

update

Updates Template Spec Version tags with specified values.

UPDATE azure.resource.template_spec_versions
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND template_spec_name = '{{ template_spec_name }}' --required
AND template_spec_version = '{{ template_spec_version }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a Template Spec version.

REPLACE azure.resource.template_spec_versions
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND template_spec_name = '{{ template_spec_name }}' --required
AND template_spec_version = '{{ template_spec_version }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a specific version from a Template Spec. When operation completes, status code 200 returned without content.

DELETE FROM azure.resource.template_spec_versions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND template_spec_name = '{{ template_spec_name }}' --required
AND template_spec_version = '{{ template_spec_version }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;