Share via

Images interface

  • Reference
Package:
@azure/arm-compute-profile-2020-09-01-hybrid

Interface representing a Images.

Methods

beginCreateOrUpdate(string, string, Image_2, ImagesCreateOrUpdateOptionalParams)

Create or update an image.
beginCreateOrUpdateAndWait(string, string, Image_2, ImagesCreateOrUpdateOptionalParams)

Create or update an image.
beginDelete(string, string, ImagesDeleteOptionalParams)

Deletes an Image.
beginDeleteAndWait(string, string, ImagesDeleteOptionalParams)

Deletes an Image.
beginUpdate(string, string, ImageUpdate, ImagesUpdateOptionalParams)

Update an image.
beginUpdateAndWait(string, string, ImageUpdate, ImagesUpdateOptionalParams)

Update an image.
get(string, string, ImagesGetOptionalParams)

Gets an image.
list(ImagesListOptionalParams)

Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.
listByResourceGroup(string, ImagesListByResourceGroupOptionalParams)

Gets the list of images under a resource group.

Method Details

beginCreateOrUpdate(string, string, Image_2, ImagesCreateOrUpdateOptionalParams)

Create or update an image.

function beginCreateOrUpdate(resourceGroupName: string, imageName: string, parameters: Image_2, options?: ImagesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Image_2>, Image_2>>

Parameters

resourceGroupName

string

The name of the resource group.

imageName

string

The name of the image.

parameters
Image

Parameters supplied to the Create Image operation.

options
ImagesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, Image_2, ImagesCreateOrUpdateOptionalParams)

Create or update an image.

function beginCreateOrUpdateAndWait(resourceGroupName: string, imageName: string, parameters: Image_2, options?: ImagesCreateOrUpdateOptionalParams): Promise<Image_2>

Parameters

resourceGroupName

string

The name of the resource group.

imageName

string

The name of the image.

parameters
Image

Parameters supplied to the Create Image operation.

options
ImagesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Image>

beginDelete(string, string, ImagesDeleteOptionalParams)

Deletes an Image.

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

Parameters

resourceGroupName

string

The name of the resource group.

imageName

string

The name of the image.

options
ImagesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, ImagesDeleteOptionalParams)

Deletes an Image.

function beginDeleteAndWait(resourceGroupName: string, imageName: string, options?: ImagesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

imageName

string

The name of the image.

options
ImagesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, ImageUpdate, ImagesUpdateOptionalParams)

Update an image.

function beginUpdate(resourceGroupName: string, imageName: string, parameters: ImageUpdate, options?: ImagesUpdateOptionalParams): Promise<PollerLike<PollOperationState<Image_2>, Image_2>>

Parameters

resourceGroupName

string

The name of the resource group.

imageName

string

The name of the image.

parameters
ImageUpdate

Parameters supplied to the Update Image operation.

options
ImagesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, ImageUpdate, ImagesUpdateOptionalParams)

Update an image.

function beginUpdateAndWait(resourceGroupName: string, imageName: string, parameters: ImageUpdate, options?: ImagesUpdateOptionalParams): Promise<Image_2>

Parameters

resourceGroupName

string

The name of the resource group.

imageName

string

The name of the image.

parameters
ImageUpdate

Parameters supplied to the Update Image operation.

options
ImagesUpdateOptionalParams

The options parameters.

Returns

Promise<Image>

get(string, string, ImagesGetOptionalParams)

Gets an image.

function get(resourceGroupName: string, imageName: string, options?: ImagesGetOptionalParams): Promise<Image_2>

Parameters

resourceGroupName

string

The name of the resource group.

imageName

string

The name of the image.

options
ImagesGetOptionalParams

The options parameters.

Returns

Promise<Image>

list(ImagesListOptionalParams)

Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.

function list(options?: ImagesListOptionalParams): PagedAsyncIterableIterator<Image_2, Image_2[], PageSettings>

Parameters

options
ImagesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Image, Image[], PageSettings>

listByResourceGroup(string, ImagesListByResourceGroupOptionalParams)

Gets the list of images under a resource group.

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

Parameters

resourceGroupName

string

The name of the resource group.

options
ImagesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Image, Image[], PageSettings>