students

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

Overview

Name	students
Type	Resource
Id	azure_extras.education.students

Fields

The following fields are returned by SELECT queries:

get

student detail.

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 student 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

Student 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 student 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
get	select	billingAccountName, billingProfileName, invoiceSectionName, studentAlias		Get the details for a specific student in the specified lab by student alias
list	select	billingAccountName, billingProfileName, invoiceSectionName	includeDeleted	Get a list of details about students that are associated with the specified lab.
create_or_update	insert	billingAccountName, billingProfileName, invoiceSectionName, studentAlias		Create and add a new student to the specified lab or update the details of an existing student in a lab. Note the student must have a valid tenant to accept the lab after they have been added to lab.
delete	delete	billingAccountName, billingProfileName, invoiceSectionName, studentAlias		Delete the specified student based on the student alias.

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.
studentAlias	string	Student alias.
includeDeleted	boolean	May be used to show deleted items.

SELECT examples

get

Get the details for a specific student in the specified lab by student alias

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

list

Get a list of details about students that are associated with the specified lab.

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

INSERT examples

create_or_update

Create and add a new student to the specified lab or update the details of an existing student in a lab. Note the student must have a valid tenant to accept the lab after they have been added to lab.

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

Manifest

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

DELETE examples

delete

Delete the specified student based on the student alias.

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