Share via

CustomImages interface

  • Reference
Package:
@azure/arm-devtestlabs

Interface representing a CustomImages.

Methods

beginCreateOrUpdate(string, string, string, CustomImage, CustomImagesCreateOrUpdateOptionalParams)

Create or replace an existing custom image. This operation can take a while to complete.
beginCreateOrUpdateAndWait(string, string, string, CustomImage, CustomImagesCreateOrUpdateOptionalParams)

Create or replace an existing custom image. This operation can take a while to complete.
beginDelete(string, string, string, CustomImagesDeleteOptionalParams)

Delete custom image. This operation can take a while to complete.
beginDeleteAndWait(string, string, string, CustomImagesDeleteOptionalParams)

Delete custom image. This operation can take a while to complete.
get(string, string, string, CustomImagesGetOptionalParams)

Get custom image.
list(string, string, CustomImagesListOptionalParams)

List custom images in a given lab.
update(string, string, string, CustomImageFragment, CustomImagesUpdateOptionalParams)

Allows modifying tags of custom images. All other properties will be ignored.

Method Details

beginCreateOrUpdate(string, string, string, CustomImage, CustomImagesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, labName: string, name: string, customImage: CustomImage, options?: CustomImagesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<CustomImage>, CustomImage>>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the custom image.

customImage
CustomImage

A custom image.

options
CustomImagesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, CustomImage, CustomImagesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, labName: string, name: string, customImage: CustomImage, options?: CustomImagesCreateOrUpdateOptionalParams): Promise<CustomImage>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the custom image.

customImage
CustomImage

A custom image.

options
CustomImagesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CustomImage>

beginDelete(string, string, string, CustomImagesDeleteOptionalParams)

Delete custom image. This operation can take a while to complete.

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

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the custom image.

options
CustomImagesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, CustomImagesDeleteOptionalParams)

Delete custom image. This operation can take a while to complete.

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

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the custom image.

options
CustomImagesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, CustomImagesGetOptionalParams)

Get custom image.

function get(resourceGroupName: string, labName: string, name: string, options?: CustomImagesGetOptionalParams): Promise<CustomImage>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the custom image.

options
CustomImagesGetOptionalParams

The options parameters.

Returns

Promise<CustomImage>

list(string, string, CustomImagesListOptionalParams)

List custom images in a given lab.

function list(resourceGroupName: string, labName: string, options?: CustomImagesListOptionalParams): PagedAsyncIterableIterator<CustomImage, CustomImage[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

options
CustomImagesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CustomImage, CustomImage[], PageSettings>

update(string, string, string, CustomImageFragment, CustomImagesUpdateOptionalParams)

Allows modifying tags of custom images. All other properties will be ignored.

function update(resourceGroupName: string, labName: string, name: string, customImage: CustomImageFragment, options?: CustomImagesUpdateOptionalParams): Promise<CustomImage>

Parameters

resourceGroupName

string

The name of the resource group.

labName

string

The name of the lab.

name

string

The name of the custom image.

customImage
CustomImageFragment

A custom image.

options
CustomImagesUpdateOptionalParams

The options parameters.

Returns

Promise<CustomImage>