lab_plans

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

Overview

Name	lab_plans
Type	Resource
Id	azure.lab_services.lab_plans

Fields

The following fields are returned by SELECT queries:

get

The request was successful; response contains the Lab Plan.

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

list_by_resource_group

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

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

list_by_subscription

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

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Retrieves the properties of a Lab Plan.
list_by_resource_group	select			Returns a list of all lab plans for a subscription and resource group.
list_by_subscription	select			Returns a list of all lab plans within a subscription
create_or_update	insert	data__properties		Operation to create or update a Lab Plan resource.
update	update			Operation to update a Lab Plan resource.
delete	delete			Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container.
save_image	exec			Saves an image from a lab VM to the attached shared image gallery.

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

Retrieves the properties of a Lab Plan.

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.lab_services.lab_plans
;

list_by_resource_group

Returns a list of all lab plans for a subscription and resource group.

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.lab_services.lab_plans
;

list_by_subscription

Returns a list of all lab plans within a subscription

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.lab_services.lab_plans
;

INSERT examples

create_or_update

Operation to create or update a Lab Plan resource.

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

Manifest

# Description fields are for documentation purposes
- name: lab_plans
  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 plan resource properties
    - name: identity
      value: object
      description: |
        Identity for the resource.

UPDATE examples

update

Operation to update a Lab Plan resource.

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

DELETE examples

delete

Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container.

DELETE FROM azure.lab_services.lab_plans
;

Lifecycle Methods

save_image

Saves an image from a lab VM to the attached shared image gallery.

EXEC azure.lab_services.lab_plans.save_image 
@@json=
'{
"name": "{{ name }}", 
"labVirtualMachineId": "{{ labVirtualMachineId }}"
}'
;