LabPlans interface
Interface representing a LabPlans.
Methods
| begin |
Operation to create or update a Lab Plan resource. |
| begin |
Operation to create or update a Lab Plan resource. |
| begin |
Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container. |
| begin |
Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container. |
| begin |
Saves an image from a lab VM to the attached shared image gallery. |
| begin |
Saves an image from a lab VM to the attached shared image gallery. |
| begin |
Operation to update a Lab Plan resource. |
| begin |
Operation to update a Lab Plan resource. |
| get(string, string, Lab |
Retrieves the properties of a Lab Plan. |
| list |
Returns a list of all lab plans for a subscription and resource group. |
| list |
Returns a list of all lab plans within a subscription |
Method Details
beginCreateOrUpdate(string, string, LabPlan, LabPlansCreateOrUpdateOptionalParams)
Operation to create or update a Lab Plan resource.
function beginCreateOrUpdate(resourceGroupName: string, labPlanName: string, body: LabPlan, options?: LabPlansCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<LabPlan>, LabPlan>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labPlanName
-
string
The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
- body
- LabPlan
The request body.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<LabPlan>, LabPlan>>
beginCreateOrUpdateAndWait(string, string, LabPlan, LabPlansCreateOrUpdateOptionalParams)
Operation to create or update a Lab Plan resource.
function beginCreateOrUpdateAndWait(resourceGroupName: string, labPlanName: string, body: LabPlan, options?: LabPlansCreateOrUpdateOptionalParams): Promise<LabPlan>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labPlanName
-
string
The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
- body
- LabPlan
The request body.
The options parameters.
Returns
Promise<LabPlan>
beginDelete(string, string, LabPlansDeleteOptionalParams)
Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container.
function beginDelete(resourceGroupName: string, labPlanName: string, options?: LabPlansDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labPlanName
-
string
The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
- options
- LabPlansDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, LabPlansDeleteOptionalParams)
Operation to delete a Lab Plan resource. Deleting a lab plan does not delete labs associated with a lab plan, nor does it delete shared images added to a gallery via the lab plan permission container.
function beginDeleteAndWait(resourceGroupName: string, labPlanName: string, options?: LabPlansDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labPlanName
-
string
The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
- options
- LabPlansDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginSaveImage(string, string, SaveImageBody, LabPlansSaveImageOptionalParams)
Saves an image from a lab VM to the attached shared image gallery.
function beginSaveImage(resourceGroupName: string, labPlanName: string, body: SaveImageBody, options?: LabPlansSaveImageOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labPlanName
-
string
The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
- body
- SaveImageBody
The request body.
- options
- LabPlansSaveImageOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginSaveImageAndWait(string, string, SaveImageBody, LabPlansSaveImageOptionalParams)
Saves an image from a lab VM to the attached shared image gallery.
function beginSaveImageAndWait(resourceGroupName: string, labPlanName: string, body: SaveImageBody, options?: LabPlansSaveImageOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labPlanName
-
string
The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
- body
- SaveImageBody
The request body.
- options
- LabPlansSaveImageOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, LabPlanUpdate, LabPlansUpdateOptionalParams)
Operation to update a Lab Plan resource.
function beginUpdate(resourceGroupName: string, labPlanName: string, body: LabPlanUpdate, options?: LabPlansUpdateOptionalParams): Promise<PollerLike<PollOperationState<LabPlan>, LabPlan>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labPlanName
-
string
The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
- body
- LabPlanUpdate
The request body.
- options
- LabPlansUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<LabPlan>, LabPlan>>
beginUpdateAndWait(string, string, LabPlanUpdate, LabPlansUpdateOptionalParams)
Operation to update a Lab Plan resource.
function beginUpdateAndWait(resourceGroupName: string, labPlanName: string, body: LabPlanUpdate, options?: LabPlansUpdateOptionalParams): Promise<LabPlan>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labPlanName
-
string
The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
- body
- LabPlanUpdate
The request body.
- options
- LabPlansUpdateOptionalParams
The options parameters.
Returns
Promise<LabPlan>
get(string, string, LabPlansGetOptionalParams)
Retrieves the properties of a Lab Plan.
function get(resourceGroupName: string, labPlanName: string, options?: LabPlansGetOptionalParams): Promise<LabPlan>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labPlanName
-
string
The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
- options
- LabPlansGetOptionalParams
The options parameters.
Returns
Promise<LabPlan>
listByResourceGroup(string, LabPlansListByResourceGroupOptionalParams)
Returns a list of all lab plans for a subscription and resource group.
function listByResourceGroup(resourceGroupName: string, options?: LabPlansListByResourceGroupOptionalParams): PagedAsyncIterableIterator<LabPlan, LabPlan[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(LabPlansListBySubscriptionOptionalParams)
Returns a list of all lab plans within a subscription
function listBySubscription(options?: LabPlansListBySubscriptionOptionalParams): PagedAsyncIterableIterator<LabPlan, LabPlan[], PageSettings>Parameters
The options parameters.