Package com.azure.resourcemanager.labservices.fluent

Interface LabsClient

public interface LabsClient

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

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<LabInner>,LabInner>	beginCreateOrUpdate(String resourceGroupName, String labName, LabInner body)	Operation to create or update a lab resource.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<LabInner>,LabInner>	beginCreateOrUpdate(String resourceGroupName, String labName, LabInner body, com.azure.core.util.Context context)	Operation to create or update a lab resource.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String labName)	Operation to delete a lab resource.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String labName, com.azure.core.util.Context context)	Operation to delete a lab resource.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginPublish(String resourceGroupName, String labName)	Publish or re-publish a lab.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginPublish(String resourceGroupName, String labName, com.azure.core.util.Context context)	Publish or re-publish a lab.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginSyncGroup(String resourceGroupName, String labName)	Action used to manually kick off an AAD group sync job.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginSyncGroup(String resourceGroupName, String labName, com.azure.core.util.Context context)	Action used to manually kick off an AAD group sync job.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<LabInner>,LabInner>	beginUpdate(String resourceGroupName, String labName, LabUpdate body)	Operation to update a lab resource.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<LabInner>,LabInner>	beginUpdate(String resourceGroupName, String labName, LabUpdate body, com.azure.core.util.Context context)	Operation to update a lab resource.
LabInner	createOrUpdate(String resourceGroupName, String labName, LabInner body)	Operation to create or update a lab resource.
LabInner	createOrUpdate(String resourceGroupName, String labName, LabInner body, com.azure.core.util.Context context)	Operation to create or update a lab resource.
void	delete(String resourceGroupName, String labName)	Operation to delete a lab resource.
void	delete(String resourceGroupName, String labName, com.azure.core.util.Context context)	Operation to delete a lab resource.
LabInner	getByResourceGroup(String resourceGroupName, String labName)	Returns the properties of a lab resource.
com.azure.core.http.rest.Response<LabInner>	getByResourceGroupWithResponse(String resourceGroupName, String labName, com.azure.core.util.Context context)	Returns the properties of a lab resource.
com.azure.core.http.rest.PagedIterable<LabInner>	list()	Returns a list of all labs for a subscription.
com.azure.core.http.rest.PagedIterable<LabInner>	list(String filter, com.azure.core.util.Context context)	Returns a list of all labs for a subscription.
com.azure.core.http.rest.PagedIterable<LabInner>	listByResourceGroup(String resourceGroupName)	Returns a list of all labs in a resource group.
com.azure.core.http.rest.PagedIterable<LabInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Returns a list of all labs in a resource group.
void	publish(String resourceGroupName, String labName)	Publish or re-publish a lab.
void	publish(String resourceGroupName, String labName, com.azure.core.util.Context context)	Publish or re-publish a lab.
void	syncGroup(String resourceGroupName, String labName)	Action used to manually kick off an AAD group sync job.
void	syncGroup(String resourceGroupName, String labName, com.azure.core.util.Context context)	Action used to manually kick off an AAD group sync job.
LabInner	update(String resourceGroupName, String labName, LabUpdate body)	Operation to update a lab resource.
LabInner	update(String resourceGroupName, String labName, LabUpdate body, com.azure.core.util.Context context)	Operation to update a lab resource.

Method Detail

list

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

Returns a list of all labs for a subscription.

Returns:

paged list of labs.

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<LabInner> list(String filter,
                                                      com.azure.core.util.Context context)

Returns a list of all labs for a subscription.

Parameters:

filter - The filter to apply to the operation.

context - The context to associate with this operation.

Returns:

paged list of labs.

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<LabInner> listByResourceGroup(String resourceGroupName)

Returns a list of all labs in a resource group.

Parameters:

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

Returns:

paged list of labs.

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<LabInner> listByResourceGroup(String resourceGroupName,
                                                                     com.azure.core.util.Context context)

Returns a list of all labs in a 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 labs.

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

LabInner getByResourceGroup(String resourceGroupName,
                            String labName)

Returns the properties of a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

Returns:

the lab resource.

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<LabInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                           String labName,
                                                                           com.azure.core.util.Context context)

Returns the properties of a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

context - The context to associate with this operation.

Returns:

the lab resource 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<LabInner>,LabInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                  String labName,
                                                                                                                                  LabInner body)

Operation to create or update a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

body - The request body.

Returns:

the lab resource 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<LabInner>,LabInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                  String labName,
                                                                                                                                  LabInner body,
                                                                                                                                  com.azure.core.util.Context context)

Operation to create or update a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

body - The request body.

context - The context to associate with this operation.

Returns:

the lab resource 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

LabInner createOrUpdate(String resourceGroupName,
                        String labName,
                        LabInner body)

Operation to create or update a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

body - The request body.

Returns:

the lab resource.

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

LabInner createOrUpdate(String resourceGroupName,
                        String labName,
                        LabInner body,
                        com.azure.core.util.Context context)

Operation to create or update a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

body - The request body.

context - The context to associate with this operation.

Returns:

the lab resource.

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<LabInner>,LabInner> beginUpdate(String resourceGroupName,
                                                                                                                          String labName,
                                                                                                                          LabUpdate body)

Operation to update a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

body - The request body.

Returns:

the lab resource 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<LabInner>,LabInner> beginUpdate(String resourceGroupName,
                                                                                                                          String labName,
                                                                                                                          LabUpdate body,
                                                                                                                          com.azure.core.util.Context context)

Operation to update a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

body - The request body.

context - The context to associate with this operation.

Returns:

the lab resource 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

LabInner update(String resourceGroupName,
                String labName,
                LabUpdate body)

Operation to update a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

body - The request body.

Returns:

the lab resource.

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

LabInner update(String resourceGroupName,
                String labName,
                LabUpdate body,
                com.azure.core.util.Context context)

Operation to update a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

body - The request body.

context - The context to associate with this operation.

Returns:

the lab resource.

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 labName)

Operation to delete a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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 labName,
                                                                                                                  com.azure.core.util.Context context)

Operation to delete a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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 labName)

Operation to delete a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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 labName,
            com.azure.core.util.Context context)

Operation to delete a lab resource.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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.

beginPublish

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

Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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.

beginPublish

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

Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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.

publish

void publish(String resourceGroupName,
             String labName)

Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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.

publish

void publish(String resourceGroupName,
             String labName,
             com.azure.core.util.Context context)

Publish or re-publish a lab. This will create or update all lab resources, such as virtual machines.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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.

beginSyncGroup

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

Action used to manually kick off an AAD group sync job.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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.

beginSyncGroup

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

Action used to manually kick off an AAD group sync job.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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.

syncGroup

void syncGroup(String resourceGroupName,
               String labName)

Action used to manually kick off an AAD group sync job.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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.

syncGroup

void syncGroup(String resourceGroupName,
               String labName,
               com.azure.core.util.Context context)

Action used to manually kick off an AAD group sync job.

Parameters:

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

labName - The name of the lab that uniquely identifies it within containing lab account. Used in resource URIs.

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.