LabsClient Interface

Package:
com.azure.resourcemanager.devtestlabs.fluent
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-devtestlabs:1.0.0-beta.2

public interface LabsClient

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

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<Void>,Void> beginClaimAnyVm(String resourceGroupName, String name)

Claim a random claimable virtual machine in the lab.
abstract SyncPoller<PollResult<Void>,Void> beginClaimAnyVm(String resourceGroupName, String name, Context context)

Claim a random claimable virtual machine in the lab.
abstract SyncPoller<PollResult<Void>,Void> beginCreateEnvironment(String resourceGroupName, String name, LabVirtualMachineCreationParameter labVirtualMachineCreationParameter)

Create virtual machines in a lab.
abstract SyncPoller<PollResult<Void>,Void> beginCreateEnvironment(String resourceGroupName, String name, LabVirtualMachineCreationParameter labVirtualMachineCreationParameter, Context context)

Create virtual machines in a lab.
abstract SyncPoller<PollResult<LabInner>,LabInner> beginCreateOrUpdate(String resourceGroupName, String name, LabInner lab)

Create or replace an existing lab.
abstract SyncPoller<PollResult<LabInner>,LabInner> beginCreateOrUpdate(String resourceGroupName, String name, LabInner lab, Context context)

Create or replace an existing lab.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String name)

Delete lab.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String name, Context context)

Delete lab.
abstract SyncPoller<PollResult<Void>,Void> beginExportResourceUsage(String resourceGroupName, String name, ExportResourceUsageParameters exportResourceUsageParameters)

Exports the lab resource usage into a storage account This operation can take a while to complete.
abstract SyncPoller<PollResult<Void>,Void> beginExportResourceUsage(String resourceGroupName, String name, ExportResourceUsageParameters exportResourceUsageParameters, Context context)

Exports the lab resource usage into a storage account This operation can take a while to complete.
abstract SyncPoller<PollResult<Void>,Void> beginImportVirtualMachine(String resourceGroupName, String name, ImportLabVirtualMachineRequest importLabVirtualMachineRequest)

Import a virtual machine into a different lab.
abstract SyncPoller<PollResult<Void>,Void> beginImportVirtualMachine(String resourceGroupName, String name, ImportLabVirtualMachineRequest importLabVirtualMachineRequest, Context context)

Import a virtual machine into a different lab.
abstract void claimAnyVm(String resourceGroupName, String name)

Claim a random claimable virtual machine in the lab.
abstract void claimAnyVm(String resourceGroupName, String name, Context context)

Claim a random claimable virtual machine in the lab.
abstract void createEnvironment(String resourceGroupName, String name, LabVirtualMachineCreationParameter labVirtualMachineCreationParameter)

Create virtual machines in a lab.
abstract void createEnvironment(String resourceGroupName, String name, LabVirtualMachineCreationParameter labVirtualMachineCreationParameter, Context context)

Create virtual machines in a lab.
abstract LabInner createOrUpdate(String resourceGroupName, String name, LabInner lab)

Create or replace an existing lab.
abstract LabInner createOrUpdate(String resourceGroupName, String name, LabInner lab, Context context)

Create or replace an existing lab.
abstract void delete(String resourceGroupName, String name)

Delete lab.
abstract void delete(String resourceGroupName, String name, Context context)

Delete lab.
abstract void exportResourceUsage(String resourceGroupName, String name, ExportResourceUsageParameters exportResourceUsageParameters)

Exports the lab resource usage into a storage account This operation can take a while to complete.
abstract void exportResourceUsage(String resourceGroupName, String name, ExportResourceUsageParameters exportResourceUsageParameters, Context context)

Exports the lab resource usage into a storage account This operation can take a while to complete.
abstract GenerateUploadUriResponseInner generateUploadUri(String resourceGroupName, String name, GenerateUploadUriParameter generateUploadUriParameter)

Generate a URI for uploading custom disk images to a Lab.
abstract Response<GenerateUploadUriResponseInner> generateUploadUriWithResponse(String resourceGroupName, String name, GenerateUploadUriParameter generateUploadUriParameter, Context context)

Generate a URI for uploading custom disk images to a Lab.
abstract LabInner getByResourceGroup(String resourceGroupName, String name)

Get lab.
abstract Response<LabInner> getByResourceGroupWithResponse(String resourceGroupName, String name, String expand, Context context)

Get lab.
abstract void importVirtualMachine(String resourceGroupName, String name, ImportLabVirtualMachineRequest importLabVirtualMachineRequest)

Import a virtual machine into a different lab.
abstract void importVirtualMachine(String resourceGroupName, String name, ImportLabVirtualMachineRequest importLabVirtualMachineRequest, Context context)

