Labs interface
Interface representing a Labs.
Methods
| create |
Create a new lab or update a previously created lab. |
| delete(string, string, string, Labs |
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. |
| generate |
Generate invite code for a lab |
| get(string, string, string, Labs |
Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name. |
| list(string, string, string, Labs |
Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name. |
| list |
Get a list of labs associated with the provided billing account name and billing profile name. |
Method Details
createOrUpdate(string, string, string, LabDetails, LabsCreateOrUpdateOptionalParams)
Create a new lab or update a previously created lab.
function createOrUpdate(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, parameters: LabDetails, options?: LabsCreateOrUpdateOptionalParams): Promise<LabDetails>Parameters
- billingAccountName
-
string
Billing account name.
- billingProfileName
-
string
Billing profile name.
- invoiceSectionName
-
string
Invoice section name.
- parameters
- LabDetails
Request parameters that are provided to create lab resource.
- options
- LabsCreateOrUpdateOptionalParams
The options parameters.
Returns
Promise<LabDetails>
delete(string, string, string, LabsDeleteOptionalParams)
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.
function delete(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: LabsDeleteOptionalParams): Promise<void>Parameters
- billingAccountName
-
string
Billing account name.
- billingProfileName
-
string
Billing profile name.
- invoiceSectionName
-
string
Invoice section name.
- options
- LabsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
generateInviteCode(string, string, string, InviteCodeGenerateRequest, LabsGenerateInviteCodeOptionalParams)
Generate invite code for a lab
function generateInviteCode(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, parameters: InviteCodeGenerateRequest, options?: LabsGenerateInviteCodeOptionalParams): Promise<LabDetails>Parameters
- billingAccountName
-
string
Billing account name.
- billingProfileName
-
string
Billing profile name.
- invoiceSectionName
-
string
Invoice section name.
- parameters
- InviteCodeGenerateRequest
Request parameters that are provided to generate invite code.
The options parameters.
Returns
Promise<LabDetails>
get(string, string, string, LabsGetOptionalParams)
Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
function get(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: LabsGetOptionalParams): Promise<LabDetails>Parameters
- billingAccountName
-
string
Billing account name.
- billingProfileName
-
string
Billing profile name.
- invoiceSectionName
-
string
Invoice section name.
- options
- LabsGetOptionalParams
The options parameters.
Returns
Promise<LabDetails>
list(string, string, string, LabsListOptionalParams)
Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
function list(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: LabsListOptionalParams): PagedAsyncIterableIterator<LabDetails, LabDetails[], PageSettings>Parameters
- billingAccountName
-
string
Billing account name.
- billingProfileName
-
string
Billing profile name.
- invoiceSectionName
-
string
Invoice section name.
- options
- LabsListOptionalParams
The options parameters.
Returns
listAll(string, string, LabsListAllOptionalParams)
Get a list of labs associated with the provided billing account name and billing profile name.
function listAll(billingAccountName: string, billingProfileName: string, options?: LabsListAllOptionalParams): PagedAsyncIterableIterator<LabDetails, LabDetails[], PageSettings>Parameters
- billingAccountName
-
string
Billing account name.
- billingProfileName
-
string
Billing profile name.
- options
- LabsListAllOptionalParams
The options parameters.
Returns
Azure SDK for JavaScript