Package version:

Interface VirtualMachineImages

Interface representing a VirtualMachineImages.

interface VirtualMachineImages {
    get(location: string, publisherName: string, offer: string, skus: string, version: string, options?: VirtualMachineImagesGetOptionalParams): Promise<VirtualMachineImage>;
    list(location: string, publisherName: string, offer: string, skus: string, options?: VirtualMachineImagesListOptionalParams): Promise<VirtualMachineImagesListResponse>;
    listByEdgeZone(location: string, edgeZone: string, options?: VirtualMachineImagesListByEdgeZoneOptionalParams): Promise<VmImagesInEdgeZoneListResult>;
    listOffers(location: string, publisherName: string, options?: VirtualMachineImagesListOffersOptionalParams): Promise<VirtualMachineImagesListOffersResponse>;
    listPublishers(location: string, options?: VirtualMachineImagesListPublishersOptionalParams): Promise<VirtualMachineImagesListPublishersResponse>;
    listSkus(location: string, publisherName: string, offer: string, options?: VirtualMachineImagesListSkusOptionalParams): Promise<VirtualMachineImagesListSkusResponse>;
    listWithProperties(location: string, publisherName: string, offer: string, skus: string, expand: string, options?: VirtualMachineImagesListWithPropertiesOptionalParams): PagedAsyncIterableIterator<VirtualMachineImage>;
}

Methods

get(location, publisherName, offer, skus, version, options?): Promise<VirtualMachineImage>
Gets a virtual machine image.
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.
- Optionaloptions: VirtualMachineImagesGetOptionalParams
  The options parameters.
Returns Promise<VirtualMachineImage>
- Defined in operationsInterfaces/virtualMachineImages.ts:56

list(location, publisherName, offer, skus, options?): Promise<VirtualMachineImagesListResponse>
Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.
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.
- Optionaloptions: VirtualMachineImagesListOptionalParams
  The options parameters.
Returns Promise<VirtualMachineImagesListResponse>
- Defined in operationsInterfaces/virtualMachineImages.ts:73

listByEdgeZone(location, edgeZone, options?): Promise<VmImagesInEdgeZoneListResult>
Gets a list of all virtual machine image versions for the specified edge zone
Parameters
- location: string
  The name of a supported Azure region.
- edgeZone: string
  The name of the edge zone.
- Optionaloptions: VirtualMachineImagesListByEdgeZoneOptionalParams
  The options parameters.
Returns Promise<VmImagesInEdgeZoneListResult>
- Defined in operationsInterfaces/virtualMachineImages.ts:119

listOffers(location, publisherName, options?): Promise<VirtualMachineImagesListOffersResponse>
Gets a list of virtual machine image offers for the specified location and publisher.
Parameters
- location: string
  The name of a supported Azure region.
- publisherName: string
  A valid image publisher.
- Optionaloptions: VirtualMachineImagesListOffersOptionalParams
  The options parameters.
Returns Promise<VirtualMachineImagesListOffersResponse>
- Defined in operationsInterfaces/virtualMachineImages.ts:86

listPublishers(location, options?): Promise<VirtualMachineImagesListPublishersResponse>
Gets a list of virtual machine image publishers for the specified Azure location.
Parameters
- location: string
  The name of a supported Azure region.
- Optionaloptions: VirtualMachineImagesListPublishersOptionalParams
  The options parameters.
Returns Promise<VirtualMachineImagesListPublishersResponse>
- Defined in operationsInterfaces/virtualMachineImages.ts:96

listSkus(location, publisherName, offer, options?): Promise<VirtualMachineImagesListSkusResponse>
Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.
Parameters
- location: string
  The name of a supported Azure region.
- publisherName: string
  A valid image publisher.
- offer: string
  A valid image publisher offer.
- Optionaloptions: VirtualMachineImagesListSkusOptionalParams
  The options parameters.
Returns Promise<VirtualMachineImagesListSkusResponse>
- Defined in operationsInterfaces/virtualMachineImages.ts:107

listWithProperties(location, publisherName, offer, skus, expand, options?): PagedAsyncIterableIterator<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.
- expand: string
  The expand expression to apply on the operation.
- Optionaloptions: VirtualMachineImagesListWithPropertiesOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualMachineImage>
- Defined in operationsInterfaces/virtualMachineImages.ts:39