users

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

Overview

Name	users
Type	Resource
Id	azure.dev_test_labs.users

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.
createdDate	string (date-time)	The creation date of the user profile.
identity	object	The identity of the user.
location	string	The location of the resource.
provisioningState	string	The provisioning status of the resource.
secretStore	object	The secret store of the user.
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.
createdDate	string (date-time)	The creation date of the user profile.
identity	object	The identity of the user.
location	string	The location of the resource.
provisioningState	string	The provisioning status of the resource.
secretStore	object	The secret store of the user.
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, name, subscription_id	$expand	Get user profile.
list	select	resource_group_name, lab_name, subscription_id	$expand, $filter, $top, $orderby	List user profiles in a given lab.
create_or_update	insert	resource_group_name, lab_name, name, subscription_id		Create or replace an existing user profile. This operation can take a while to complete.
update	update	resource_group_name, lab_name, name, subscription_id		Allows modifying tags of user profiles. All other properties will be ignored.
create_or_update	replace	resource_group_name, lab_name, name, subscription_id		Create or replace an existing user profile. This operation can take a while to complete.
delete	delete	resource_group_name, lab_name, name, subscription_id		Delete user profile. 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 user profile. Required.
resource_group_name	string	The name of the resource group. Required.
subscription_id	string
$expand	string	Specify the $expand query. Example: 'properties($select=identity)'. 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 user profile.

SELECT
id,
name,
createdDate,
identity,
location,
provisioningState,
secretStore,
tags,
type,
uniqueIdentifier
FROM azure.dev_test_labs.users
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

List user profiles in a given lab.

SELECT
id,
name,
createdDate,
identity,
location,
provisioningState,
secretStore,
tags,
type,
uniqueIdentifier
FROM azure.dev_test_labs.users
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_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 user profile. This operation can take a while to complete.

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

Manifest

# Description fields are for documentation purposes
- name: users
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the users resource.
  - name: lab_name
    value: "{{ lab_name }}"
    description: Required parameter for the users resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the users resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the users resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags of the resource.
  - name: properties
    value:
      identity:
        principalName: "{{ principalName }}"
        principalId: "{{ principalId }}"
        tenantId: "{{ tenantId }}"
        objectId: "{{ objectId }}"
        appId: "{{ appId }}"
      secretStore:
        keyVaultUri: "{{ keyVaultUri }}"
        keyVaultId: "{{ keyVaultId }}"

UPDATE examples

update

Allows modifying tags of user profiles. All other properties will be ignored.

UPDATE azure.dev_test_labs.users
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND lab_name = '{{ lab_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 user profile. This operation can take a while to complete.

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

DELETE examples

delete

Delete user profile. This operation can take a while to complete.

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