artifacts

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

Overview

Name	artifacts
Type	Resource
Id	azure.dev_test_labs.artifacts

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.
location	string	The location of the resource.
properties	object	The properties of the resource.
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.
location	string	The location of the resource.
properties	object	The properties of the resource.
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	subscriptionId, resourceGroupName, labName, artifactSourceName, name	$expand, api-version	Get artifact.
list	select	subscriptionId, resourceGroupName, labName, artifactSourceName	$expand, $filter, $top, $orderby, api-version	List artifacts in a given artifact source.
generate_arm_template	exec	subscriptionId, resourceGroupName, labName, artifactSourceName, name	api-version	Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.

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
artifactSourceName	string	The name of the artifact source.
labName	string	The name of the lab.
name	string	The name of the artifact.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The subscription ID.
$expand	string	Specify the $expand query. Example: 'properties($select=title)'
$filter	string	The filter to apply to the operation. Example: '$filter=contains(name,'myName')
$orderby	string	The ordering expression for the results, using OData notation. Example: '$orderby=name desc'
$top	integer (int32)	The maximum number of resources to return from the operation. Example: '$top=10'
api-version	string	Client API version.

SELECT examples

get

Get artifact.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.dev_test_labs.artifacts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND labName = '{{ labName }}' -- required
AND artifactSourceName = '{{ artifactSourceName }}' -- required
AND name = '{{ name }}' -- required
AND $expand = '{{ $expand }}'
AND api-version = '{{ api-version }}'
;

list

List artifacts in a given artifact source.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.dev_test_labs.artifacts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND labName = '{{ labName }}' -- required
AND artifactSourceName = '{{ artifactSourceName }}' -- required
AND $expand = '{{ $expand }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

generate_arm_template

Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.

EXEC azure.dev_test_labs.artifacts.generate_arm_template 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@labName='{{ labName }}' --required, 
@artifactSourceName='{{ artifactSourceName }}' --required, 
@name='{{ name }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"virtualMachineName": "{{ virtualMachineName }}", 
"parameters": "{{ parameters }}", 
"location": "{{ location }}", 
"fileUploadOptions": "{{ fileUploadOptions }}"
}'
;