VirtualMachineImages interface

Package:

@azure/arm-compute

Interface representing a VirtualMachineImages.

Methods

get(string, string, string, string, string, VirtualMachineImagesGetOptionalParams)	Gets a virtual machine image.
list(string, string, string, string, VirtualMachineImagesListOptionalParams)	Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.
listByEdgeZone(string, string, VirtualMachineImagesListByEdgeZoneOptionalParams)	Gets a list of all virtual machine image versions for the specified edge zone
listOffers(string, string, VirtualMachineImagesListOffersOptionalParams)	Gets a list of virtual machine image offers for the specified location and publisher.
listPublishers(string, VirtualMachineImagesListPublishersOptionalParams)	Gets a list of virtual machine image publishers for the specified Azure location.
listSkus(string, string, string, VirtualMachineImagesListSkusOptionalParams)	Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.

Method Details

get(string, string, string, string, string, VirtualMachineImagesGetOptionalParams)

Gets a virtual machine image.

function get(location: string, publisherName: string, offer: string, skus: string, version: string, options?: VirtualMachineImagesGetOptionalParams): Promise<VirtualMachineImage>

Parameters

location

string

The name of a supported Azure region.

publisherName

string

A valid image publisher.

offer

string

A valid image publisher offer.

skus

string

A valid image SKU.

version

string

A valid image SKU version.

options

VirtualMachineImagesGetOptionalParams

The options parameters.

Returns

Promise<VirtualMachineImage>

list(string, string, string, string, VirtualMachineImagesListOptionalParams)

Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.

function list(location: string, publisherName: string, offer: string, skus: string, options?: VirtualMachineImagesListOptionalParams): Promise<VirtualMachineImagesListResponse>

Parameters

location

string

The name of a supported Azure region.

publisherName

string

A valid image publisher.

offer

string

A valid image publisher offer.

skus

string

A valid image SKU.

options

VirtualMachineImagesListOptionalParams

The options parameters.

Returns

Promise<VirtualMachineImagesListResponse>

listByEdgeZone(string, string, VirtualMachineImagesListByEdgeZoneOptionalParams)

Gets a list of all virtual machine image versions for the specified edge zone

function listByEdgeZone(location: string, edgeZone: string, options?: VirtualMachineImagesListByEdgeZoneOptionalParams): Promise<VmImagesInEdgeZoneListResult>

Parameters

location

string

The name of a supported Azure region.

edgeZone

string

The name of the edge zone.

options

VirtualMachineImagesListByEdgeZoneOptionalParams

The options parameters.

Returns

Promise<VmImagesInEdgeZoneListResult>

listOffers(string, string, VirtualMachineImagesListOffersOptionalParams)

Gets a list of virtual machine image offers for the specified location and publisher.

function listOffers(location: string, publisherName: string, options?: VirtualMachineImagesListOffersOptionalParams): Promise<VirtualMachineImagesListOffersResponse>

Parameters

location

string

The name of a supported Azure region.

publisherName

string

A valid image publisher.

options

VirtualMachineImagesListOffersOptionalParams

The options parameters.

Returns

Promise<VirtualMachineImagesListOffersResponse>

listPublishers(string, VirtualMachineImagesListPublishersOptionalParams)

Gets a list of virtual machine image publishers for the specified Azure location.

function listPublishers(location: string, options?: VirtualMachineImagesListPublishersOptionalParams): Promise<VirtualMachineImagesListPublishersResponse>

Parameters

location

string

The name of a supported Azure region.

options

VirtualMachineImagesListPublishersOptionalParams

The options parameters.

Returns

Promise<VirtualMachineImagesListPublishersResponse>

listSkus(string, string, string, VirtualMachineImagesListSkusOptionalParams)

Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.

function listSkus(location: string, publisherName: string, offer: string, options?: VirtualMachineImagesListSkusOptionalParams): Promise<VirtualMachineImagesListSkusResponse>

Parameters

location

string

The name of a supported Azure region.

publisherName

string

A valid image publisher.

offer

string

A valid image publisher offer.

options

VirtualMachineImagesListSkusOptionalParams

The options parameters.

Returns

Promise<VirtualMachineImagesListSkusResponse>