LabPlans Interface

Package:

com.azure.resourcemanager.labservices.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-labservices:1.0.0

public interface LabPlans

Resource collection API of LabPlans.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new LabPlan resource.
abstract void	delete(String resourceGroupName, String labPlanName, Context context) Deletes a Lab Plan resource.
abstract void	deleteById(String id) Deletes a Lab Plan resource.
abstract void	deleteByIdWithResponse(String id, Context context) Deletes a Lab Plan resource.
abstract void	deleteByResourceGroup(String resourceGroupName, String labPlanName) Deletes a Lab Plan resource.
abstract LabPlan	getById(String id) Retrieves a Lab Plan resource.
abstract Response<LabPlan>	getByIdWithResponse(String id, Context context) Retrieves a Lab Plan resource.
abstract LabPlan	getByResourceGroup(String resourceGroupName, String labPlanName) Retrieves a Lab Plan resource.
abstract Response<LabPlan>	getByResourceGroupWithResponse(String resourceGroupName, String labPlanName, Context context) Retrieves a Lab Plan resource.
abstract PagedIterable<LabPlan>	list() Get all lab plans for a subscription.
abstract PagedIterable<LabPlan>	list(String filter, Context context) Get all lab plans for a subscription.
abstract PagedIterable<LabPlan>	listByResourceGroup(String resourceGroupName) Get all lab plans for a subscription and resource group.
abstract PagedIterable<LabPlan>	listByResourceGroup(String resourceGroupName, Context context) Get all lab plans for a subscription and resource group.
abstract void	saveImage(String resourceGroupName, String labPlanName, SaveImageBody body) Save an image from a lab VM to the attached shared image gallery.
abstract void	saveImage(String resourceGroupName, String labPlanName, SaveImageBody body, Context context) Save an image from a lab VM to the attached shared image gallery.

Method Details

define

public abstract LabPlan.DefinitionStages.Blank define(String name)

Begins definition for a new LabPlan resource.

Parameters:

name - resource name.

Returns:

the first stage of the new LabPlan definition.

delete

public abstract void delete(String resourceGroupName, String labPlanName, Context context)

Deletes a Lab Plan resource. 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Deletes a Lab Plan resource. 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.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes a Lab Plan resource. 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.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String labPlanName)

Deletes a Lab Plan resource. 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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.

getById

public abstract LabPlan getById(String id)

Retrieves a Lab Plan resource. Retrieves the properties of a Lab Plan.

Parameters:

id - the resource ID.

Returns:

lab Plans act as a permission container for creating labs via labs.azure.com along with Response<T>.

getByIdWithResponse

public abstract Response<LabPlan> getByIdWithResponse(String id, Context context)

Retrieves a Lab Plan resource. Retrieves the properties of a Lab Plan.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

lab Plans act as a permission container for creating labs via labs.azure.com along with Response<T>.

getByResourceGroup

public abstract LabPlan getByResourceGroup(String resourceGroupName, String labPlanName)

Retrieves a Lab Plan resource. Retrieves the properties of a Lab Plan.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.

Returns:

lab Plans act as a permission container for creating labs via labs.azure.com.

getByResourceGroupWithResponse

public abstract Response<LabPlan> getByResourceGroupWithResponse(String resourceGroupName, String labPlanName, Context context)

Retrieves a Lab Plan resource. Retrieves the properties of a Lab Plan.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.

context - The context to associate with this operation.

Returns:

lab Plans act as a permission container for creating labs via labs.azure.com along with Response<T>.

list

public abstract PagedIterable<LabPlan> list()

Get all lab plans for a subscription. Returns a list of all lab plans within a subscription.

Returns:

paged list of lab plans as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<LabPlan> list(String filter, Context context)

Get all lab plans for a subscription. Returns a list of all lab plans within a subscription.

Parameters:

filter - The filter to apply to the operation.

context - The context to associate with this operation.

Returns:

paged list of lab plans as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<LabPlan> listByResourceGroup(String resourceGroupName)

Get all lab plans for a subscription and resource group. Returns a list of all lab plans for a subscription and resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

paged list of lab plans as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<LabPlan> listByResourceGroup(String resourceGroupName, Context context)

Get all lab plans for a subscription and resource group. Returns a list of all lab plans for a subscription and resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

context - The context to associate with this operation.

Returns:

paged list of lab plans as paginated response with PagedIterable<T>.

saveImage

public abstract void saveImage(String resourceGroupName, String labPlanName, SaveImageBody body)

Save an image from a lab VM to the attached shared image gallery. Saves an image from a lab VM to the attached shared image gallery.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.

body - The request body.

saveImage

public abstract void saveImage(String resourceGroupName, String labPlanName, SaveImageBody body, Context context)

Save an image from a lab VM to the attached shared image gallery. Saves an image from a lab VM to the attached shared image gallery.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

labPlanName - The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.

body - The request body.

context - The context to associate with this operation.