labs

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

Overview

Name	labs
Type	Resource
Id	azure_extras.education.labs

Fields

The following fields are returned by SELECT queries:

list

Lab details.

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
properties	object	Get lab response properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

get

Lab details.

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
properties	object	Get lab response properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_all

Lab details.

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
properties	object	Get lab response properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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
list	select	billingAccountName, billingProfileName, invoiceSectionName	includeBudget	Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
get	select	billingAccountName, billingProfileName, invoiceSectionName	includeBudget	Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
list_all	select	billingAccountName, billingProfileName	includeBudget, includeDeleted	Get a list of labs associated with the provided billing account name and billing profile name.
create_or_update	insert	billingAccountName, billingProfileName, invoiceSectionName		Create a new lab or update a previously created lab.
delete	delete	billingAccountName, billingProfileName, invoiceSectionName		Delete a specific lab associated with the provided billing account name, billing profile name, and invoice section name. Note all students must be removed from the lab in order to delete the lab.
generate_invite_code	exec	billingAccountName, billingProfileName, invoiceSectionName	onlyUpdateStudentCountParameter	Generate invite code for 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
billingAccountName	string	The ID that uniquely identifies a billing account.
billingProfileName	string	The ID that uniquely identifies a billing profile.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.
includeBudget	boolean	May be used to include budget information.
includeDeleted	boolean	May be used to show deleted items.
onlyUpdateStudentCountParameter	boolean	set this flag to true if you want to update student count without generating a new invite code

SELECT examples

list

Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.

SELECT
id,
name,
properties,
systemData,
type
FROM azure_extras.education.labs
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND invoiceSectionName = '{{ invoiceSectionName }}' -- required
AND includeBudget = '{{ includeBudget }}'
;

get

Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.

SELECT
id,
name,
properties,
systemData,
type
FROM azure_extras.education.labs
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND invoiceSectionName = '{{ invoiceSectionName }}' -- required
AND includeBudget = '{{ includeBudget }}'
;

list_all

Get a list of labs associated with the provided billing account name and billing profile name.

SELECT
id,
name,
properties,
systemData,
type
FROM azure_extras.education.labs
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND includeBudget = '{{ includeBudget }}'
AND includeDeleted = '{{ includeDeleted }}'
;

INSERT examples

create_or_update

Create a new lab or update a previously created lab.

INSERT INTO azure_extras.education.labs (
data__properties,
billingAccountName,
billingProfileName,
invoiceSectionName
)
SELECT 
'{{ properties }}',
'{{ billingAccountName }}',
'{{ billingProfileName }}',
'{{ invoiceSectionName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: labs
  props:
    - name: billingAccountName
      value: string
      description: Required parameter for the labs resource.
    - name: billingProfileName
      value: string
      description: Required parameter for the labs resource.
    - name: invoiceSectionName
      value: string
      description: Required parameter for the labs resource.
    - name: properties
      value: object
      description: |
        Get lab response properties.

DELETE examples

delete

Delete a specific lab associated with the provided billing account name, billing profile name, and invoice section name. Note all students must be removed from the lab in order to delete the lab.

DELETE FROM azure_extras.education.labs
WHERE billingAccountName = '{{ billingAccountName }}' --required
AND billingProfileName = '{{ billingProfileName }}' --required
AND invoiceSectionName = '{{ invoiceSectionName }}' --required
;

Lifecycle Methods

generate_invite_code

Generate invite code for a lab

EXEC azure_extras.education.labs.generate_invite_code 
@billingAccountName='{{ billingAccountName }}' --required, 
@billingProfileName='{{ billingProfileName }}' --required, 
@invoiceSectionName='{{ invoiceSectionName }}' --required, 
@onlyUpdateStudentCountParameter={{ onlyUpdateStudentCountParameter }} 
@@json=
'{
"maxStudentCount": {{ maxStudentCount }}
}'
;