Students interface
Interface representing a Students.
Methods
| create |
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(string, string, string, string, Students |
Delete the specified student based on the student alias. |
| get(string, string, string, string, Students |
Get the details for a specific student in the specified lab by student alias |
| list(string, string, string, Students |
Get a list of details about students that are associated with the specified lab. |
Method Details
createOrUpdate(string, string, string, string, StudentDetails, StudentsCreateOrUpdateOptionalParams)
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.
function createOrUpdate(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, parameters: StudentDetails, options?: StudentsCreateOrUpdateOptionalParams): Promise<StudentDetails>Parameters
- billingAccountName
-
string
Billing account name.
- billingProfileName
-
string
Billing profile name.
- invoiceSectionName
-
string
Invoice section name.
- studentAlias
-
string
Student alias.
- parameters
- StudentDetails
Request parameters that are provided to update student properties.
The options parameters.
Returns
Promise<StudentDetails>
delete(string, string, string, string, StudentsDeleteOptionalParams)
Delete the specified student based on the student alias.
function delete(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, options?: StudentsDeleteOptionalParams): Promise<void>Parameters
- billingAccountName
-
string
Billing account name.
- billingProfileName
-
string
Billing profile name.
- invoiceSectionName
-
string
Invoice section name.
- studentAlias
-
string
Student alias.
- options
- StudentsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, StudentsGetOptionalParams)
Get the details for a specific student in the specified lab by student alias
function get(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, options?: StudentsGetOptionalParams): Promise<StudentDetails>Parameters
- billingAccountName
-
string
Billing account name.
- billingProfileName
-
string
Billing profile name.
- invoiceSectionName
-
string
Invoice section name.
- studentAlias
-
string
Student alias.
- options
- StudentsGetOptionalParams
The options parameters.
Returns
Promise<StudentDetails>
list(string, string, string, StudentsListOptionalParams)
Get a list of details about students that are associated with the specified lab.
function list(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: StudentsListOptionalParams): PagedAsyncIterableIterator<StudentDetails, StudentDetails[], PageSettings>Parameters
- billingAccountName
-
string
Billing account name.
- billingProfileName
-
string
Billing profile name.
- invoiceSectionName
-
string
Invoice section name.
- options
- StudentsListOptionalParams
The options parameters.
Returns
Azure SDK for JavaScript