users

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

Overview

Name	users
Type	Resource
Id	azure.lab_services.users

Fields

The following fields are returned by SELECT queries:

get

The request was successful; response contains the lab user.

Name	Datatype	Description
properties	object	User resource properties
systemData	object	Metadata pertaining to creation and last modification of the user resource.

list_by_lab

The request was successful; response contains all users for the given lab.

Name	Datatype	Description
properties	object	User resource properties
systemData	object	Metadata pertaining to creation and last modification of the user resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Returns the properties of a lab user.
list_by_lab	select			Returns a list of all users for a lab.
create_or_update	insert	data__properties		Operation to create or update a lab user.
update	update			Operation to update a lab user.
delete	delete			Operation to delete a user resource.
invite	exec			Operation to invite a user to a lab.

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

SELECT examples

get

Returns the properties of a lab user.

SELECT
properties,
systemData
FROM azure.lab_services.users
;

list_by_lab

Returns a list of all users for a lab.

SELECT
properties,
systemData
FROM azure.lab_services.users
;

INSERT examples

create_or_update

Operation to create or update a lab user.

INSERT INTO azure.lab_services.users (
data__properties
)
SELECT 
'{{ properties }}' /* required */
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: users
  props:
    - name: properties
      value: object
      description: |
        User resource properties

UPDATE examples

update

Operation to update a lab user.

UPDATE azure.lab_services.users
SET 
data__properties = '{{ properties }}'
RETURNING
properties,
systemData;

DELETE examples

delete

Operation to delete a user resource.

DELETE FROM azure.lab_services.users
;

Lifecycle Methods

invite

Operation to invite a user to a lab.

EXEC azure.lab_services.users.invite 
@@json=
'{
"text": "{{ text }}"
}'
;