Skip to main content

student_labs

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

Overview

Namestudent_labs
TypeResource
Idazure_extras.education.student_labs

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
budgetobjectStudent Budget.
descriptionstringDetail description of this lab.
displayNamestringStudent lab Display Name.
effectiveDatestring (date-time)User Added Date.
expirationDatestring (date-time)Date the lab will expire and by default will be the expiration date for each student in this lab.
labScopestringLab Scope. /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default.
rolestringStudent Role. Known values are: "Student" and "Admin". (Student, Admin)
statusstringStudent Lab Status. Known values are: "Active", "Disabled", "Expired", "Pending", and "Deleted". (Active, Disabled, Expired, Pending, Deleted)
subscriptionIdstringSubscription Id.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectstudent_lab_nameGet the details for a specified lab associated with the student lab.
list_allselectGet a list of all labs associated with the caller of the API.

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.

NameDatatypeDescription
student_lab_namestringThe ID that uniquely identifies a student lab. Required.

SELECT examples

Get the details for a specified lab associated with the student lab.

SELECT
id,
name,
budget,
description,
displayName,
effectiveDate,
expirationDate,
labScope,
role,
status,
subscriptionId,
systemData,
type
FROM azure_extras.education.student_labs
WHERE student_lab_name = '{{ student_lab_name }}' -- required
;