LabsOperations interface

Interface representing a Labs operations.

Properties

createOrUpdate

Create a new lab or update a previously created lab.

delete

Delete a specific lab associated with the provided billing account name, billing profile name, and invoice section name. Note all students must be removed from the lab in order to delete the lab.

generateInviteCode

Generate invite code for a lab

get

Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.

list

Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.

listAll

Get a list of labs associated with the provided billing account name and billing profile name.

Property Details

createOrUpdate

Create a new lab or update a previously created lab.

createOrUpdate: (billingAccountName: string, billingProfileName: string, invoiceSectionName: string, parameters: LabDetails, options?: LabsCreateOrUpdateOptionalParams) => Promise<LabDetails>

Property Value

(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, parameters: LabDetails, options?: LabsCreateOrUpdateOptionalParams) => Promise<LabDetails>

delete

Delete a specific lab associated with the provided billing account name, billing profile name, and invoice section name. Note all students must be removed from the lab in order to delete the lab.

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

Property Value

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

generateInviteCode

Generate invite code for a lab

generateInviteCode: (billingAccountName: string, billingProfileName: string, invoiceSectionName: string, parameters: InviteCodeGenerateRequest, options?: LabsGenerateInviteCodeOptionalParams) => Promise<LabDetails>

Property Value

(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, parameters: InviteCodeGenerateRequest, options?: LabsGenerateInviteCodeOptionalParams) => Promise<LabDetails>

get

Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.

get: (billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: LabsGetOptionalParams) => Promise<LabDetails>

Property Value

(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: LabsGetOptionalParams) => Promise<LabDetails>

list

Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.

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

Property Value

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

listAll

Get a list of labs associated with the provided billing account name and billing profile name.

listAll: (billingAccountName: string, billingProfileName: string, options?: LabsListAllOptionalParams) => PagedAsyncIterableIterator<LabDetails, LabDetails[], PageSettings>

Property Value

(billingAccountName: string, billingProfileName: string, options?: LabsListAllOptionalParams) => PagedAsyncIterableIterator<LabDetails, LabDetails[], PageSettings>