Import a virtual machine into a different lab.
abstract PagedIterable<LabInner> list()

List labs in a subscription.
abstract PagedIterable<LabInner> list(String expand, String filter, Integer top, String orderby, Context context)

List labs in a subscription.
abstract PagedIterable<LabInner> listByResourceGroup(String resourceGroupName)

List labs in a resource group.
abstract PagedIterable<LabInner> listByResourceGroup(String resourceGroupName, String expand, String filter, Integer top, String orderby, Context context)

List labs in a resource group.
abstract PagedIterable<LabVhdInner> listVhds(String resourceGroupName, String name)

List disk images available for custom image creation.
abstract PagedIterable<LabVhdInner> listVhds(String resourceGroupName, String name, Context context)

List disk images available for custom image creation.
abstract LabInner update(String resourceGroupName, String name, LabFragment lab)

Allows modifying tags of labs.
abstract Response<LabInner> updateWithResponse(String resourceGroupName, String name, LabFragment lab, Context context)

Allows modifying tags of labs.

Method Details

beginClaimAnyVm

public abstract SyncPoller<PollResult<Void>,Void> beginClaimAnyVm(String resourceGroupName, String name)

Claim a random claimable virtual machine in the lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginClaimAnyVm

public abstract SyncPoller<PollResult<Void>,Void> beginClaimAnyVm(String resourceGroupName, String name, Context context)

Claim a random claimable virtual machine in the lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginCreateEnvironment

public abstract SyncPoller<PollResult<Void>,Void> beginCreateEnvironment(String resourceGroupName, String name, LabVirtualMachineCreationParameter labVirtualMachineCreationParameter)

Create virtual machines in a lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
labVirtualMachineCreationParameter - Properties for creating a virtual machine.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginCreateEnvironment

public abstract SyncPoller<PollResult<Void>,Void> beginCreateEnvironment(String resourceGroupName, String name, LabVirtualMachineCreationParameter labVirtualMachineCreationParameter, Context context)

Create virtual machines in a lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
labVirtualMachineCreationParameter - Properties for creating a virtual machine.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<LabInner>,LabInner> beginCreateOrUpdate(String resourceGroupName, String name, LabInner lab)

Create or replace an existing lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
lab - A lab.

Returns:

the SyncPoller<T,U> for polling of a lab.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<LabInner>,LabInner> beginCreateOrUpdate(String resourceGroupName, String name, LabInner lab, Context context)

Create or replace an existing lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
lab - A lab.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of a lab.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String name)

Delete lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String name, Context context)

Delete lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginExportResourceUsage

public abstract SyncPoller<PollResult<Void>,Void> beginExportResourceUsage(String resourceGroupName, String name, ExportResourceUsageParameters exportResourceUsageParameters)

Exports the lab resource usage into a storage account This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
exportResourceUsageParameters - The parameters of the export operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginExportResourceUsage

public abstract SyncPoller<PollResult<Void>,Void> beginExportResourceUsage(String resourceGroupName, String name, ExportResourceUsageParameters exportResourceUsageParameters, Context context)

Exports the lab resource usage into a storage account This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
exportResourceUsageParameters - The parameters of the export operation.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginImportVirtualMachine

public abstract SyncPoller<PollResult<Void>,Void> beginImportVirtualMachine(String resourceGroupName, String name, ImportLabVirtualMachineRequest importLabVirtualMachineRequest)

Import a virtual machine into a different lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
importLabVirtualMachineRequest - This represents the payload required to import a virtual machine from a different lab into the current one.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginImportVirtualMachine

public abstract SyncPoller<PollResult<Void>,Void> beginImportVirtualMachine(String resourceGroupName, String name, ImportLabVirtualMachineRequest importLabVirtualMachineRequest, Context context)

Import a virtual machine into a different lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
importLabVirtualMachineRequest - This represents the payload required to import a virtual machine from a different lab into the current one.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

claimAnyVm

public abstract void claimAnyVm(String resourceGroupName, String name)

Claim a random claimable virtual machine in the lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.

claimAnyVm

public abstract void claimAnyVm(String resourceGroupName, String name, Context context)

Claim a random claimable virtual machine in the lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
context - The context to associate with this operation.

createEnvironment

public abstract void createEnvironment(String resourceGroupName, String name, LabVirtualMachineCreationParameter labVirtualMachineCreationParameter)

Create virtual machines in a lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
labVirtualMachineCreationParameter - Properties for creating a virtual machine.

createEnvironment

public abstract void createEnvironment(String resourceGroupName, String name, LabVirtualMachineCreationParameter labVirtualMachineCreationParameter, Context context)

Create virtual machines in a lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
labVirtualMachineCreationParameter - Properties for creating a virtual machine.
context - The context to associate with this operation.

