arm_templates

Creates, updates, deletes, gets or lists an arm_templates resource.

Overview

Name	arm_templates
Type	Resource
Id	azure.dev_test_labs.arm_templates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
contents	object	The contents of the ARM template.
createdDate	string (date-time)	The creation date of the armTemplate.
description	string	The description of the ARM template.
displayName	string	The display name of the ARM template.
enabled	boolean	Whether or not ARM template is enabled for use by lab user.
icon	string	The URI to the icon of the ARM template.
location	string	The location of the resource.
parametersValueFilesInfo	array	File name and parameter values information from all azuredeploy.*.parameters.json for the ARM template.
publisher	string	The publisher of the ARM template.
tags	object	The tags of the resource.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
contents	object	The contents of the ARM template.
createdDate	string (date-time)	The creation date of the armTemplate.
description	string	The description of the ARM template.
displayName	string	The display name of the ARM template.
enabled	boolean	Whether or not ARM template is enabled for use by lab user.
icon	string	The URI to the icon of the ARM template.
location	string	The location of the resource.
parametersValueFilesInfo	array	File name and parameter values information from all azuredeploy.*.parameters.json for the ARM template.
publisher	string	The publisher of the ARM template.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, lab_name, artifact_source_name, name, subscription_id	$expand	Get azure resource manager template.
list	select	resource_group_name, lab_name, artifact_source_name, subscription_id	$expand, $filter, $top, $orderby	List azure resource manager templates in a given artifact source.

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
artifact_source_name	string	The name of the artifact source. Required.
lab_name	string	The name of the lab. Required.
name	string	The name of the azure resource manager template. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string
$expand	string	Specify the $expand query. Example: 'properties($select=displayName)'. Default value is None.
$filter	string	The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None.
$orderby	string	The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get azure resource manager template.

SELECT
id,
name,
contents,
createdDate,
description,
displayName,
enabled,
icon,
location,
parametersValueFilesInfo,
publisher,
tags,
type
FROM azure.dev_test_labs.arm_templates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND artifact_source_name = '{{ artifact_source_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

List azure resource manager templates in a given artifact source.

SELECT
id,
name,
contents,
createdDate,
description,
displayName,
enabled,
icon,
location,
parametersValueFilesInfo,
publisher,
tags,
type
FROM azure.dev_test_labs.arm_templates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND artifact_source_name = '{{ artifact_source_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;