users

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

Overview

Name	users
Type	Resource
Id	azure.dev_test_labs.users

Fields

vw_users

Name	Datatype	Description
id	text	The identifier of the resource.
name	text	The name of the resource.
created_date	text	field from the properties object
identity	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
secret_store	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

users

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 a lab user profile.
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	Get user profile.
list	SELECT	labName, resourceGroupName, subscriptionId	List user profiles in a given lab.
create_or_update	INSERT	labName, name, resourceGroupName, subscriptionId	Create or replace an existing user profile. This operation can take a while to complete.
delete	DELETE	labName, name, resourceGroupName, subscriptionId	Delete user profile. This operation can take a while to complete.
update	UPDATE	labName, name, resourceGroupName, subscriptionId	Allows modifying tags of user profiles. All other properties will be ignored.

SELECT examples

List user profiles in a given lab.

vw_users

SELECT
id,
name,
created_date,
identity,
labName,
location,
provisioning_state,
resourceGroupName,
secret_store,
subscriptionId,
tags,
type,
unique_identifier
FROM azure.dev_test_labs.vw_users
WHERE labName = '{{ labName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

users

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.dev_test_labs.users (
labName,
name,
resourceGroupName,
subscriptionId,
location,
tags,
properties
)
SELECT 
'{{ labName }}',
'{{ name }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ 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: identity
          value:
            - name: principalName
              value: string
            - name: principalId
              value: string
            - name: tenantId
              value: string
            - name: objectId
              value: string
            - name: appId
              value: string
        - name: secretStore
          value:
            - name: keyVaultUri
              value: string
            - name: keyVaultId
              value: string
        - name: createdDate
          value: string
        - name: provisioningState
          value: string
        - name: uniqueIdentifier
          value: string

UPDATE example

Updates a users resource.

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

DELETE example

Deletes the specified users resource.

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