environments

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

Overview

Name	environments
Type	Resource
Id	azure.dev_test_labs.environments

Fields

vw_environments

Name	Datatype	Description
id	text	The identifier of the resource.
name	text	The name of the resource.
arm_template_display_name	text	field from the properties object
created_by_user	text	field from the properties object
deployment_properties	text	field from the properties object
labName	text	field from the properties object
location	text	The location of the resource.
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_group_id	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	The tags of the resource.
type	text	The type of the resource.
unique_identifier	text	field from the properties object
userName	text	field from the properties object

environments

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	Properties of an environment.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	labName, name, resourceGroupName, subscriptionId, userName	Get environment.
list	SELECT	labName, resourceGroupName, subscriptionId, userName	List environments in a given user profile.
create_or_update	INSERT	labName, name, resourceGroupName, subscriptionId, userName, data__properties	Create or replace an existing environment. This operation can take a while to complete.
delete	DELETE	labName, name, resourceGroupName, subscriptionId, userName	Delete environment. This operation can take a while to complete.
update	UPDATE	labName, name, resourceGroupName, subscriptionId, userName	Allows modifying tags of environments. All other properties will be ignored.

SELECT examples

List environments in a given user profile.

vw_environments

SELECT
id,
name,
arm_template_display_name,
created_by_user,
deployment_properties,
labName,
location,
provisioning_state,
resourceGroupName,
resource_group_id,
subscriptionId,
tags,
type,
unique_identifier,
userName
FROM azure.dev_test_labs.vw_environments
WHERE labName = '{{ labName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND userName = '{{ userName }}';

environments

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.dev_test_labs.environments
WHERE labName = '{{ labName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND userName = '{{ userName }}';

INSERT example

Use the following StackQL query and manifest file to create a new environments resource.

All Properties

/*+ create */
INSERT INTO azure.dev_test_labs.environments (
labName,
name,
resourceGroupName,
subscriptionId,
userName,
data__properties,
location,
tags,
properties
)
SELECT 
'{{ labName }}',
'{{ name }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ userName }}',
'{{ data__properties }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: deploymentProperties
          value:
            - name: armTemplateId
              value: string
            - name: parameters
              value:
                - - name: name
                    value: string
                  - name: value
                    value: string
        - name: armTemplateDisplayName
          value: string
        - name: resourceGroupId
          value: string
        - name: createdByUser
          value: string
        - name: provisioningState
          value: string
        - name: uniqueIdentifier
          value: string

UPDATE example

Updates a environments resource.

/*+ update */
UPDATE azure.dev_test_labs.environments
SET 
tags = '{{ tags }}'
WHERE 
labName = '{{ labName }}'
AND name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND userName = '{{ userName }}';

DELETE example

Deletes the specified environments resource.

/*+ delete */
DELETE FROM azure.dev_test_labs.environments
WHERE labName = '{{ labName }}'
AND name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND userName = '{{ userName }}';