StudentsOperations interface

Interface representing a Students operations.

Properties

createOrUpdate

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 the specified student based on the student alias.

get

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

list

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

Property Details

createOrUpdate

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.

createOrUpdate: (billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, parameters: StudentDetails, options?: StudentsCreateOrUpdateOptionalParams) => Promise<StudentDetails>

Property Value

(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, parameters: StudentDetails, options?: StudentsCreateOrUpdateOptionalParams) => Promise<StudentDetails>

delete

Delete the specified student based on the student alias.

delete: (billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, options?: StudentsDeleteOptionalParams) => Promise<void>

Property Value

(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, options?: StudentsDeleteOptionalParams) => Promise<void>

get

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

get: (billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, options?: StudentsGetOptionalParams) => Promise<StudentDetails>

Property Value

(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, studentAlias: string, options?: StudentsGetOptionalParams) => Promise<StudentDetails>

list

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

list: (billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: StudentsListOptionalParams) => PagedAsyncIterableIterator<StudentDetails, StudentDetails[], PageSettings>

Property Value

(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: StudentsListOptionalParams) => PagedAsyncIterableIterator<StudentDetails, StudentDetails[], PageSettings>