student_labs
Creates, updates, deletes, gets or lists a student_labs resource.
Overview
| Name | student_labs |
| Type | Resource |
| Id | azure_extras.education.student_labs |
Fields
The following fields are returned by SELECT queries:
- get
- list_all
| 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. |
budget | object | Student Budget. |
description | string | Detail description of this lab. |
displayName | string | Student lab Display Name. |
effectiveDate | string (date-time) | User Added Date. |
expirationDate | string (date-time) | Date the lab will expire and by default will be the expiration date for each student in this lab. |
labScope | string | Lab Scope. /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default. |
role | string | Student Role. Known values are: "Student" and "Admin". (Student, Admin) |
status | string | Student Lab Status. Known values are: "Active", "Disabled", "Expired", "Pending", and "Deleted". (Active, Disabled, Expired, Pending, Deleted) |
subscriptionId | string | Subscription Id. |
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". |
| 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. |
budget | object | Student Budget. |
description | string | Detail description of this lab. |
displayName | string | Student lab Display Name. |
effectiveDate | string (date-time) | User Added Date. |
expirationDate | string (date-time) | Date the lab will expire and by default will be the expiration date for each student in this lab. |
labScope | string | Lab Scope. /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default. |
role | string | Student Role. Known values are: "Student" and "Admin". (Student, Admin) |
status | string | Student Lab Status. Known values are: "Active", "Disabled", "Expired", "Pending", and "Deleted". (Active, Disabled, Expired, Pending, Deleted) |
subscriptionId | string | Subscription Id. |
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 | student_lab_name | Get the details for a specified lab associated with the student lab. | |
list_all | select | Get 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.
| Name | Datatype | Description |
|---|---|---|
student_lab_name | string | The ID that uniquely identifies a student lab. Required. |
SELECT examples
- get
- list_all
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
;
Get a list of all labs associated with the caller of the API.
SELECT
id,
name,
budget,
description,
displayName,
effectiveDate,
expirationDate,
labScope,
role,
status,
subscriptionId,
systemData,
type
FROM azure_extras.education.student_labs
;