users

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

Overview

Name	users
Type	Resource
Id	azure_extras.lab_services.users

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalUsageQuota	string	The amount of usage quota time the user gets in addition to the lab usage quota.
displayName	string	Display name of the user, for example user's full name.
email	string	Email address of the user. Required.
invitationSent	string (date-time)	Date and time when the invitation message was sent to the user.
invitationState	string	State of the invitation message for the user. Known values are: "NotSent", "Sending", "Sent", and "Failed".
provisioningState	string	Current provisioning state of the user resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Locked".
registrationState	string	State of the user's registration within the lab. Known values are: "Registered" and "NotRegistered".
systemData	object	Metadata pertaining to creation and last modification of the user resource.
totalUsage	string	How long the user has used their virtual machines in this lab.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_lab

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalUsageQuota	string	The amount of usage quota time the user gets in addition to the lab usage quota.
displayName	string	Display name of the user, for example user's full name.
email	string	Email address of the user. Required.
invitationSent	string (date-time)	Date and time when the invitation message was sent to the user.
invitationState	string	State of the invitation message for the user. Known values are: "NotSent", "Sending", "Sent", and "Failed".
provisioningState	string	Current provisioning state of the user resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Locked".
registrationState	string	State of the user's registration within the lab. Known values are: "Registered" and "NotRegistered".
systemData	object	Metadata pertaining to creation and last modification of the user resource.
totalUsage	string	How long the user has used their virtual machines in this lab.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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, subscription_id		Get a lab user. Returns the properties of a lab user.
list_by_lab	select	resource_group_name, lab_name, subscription_id	$filter	Get all users for a lab. Returns a list of all users for a lab.
create_or_update	insert	resource_group_name, lab_name, user_name, subscription_id, properties		Create or update a lab user. Operation to create or update a lab user.
update	update	resource_group_name, lab_name, user_name, subscription_id		Update a lab user. Operation to update a lab user.
create_or_update	replace	resource_group_name, lab_name, user_name, subscription_id, properties		Create or update a lab user. Operation to create or update a lab user.
delete	delete	resource_group_name, lab_name, user_name, subscription_id		Deletes a user resource. Operation to delete a user resource.
invite	exec	resource_group_name, lab_name, user_name, subscription_id		Invite a user to a lab. 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
lab_name	string	The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
user_name	string	The name of the user that uniquely identifies it within containing lab. Used in resource URIs. Required.
$filter	string	The filter to apply to the operation. Default value is None.

SELECT examples

get

Get a lab user. Returns the properties of a lab user.

SELECT
id,
name,
additionalUsageQuota,
displayName,
email,
invitationSent,
invitationState,
provisioningState,
registrationState,
systemData,
totalUsage,
type
FROM azure_extras.lab_services.users
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
;

list_by_lab

Get all users for a lab. Returns a list of all users for a lab.

SELECT
id,
name,
additionalUsageQuota,
displayName,
email,
invitationSent,
invitationState,
provisioningState,
registrationState,
systemData,
totalUsage,
type
FROM azure_extras.lab_services.users
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND lab_name = '{{ lab_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Create or update a lab user. Operation to create or update a lab user.

INSERT INTO azure_extras.lab_services.users (
properties,
resource_group_name,
lab_name,
user_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ lab_name }}',
'{{ user_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
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: user_name
    value: "{{ user_name }}"
    description: Required parameter for the users resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the users resource.
  - name: properties
    value:
      additionalUsageQuota: "{{ additionalUsageQuota }}"
      email: "{{ email }}"

UPDATE examples

update

Update a lab user. Operation to update a lab user.

UPDATE azure_extras.lab_services.users
SET 
properties = '{{ properties }}'
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
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update a lab user. Operation to create or update a lab user.

REPLACE azure_extras.lab_services.users
SET 
properties = '{{ properties }}'
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 properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a user resource. Operation to delete a user resource.

DELETE FROM azure_extras.lab_services.users
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
;

Lifecycle Methods

invite

Invite a user to a lab. Operation to invite a user to a lab.

EXEC azure_extras.lab_services.users.invite 
@resource_group_name='{{ resource_group_name }}' --required, 
@lab_name='{{ lab_name }}' --required, 
@user_name='{{ user_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"text": "{{ text }}"
}'
;