Package com.azure.resourcemanager.labservices.fluent

Interface LabPlansClient

public interface LabPlansClient

An instance of this class provides access to all the operations defined in LabPlansClient.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<LabPlanInner>,LabPlanInner>	beginCreateOrUpdate(String resourceGroupName, String labPlanName, LabPlanInner body)	Operation to create or update a Lab Plan resource.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<LabPlanInner>,LabPlanInner>	beginCreateOrUpdate(String resourceGroupName, String labPlanName, LabPlanInner body, com.azure.core.util.Context context)	Operation to create or update a Lab Plan resource.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String labPlanName)	Operation to delete a Lab Plan resource.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String labPlanName, com.azure.core.util.Context context)	Operation to delete a Lab Plan resource.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginSaveImage(String resourceGroupName, String labPlanName, SaveImageBody body)	Saves an image from a lab VM to the attached shared image gallery.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginSaveImage(String resourceGroupName, String labPlanName, SaveImageBody body, com.azure.core.util.Context context)	Saves an image from a lab VM to the attached shared image gallery.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<LabPlanInner>,LabPlanInner>	beginUpdate(String resourceGroupName, String labPlanName, LabPlanUpdate body)	Operation to update a Lab Plan resource.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<LabPlanInner>,LabPlanInner>	beginUpdate(String resourceGroupName, String labPlanName, LabPlanUpdate body, com.azure.core.util.Context context)	Operation to update a Lab Plan resource.
LabPlanInner	createOrUpdate(String resourceGroupName, String labPlanName, LabPlanInner body)	Operation to create or update a Lab Plan resource.
LabPlanInner	createOrUpdate(String resourceGroupName, String labPlanName, LabPlanInner body, com.azure.core.util.Context context)	Operation to create or update a Lab Plan resource.
void	delete(String resourceGroupName, String labPlanName)	Operation to delete a Lab Plan resource.
void	delete(String resourceGroupName, String labPlanName, com.azure.core.util.Context context)	Operation to delete a Lab Plan resource.
LabPlanInner	getByResourceGroup(String resourceGroupName, String labPlanName)	Retrieves the properties of a Lab Plan.
com.azure.core.http.rest.Response<LabPlanInner>	getByResourceGroupWithResponse(String resourceGroupName, String labPlanName, com.azure.core.util.Context context)	Retrieves the properties of a Lab Plan.
com.azure.core.http.rest.PagedIterable<LabPlanInner>	list()	Returns a list of all lab plans within a subscription.
com.azure.core.http.rest.PagedIterable<LabPlanInner>	list(String filter, com.azure.core.util.Context context)	Returns a list of all lab plans within a subscription.
com.azure.core.http.rest.PagedIterable<LabPlanInner>	listByResourceGroup(String resourceGroupName)	Returns a list of all lab plans for a subscription and resource group.
com.azure.core.http.rest.PagedIterable<LabPlanInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Returns a list of all lab plans for a subscription and resource group.
void	saveImage(String resourceGroupName, String labPlanName, SaveImageBody body)	Saves an image from a lab VM to the attached shared image gallery.
void	saveImage(String resourceGroupName, String labPlanName, SaveImageBody body, com.azure.core.util.Context context)	Saves an image from a lab VM to the attached shared image gallery.
LabPlanInner	update(String resourceGroupName, String labPlanName, LabPlanUpdate body)	Operation to update a Lab Plan resource.
LabPlanInner	update(String resourceGroupName, String labPlanName, LabPlanUpdate body, com.azure.core.util.Context context)	Operation to update a Lab Plan resource.

Method Detail

list

com.azure.core.http.rest.PagedIterable<LabPlanInner> list()

Returns a list of all lab plans within a subscription.

Returns:

paged list of lab plans.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<LabPlanInner> list(String filter,
                                                          com.azure.core.util.Context context)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<LabPlanInner> listByResourceGroup(String resourceGroupName)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<LabPlanInner> listByResourceGroup(String resourceGroupName,
                                                                         com.azure.core.util.Context context)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroup

LabPlanInner getByResourceGroup(String resourceGroupName,
                                String labPlanName)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<LabPlanInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                               String labPlanName,
                                                                               com.azure.core.util.Context context)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<LabPlanInner>,LabPlanInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                          String labPlanName,
                                                                                                                                          LabPlanInner body)

Operation to create or update a Lab Plan resource.

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.

Returns:

lab Plans act as a permission container for creating labs via labs.azure.com along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<LabPlanInner>,LabPlanInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                          String labPlanName,
                                                                                                                                          LabPlanInner body,
                                                                                                                                          com.azure.core.util.Context context)

Operation to create or update a Lab Plan resource.

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.

Returns:

lab Plans act as a permission container for creating labs via labs.azure.com along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

LabPlanInner createOrUpdate(String resourceGroupName,
                            String labPlanName,
                            LabPlanInner body)

Operation to create or update a Lab Plan resource.

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.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

LabPlanInner createOrUpdate(String resourceGroupName,
                            String labPlanName,
                            LabPlanInner body,
                            com.azure.core.util.Context context)

Operation to create or update a Lab Plan resource.

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.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<LabPlanInner>,LabPlanInner> beginUpdate(String resourceGroupName,
                                                                                                                                  String labPlanName,
                                                                                                                                  LabPlanUpdate body)

Operation to update a Lab Plan resource.

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.

Returns:

lab Plans act as a permission container for creating labs via labs.azure.com along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<LabPlanInner>,LabPlanInner> beginUpdate(String resourceGroupName,
                                                                                                                                  String labPlanName,
                                                                                                                                  LabPlanUpdate body,
                                                                                                                                  com.azure.core.util.Context context)

Operation to update a Lab Plan resource.

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.

Returns:

lab Plans act as a permission container for creating labs via labs.azure.com along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

LabPlanInner update(String resourceGroupName,
                    String labPlanName,
                    LabPlanUpdate body)

Operation to update a Lab Plan resource.

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.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

LabPlanInner update(String resourceGroupName,
                    String labPlanName,
                    LabPlanUpdate body,
                    com.azure.core.util.Context context)

Operation to update a Lab Plan resource.

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.

Returns:

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName,
                                                                                                                  String labPlanName)

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.

Returns:

the Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName,
                                                                                                                  String labPlanName,
                                                                                                                  com.azure.core.util.Context context)

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.

Returns:

the Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String labPlanName)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String labPlanName,
            com.azure.core.util.Context context)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginSaveImage

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginSaveImage(String resourceGroupName,
                                                                                                                     String labPlanName,
                                                                                                                     SaveImageBody body)

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.

Returns:

the Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginSaveImage

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginSaveImage(String resourceGroupName,
                                                                                                                     String labPlanName,
                                                                                                                     SaveImageBody body,
                                                                                                                     com.azure.core.util.Context context)

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.

Returns:

the Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

saveImage

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

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

saveImage

void saveImage(String resourceGroupName,
               String labPlanName,
               SaveImageBody body,
               com.azure.core.util.Context context)

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.