Share via

VirtualMachineImagesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ComputeManagementClient's

<xref:virtual_machine_images> attribute.

Constructor

VirtualMachineImagesOperations(*args, **kwargs)

Methods

get

Gets a virtual machine image.
list

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

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

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

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

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

list_with_properties.

get

Gets a virtual machine image.

async get(location: str, publisher_name: str, offer: str, skus: str, version: str, **kwargs: Any) -> VirtualMachineImage

Parameters

Name Description
location
Required
str

The name of Azure region. Required.
publisher_name
Required
str

A valid image publisher. Required.
offer
Required
str

A valid image publisher offer. Required.
skus
Required
str

A valid image SKU. Required.
version
Required
str

A valid image SKU version. Required.

Returns

Type Description
VirtualMachineImage

VirtualMachineImage or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

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

async list(location: str, publisher_name: str, offer: str, skus: str, expand: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> list[azure.mgmt.compute.models._models_py3.VirtualMachineImageResource]

Parameters

Name Description
location
Required
str

The name of Azure region. Required.
publisher_name
Required
str

A valid image publisher. Required.
offer
Required
str

A valid image publisher offer. Required.
skus
Required
str

A valid image SKU. Required.
expand
str

The expand expression to apply on the operation. Default value is None.

Default value: None
top
int

Default value is None.

Default value: None
orderby
str

Default value is None.

Default value: None

Returns

Type Description
list[VirtualMachineImageResource]

list of VirtualMachineImageResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_edge_zone

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

async list_by_edge_zone(location: str, edge_zone: str, **kwargs: Any) -> VmImagesInEdgeZoneListResult

Parameters

Name Description
location
Required
str

The name of Azure region. Required.
edge_zone
Required
str

The name of the edge zone. Required.

Returns

Type Description
VmImagesInEdgeZoneListResult

VmImagesInEdgeZoneListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_offers

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

async list_offers(location: str, publisher_name: str, **kwargs: Any) -> list[azure.mgmt.compute.models._models_py3.VirtualMachineImageResource]

Parameters

Name Description
location
Required
str

The name of Azure region. Required.
publisher_name
Required
str

A valid image publisher. Required.

Returns

Type Description
list[VirtualMachineImageResource]

list of VirtualMachineImageResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_publishers

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

async list_publishers(location: str, **kwargs: Any) -> list[azure.mgmt.compute.models._models_py3.VirtualMachineImageResource]

Parameters

Name Description
location
Required
str

The name of Azure region. Required.

Returns

Type Description
list[VirtualMachineImageResource]

list of VirtualMachineImageResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_skus

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

async list_skus(location: str, publisher_name: str, offer: str, **kwargs: Any) -> list[azure.mgmt.compute.models._models_py3.VirtualMachineImageResource]

Parameters

Name Description
location
Required
str

The name of Azure region. Required.
publisher_name
Required
str

A valid image publisher. Required.
offer
Required
str

A valid image publisher offer. Required.

Returns

Type Description
list[VirtualMachineImageResource]

list of VirtualMachineImageResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_with_properties

list_with_properties.

async list_with_properties(location: str, publisher_name: str, offer: str, skus: str, expand: str, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> list[azure.mgmt.compute.models._models_py3.VirtualMachineImage]

Parameters

Name Description
location
Required
str

The name of Azure region. Required.
publisher_name
Required
str

A valid image publisher. Required.
offer
Required
str

A valid image publisher offer. Required.
skus
Required
str

A valid image SKU. Required.
expand
Required
str

The expand expression to apply on the operation. Required.
top
int

Default value is None.

Default value: None
orderby
str

Default value is None.

Default value: None

Returns

Type Description
list[VirtualMachineImage]

list of VirtualMachineImage or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.compute.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv89\\Lib\\site-packages\\azure\\mgmt\\compute\\models\\__init__.py'>