createOrUpdate

public abstract LabInner createOrUpdate(String resourceGroupName, String name, LabInner lab)

Create or replace an existing lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
lab - A lab.

Returns:

a lab.

createOrUpdate

public abstract LabInner createOrUpdate(String resourceGroupName, String name, LabInner lab, Context context)

Create or replace an existing lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
lab - A lab.
context - The context to associate with this operation.

Returns:

a lab.

delete

public abstract void delete(String resourceGroupName, String name)

Delete lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.

delete

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

Delete lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
context - The context to associate with this operation.

exportResourceUsage

public abstract void exportResourceUsage(String resourceGroupName, String name, ExportResourceUsageParameters exportResourceUsageParameters)

Exports the lab resource usage into a storage account This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
exportResourceUsageParameters - The parameters of the export operation.

exportResourceUsage

public abstract void exportResourceUsage(String resourceGroupName, String name, ExportResourceUsageParameters exportResourceUsageParameters, Context context)

Exports the lab resource usage into a storage account This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
exportResourceUsageParameters - The parameters of the export operation.
context - The context to associate with this operation.

generateUploadUri

public abstract GenerateUploadUriResponseInner generateUploadUri(String resourceGroupName, String name, GenerateUploadUriParameter generateUploadUriParameter)

Generate a URI for uploading custom disk images to a Lab.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
generateUploadUriParameter - Properties for generating an upload URI.

Returns:

response body for generating an upload URI.

generateUploadUriWithResponse

public abstract Response<GenerateUploadUriResponseInner> generateUploadUriWithResponse(String resourceGroupName, String name, GenerateUploadUriParameter generateUploadUriParameter, Context context)

Generate a URI for uploading custom disk images to a Lab.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
generateUploadUriParameter - Properties for generating an upload URI.
context - The context to associate with this operation.

Returns:

response body for generating an upload URI along with Response<T>.

getByResourceGroup

public abstract LabInner getByResourceGroup(String resourceGroupName, String name)

Get lab.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.

Returns:

lab.

getByResourceGroupWithResponse

public abstract Response<LabInner> getByResourceGroupWithResponse(String resourceGroupName, String name, String expand, Context context)

Get lab.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
expand - Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'.
context - The context to associate with this operation.

Returns:

lab along with Response<T>.

importVirtualMachine

public abstract void importVirtualMachine(String resourceGroupName, String name, ImportLabVirtualMachineRequest importLabVirtualMachineRequest)

Import a virtual machine into a different lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
importLabVirtualMachineRequest - This represents the payload required to import a virtual machine from a different lab into the current one.

importVirtualMachine

public abstract void importVirtualMachine(String resourceGroupName, String name, ImportLabVirtualMachineRequest importLabVirtualMachineRequest, Context context)

Import a virtual machine into a different lab. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
importLabVirtualMachineRequest - This represents the payload required to import a virtual machine from a different lab into the current one.
context - The context to associate with this operation.

list

public abstract PagedIterable<LabInner> list()

List labs in a subscription.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<LabInner> list(String expand, String filter, Integer top, String orderby, Context context)

List labs in a subscription.

Parameters:

expand - Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'.
filter - The filter to apply to the operation. Example: '$filter=contains(name,'myName').
top - The maximum number of resources to return from the operation. Example: '$top=10'.
orderby - The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
context - The context to associate with this operation.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<LabInner> listByResourceGroup(String resourceGroupName)

List labs in a resource group.

Parameters:

resourceGroupName - The name of the resource group.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<LabInner> listByResourceGroup(String resourceGroupName, String expand, String filter, Integer top, String orderby, Context context)

List labs in a resource group.

Parameters:

resourceGroupName - The name of the resource group.
expand - Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'.
filter - The filter to apply to the operation. Example: '$filter=contains(name,'myName').
top - The maximum number of resources to return from the operation. Example: '$top=10'.
orderby - The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
context - The context to associate with this operation.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

listVhds

public abstract PagedIterable<LabVhdInner> listVhds(String resourceGroupName, String name)

List disk images available for custom image creation.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

listVhds

public abstract PagedIterable<LabVhdInner> listVhds(String resourceGroupName, String name, Context context)

List disk images available for custom image creation.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
context - The context to associate with this operation.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

update

public abstract LabInner update(String resourceGroupName, String name, LabFragment lab)

Allows modifying tags of labs. All other properties will be ignored.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
lab - A lab.

Returns:

a lab.

updateWithResponse

public abstract Response<LabInner> updateWithResponse(String resourceGroupName, String name, LabFragment lab, Context context)

Allows modifying tags of labs. All other properties will be ignored.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the lab.
lab - A lab.
context - The context to associate with this operation.

Returns:

a lab along with Response<T>.

Applies to