template_specs

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

Overview

Name	template_specs
Type	Resource
Id	azure.resource.template_specs

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 description.
displayName	string	Template Spec display name.
location	string	The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. Required.
metadata	object	The Template Spec 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.
versions	object	High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'.

list_by_resource_group

Name	Datatype	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
description	string	Template Spec description.
displayName	string	Template Spec display name.
location	string	The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. Required.
metadata	object	The Template Spec 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.
versions	object	High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'.

list_by_subscription

Name	Datatype	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
description	string	Template Spec description.
displayName	string	Template Spec display name.
location	string	The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. Required.
metadata	object	The Template Spec 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.
versions	object	High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to 'versions'.

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, subscription_id	$expand	Gets a Template Spec with a given name.
list_by_resource_group	select	resource_group_name, subscription_id	$expand	Lists all the Template Specs within the specified resource group.
list_by_subscription	select	subscription_id	$expand	Lists all the Template Specs within the specified subscriptions.
create_or_update	insert	resource_group_name, template_spec_name, subscription_id, location		Creates or updates a Template Spec.
update	update	resource_group_name, template_spec_name, subscription_id		Updates Template Spec tags with specified values.
create_or_update	replace	resource_group_name, template_spec_name, subscription_id, location		Creates or updates a Template Spec.
delete	delete	resource_group_name, template_spec_name, subscription_id		Deletes a Template Spec by name. 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.
$expand	string	Allows for expansion of additional Template Spec details in the response. Optional. "versions" Default value is None.

SELECT examples

get

Gets a Template Spec with a given name.

SELECT
id,
name,
description,
displayName,
location,
metadata,
systemData,
tags,
type,
versions
FROM azure.resource.template_specs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND template_spec_name = '{{ template_spec_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Lists all the Template Specs within the specified resource group.

SELECT
id,
name,
description,
displayName,
location,
metadata,
systemData,
tags,
type,
versions
FROM azure.resource.template_specs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_subscription

Lists all the Template Specs within the specified subscriptions.

SELECT
id,
name,
description,
displayName,
location,
metadata,
systemData,
tags,
type,
versions
FROM azure.resource.template_specs
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

Creates or updates a Template Spec.

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

Manifest

# Description fields are for documentation purposes
- name: template_specs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the template_specs resource.
  - name: template_spec_name
    value: "{{ template_spec_name }}"
    description: Required parameter for the template_specs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the template_specs resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    value:
      description: "{{ description }}"
      displayName: "{{ displayName }}"
      metadata: "{{ metadata }}"

UPDATE examples

update

Updates Template Spec tags with specified values.

UPDATE azure.resource.template_specs
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND template_spec_name = '{{ template_spec_name }}' --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.

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

DELETE examples

delete

Deletes a Template Spec by name. When operation completes, status code 200 returned without content.

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