Labs interface

Package:

@azure/arm-devtestlabs

Interface representing a Labs.

Methods

beginClaimAnyVm(string, string, LabsClaimAnyVmOptionalParams)	Claim a random claimable virtual machine in the lab. This operation can take a while to complete.
beginClaimAnyVmAndWait(string, string, LabsClaimAnyVmOptionalParams)	Claim a random claimable virtual machine in the lab. This operation can take a while to complete.
beginCreateEnvironment(string, string, LabVirtualMachineCreationParameter, LabsCreateEnvironmentOptionalParams)	Create virtual machines in a lab. This operation can take a while to complete.
beginCreateEnvironmentAndWait(string, string, LabVirtualMachineCreationParameter, LabsCreateEnvironmentOptionalParams)	Create virtual machines in a lab. This operation can take a while to complete.
beginCreateOrUpdate(string, string, Lab, LabsCreateOrUpdateOptionalParams)	Create or replace an existing lab. This operation can take a while to complete.
beginCreateOrUpdateAndWait(string, string, Lab, LabsCreateOrUpdateOptionalParams)	Create or replace an existing lab. This operation can take a while to complete.
beginDelete(string, string, LabsDeleteOptionalParams)	Delete lab. This operation can take a while to complete.
beginDeleteAndWait(string, string, LabsDeleteOptionalParams)	Delete lab. This operation can take a while to complete.
beginExportResourceUsage(string, string, ExportResourceUsageParameters, LabsExportResourceUsageOptionalParams)	Exports the lab resource usage into a storage account This operation can take a while to complete.
beginExportResourceUsageAndWait(string, string, ExportResourceUsageParameters, LabsExportResourceUsageOptionalParams)	Exports the lab resource usage into a storage account This operation can take a while to complete.
beginImportVirtualMachine(string, string, ImportLabVirtualMachineRequest, LabsImportVirtualMachineOptionalParams)	Import a virtual machine into a different lab. This operation can take a while to complete.
beginImportVirtualMachineAndWait(string, string, ImportLabVirtualMachineRequest, LabsImportVirtualMachineOptionalParams)	Import a virtual machine into a different lab. This operation can take a while to complete.
generateUploadUri(string, string, GenerateUploadUriParameter, LabsGenerateUploadUriOptionalParams)	Generate a URI for uploading custom disk images to a Lab.
get(string, string, LabsGetOptionalParams)	Get lab.
listByResourceGroup(string, LabsListByResourceGroupOptionalParams)	List labs in a resource group.
listBySubscription(LabsListBySubscriptionOptionalParams)	List labs in a subscription.
listVhds(string, string, LabsListVhdsOptionalParams)	List disk images available for custom image creation.
update(string, string, LabFragment, LabsUpdateOptionalParams)	Allows modifying tags of labs. All other properties will be ignored.

Method Details

beginClaimAnyVm(string, string, LabsClaimAnyVmOptionalParams)

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

