environments

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

Overview

Name	environments
Type	Resource
Id	azure.dev_test_labs.environments

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.
armTemplateDisplayName	string	The display name of the Azure Resource Manager template that produced the environment.
createdByUser	string	The creator of the environment.
deploymentProperties	object	The deployment properties of the environment.
location	string	The location of the resource.
provisioningState	string	The provisioning status of the resource.
resourceGroupId	string	The identifier of the resource group containing the environment's resources.
tags	object	The tags of the resource.
type	string	The type of the resource.
uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).

list

Name	Datatype	Description
id	string	The identifier of the resource.
name	string	The name of the resource.
armTemplateDisplayName	string	The display name of the Azure Resource Manager template that produced the environment.
createdByUser	string	The creator of the environment.
deploymentProperties	object	The deployment properties of the environment.
location	string	The location of the resource.
provisioningState	string	The provisioning status of the resource.
resourceGroupId	string	The identifier of the resource group containing the environment's resources.
tags	object	The tags of the resource.
type	string	The type of the resource.
uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, lab_name, user_name, name, subscription_id	$expand	Get environment.
list	select	resource_group_name, lab_name, user_name, subscription_id	$expand, $filter, $top, $orderby	List environments in a given user profile.
create_or_update	insert	resource_group_name, lab_name, user_name, name, subscription_id		Create or replace an existing environment. This operation can take a while to complete.
update	update	resource_group_name, lab_name, user_name, name, subscription_id		Allows modifying tags of environments. All other properties will be ignored.
create_or_update	replace	resource_group_name, lab_name, user_name, name, subscription_id		Create or replace an existing environment. This operation can take a while to complete.
delete	delete	resource_group_name, lab_name, user_name, name, subscription_id		Delete environment. This operation can take a while to complete.

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
lab_name	string	The name of the lab. Required.
name	string	The name of the environment. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string
user_name	string	The name of the user profile. Required.
$expand	string	Specify the $expand query. Example: 'properties($select=deploymentProperties)'. 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 environment.

SELECT
id,
name,
armTemplateDisplayName,
createdByUser,
deploymentProperties,
location,
provisioningState,
resourceGroupId,
tags,
type,
uniqueIdentifier
FROM azure.dev_test_labs.environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND user_name = '{{ user_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

List environments in a given user profile.

SELECT
id,
name,
armTemplateDisplayName,
createdByUser,
deploymentProperties,
location,
provisioningState,
resourceGroupId,
tags,
type,
uniqueIdentifier
FROM azure.dev_test_labs.environments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND user_name = '{{ user_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create_or_update

Create or replace an existing environment. This operation can take a while to complete.

INSERT INTO azure.dev_test_labs.environments (
location,
tags,
properties,
resource_group_name,
lab_name,
user_name,
name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ lab_name }}',
'{{ user_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: environments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the environments resource.
  - name: lab_name
    value: "{{ lab_name }}"
    description: Required parameter for the environments resource.
  - name: user_name
    value: "{{ user_name }}"
    description: Required parameter for the environments resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the environments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the environments resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags of the resource.
  - name: properties
    value:
      deploymentProperties:
        armTemplateId: "{{ armTemplateId }}"
        parameters:
          - name: "{{ name }}"
            value: "{{ value }}"
      armTemplateDisplayName: "{{ armTemplateDisplayName }}"

UPDATE examples

update

Allows modifying tags of environments. All other properties will be ignored.

UPDATE azure.dev_test_labs.environments
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND user_name = '{{ user_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Create or replace an existing environment. This operation can take a while to complete.

REPLACE azure.dev_test_labs.environments
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND user_name = '{{ user_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete environment. This operation can take a while to complete.

DELETE FROM azure.dev_test_labs.environments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_name }}' --required
AND user_name = '{{ user_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;