labs

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

Overview

Name	labs
Type	Resource
Id	azure.lab_services.labs

Fields

The following fields are returned by SELECT queries:

get

The request was successful; response contains the Lab.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Lab resource properties
systemData	object	Metadata pertaining to creation and last modification of the lab.
tags	object	Resource tags.

list_by_resource_group

The request was successful; response contains all Labs for the given subscription and resource group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Lab resource properties
systemData	object	Metadata pertaining to creation and last modification of the lab.
tags	object	Resource tags.

list_by_subscription

The request was successful; response contains all Labs for the given subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Lab resource properties
systemData	object	Metadata pertaining to creation and last modification of the lab.
tags	object	Resource tags.

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 resource.
list_by_resource_group	select			Returns a list of all labs in a resource group.
list_by_subscription	select			Returns a list of all labs for a subscription.
create_or_update	insert	data__properties		Operation to create or update a lab resource.
update	update			Operation to update a lab resource.
delete	delete			Operation to delete a lab resource.
publish	exec			Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.
sync_group	exec			Action used to manually kick off an AAD group sync job.

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 resource.

SELECT
location,
properties,
systemData,
tags
FROM azure.lab_services.labs
;

list_by_resource_group

Returns a list of all labs in a resource group.

SELECT
location,
properties,
systemData,
tags
FROM azure.lab_services.labs
;

list_by_subscription

Returns a list of all labs for a subscription.

SELECT
location,
properties,
systemData,
tags
FROM azure.lab_services.labs
;

INSERT examples

create_or_update

Operation to create or update a lab resource.

INSERT INTO azure.lab_services.labs (
data__tags,
data__location,
data__properties
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}' /* required */
RETURNING
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: labs
  props:
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Lab resource properties

UPDATE examples

update

Operation to update a lab resource.

UPDATE azure.lab_services.labs
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
RETURNING
location,
properties,
systemData,
tags;

DELETE examples

delete

Operation to delete a lab resource.

DELETE FROM azure.lab_services.labs
;

Lifecycle Methods

publish

Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.

EXEC azure.lab_services.labs.publish 

;

sync_group

Action used to manually kick off an AAD group sync job.

EXEC azure.lab_services.labs.sync_group 

;