function beginClaimAnyVm(resourceGroupName: string, name: string, options?: LabsClaimAnyVmOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

options

LabsClaimAnyVmOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginClaimAnyVmAndWait(string, string, LabsClaimAnyVmOptionalParams)

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

function beginClaimAnyVmAndWait(resourceGroupName: string, name: string, options?: LabsClaimAnyVmOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

options

LabsClaimAnyVmOptionalParams

The options parameters.

Returns

Promise<void>

beginCreateEnvironment(string, string, LabVirtualMachineCreationParameter, LabsCreateEnvironmentOptionalParams)

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

function beginCreateEnvironment(resourceGroupName: string, name: string, labVirtualMachineCreationParameter: LabVirtualMachineCreationParameter, options?: LabsCreateEnvironmentOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

labVirtualMachineCreationParameter

LabVirtualMachineCreationParameter

Properties for creating a virtual machine.

options

LabsCreateEnvironmentOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginCreateEnvironmentAndWait(string, string, LabVirtualMachineCreationParameter, LabsCreateEnvironmentOptionalParams)

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

function beginCreateEnvironmentAndWait(resourceGroupName: string, name: string, labVirtualMachineCreationParameter: LabVirtualMachineCreationParameter, options?: LabsCreateEnvironmentOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

labVirtualMachineCreationParameter

LabVirtualMachineCreationParameter

Properties for creating a virtual machine.

options

LabsCreateEnvironmentOptionalParams

The options parameters.

Returns

Promise<void>

beginCreateOrUpdate(string, string, Lab, LabsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, name: string, lab: Lab, options?: LabsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Lab>, Lab>>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

lab

Lab

A lab.

options

LabsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Lab>, Lab>>

beginCreateOrUpdateAndWait(string, string, Lab, LabsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, name: string, lab: Lab, options?: LabsCreateOrUpdateOptionalParams): Promise<Lab>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

lab

Lab

A lab.

options

LabsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Lab>

beginDelete(string, string, LabsDeleteOptionalParams)

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

function beginDelete(resourceGroupName: string, name: string, options?: LabsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

options

LabsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, LabsDeleteOptionalParams)

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

function beginDeleteAndWait(resourceGroupName: string, name: string, options?: LabsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

options

LabsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginExportResourceUsage(string, string, ExportResourceUsageParameters, LabsExportResourceUsageOptionalParams)

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

function beginExportResourceUsage(resourceGroupName: string, name: string, exportResourceUsageParameters: ExportResourceUsageParameters, options?: LabsExportResourceUsageOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

exportResourceUsageParameters

ExportResourceUsageParameters

The parameters of the export operation.

options

LabsExportResourceUsageOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginExportResourceUsageAndWait(string, string, ExportResourceUsageParameters, LabsExportResourceUsageOptionalParams)

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

function beginExportResourceUsageAndWait(resourceGroupName: string, name: string, exportResourceUsageParameters: ExportResourceUsageParameters, options?: LabsExportResourceUsageOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

exportResourceUsageParameters

ExportResourceUsageParameters

The parameters of the export operation.

options

LabsExportResourceUsageOptionalParams

The options parameters.

Returns

Promise<void>

beginImportVirtualMachine(string, string, ImportLabVirtualMachineRequest, LabsImportVirtualMachineOptionalParams)

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

function beginImportVirtualMachine(resourceGroupName: string, name: string, importLabVirtualMachineRequest: ImportLabVirtualMachineRequest, options?: LabsImportVirtualMachineOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

importLabVirtualMachineRequest

ImportLabVirtualMachineRequest

This represents the payload required to import a virtual machine from a different lab into the current one

options

LabsImportVirtualMachineOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginImportVirtualMachineAndWait(string, string, ImportLabVirtualMachineRequest, LabsImportVirtualMachineOptionalParams)

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

function beginImportVirtualMachineAndWait(resourceGroupName: string, name: string, importLabVirtualMachineRequest: ImportLabVirtualMachineRequest, options?: LabsImportVirtualMachineOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

importLabVirtualMachineRequest

ImportLabVirtualMachineRequest

This represents the payload required to import a virtual machine from a different lab into the current one

options

LabsImportVirtualMachineOptionalParams

The options parameters.

Returns

Promise<void>

generateUploadUri(string, string, GenerateUploadUriParameter, LabsGenerateUploadUriOptionalParams)

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

function generateUploadUri(resourceGroupName: string, name: string, generateUploadUriParameter: GenerateUploadUriParameter, options?: LabsGenerateUploadUriOptionalParams): Promise<GenerateUploadUriResponse>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

generateUploadUriParameter

GenerateUploadUriParameter

Properties for generating an upload URI.

options

LabsGenerateUploadUriOptionalParams

The options parameters.

Returns

Promise<GenerateUploadUriResponse>

get(string, string, LabsGetOptionalParams)

Get lab.

function get(resourceGroupName: string, name: string, options?: LabsGetOptionalParams): Promise<Lab>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

options

LabsGetOptionalParams

The options parameters.

Returns

Promise<Lab>

listByResourceGroup(string, LabsListByResourceGroupOptionalParams)

List labs in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: LabsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Lab, Lab[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options

LabsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Lab, Lab[], PageSettings>

listBySubscription(LabsListBySubscriptionOptionalParams)

List labs in a subscription.

function listBySubscription(options?: LabsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Lab, Lab[], PageSettings>

Parameters

options

LabsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Lab, Lab[], PageSettings>

listVhds(string, string, LabsListVhdsOptionalParams)

List disk images available for custom image creation.

function listVhds(resourceGroupName: string, name: string, options?: LabsListVhdsOptionalParams): PagedAsyncIterableIterator<LabVhd, LabVhd[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

options

LabsListVhdsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LabVhd, LabVhd[], PageSettings>

update(string, string, LabFragment, LabsUpdateOptionalParams)

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

function update(resourceGroupName: string, name: string, lab: LabFragment, options?: LabsUpdateOptionalParams): Promise<Lab>

Parameters

resourceGroupName

string

The name of the resource group.

name

string

The name of the lab.

lab

LabFragment

A lab.

options

LabsUpdateOptionalParams

The options parameters.

Returns

Promise<Lab>