Share via

GalleryImageVersionsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ComputeManagementClient's

<xref:gallery_image_versions> attribute.

Inheritance
builtins.object
GalleryImageVersionsOperations

Constructor

GalleryImageVersionsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or update a gallery image version.
begin_delete

Delete a gallery image version.
begin_update

Update a gallery image version.
get

Retrieves information about a gallery image version.
list_by_gallery_image

List gallery image versions in a gallery image definition.

begin_create_or_update

Create or update a gallery image version.

begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image_version_name: str, gallery_image_version: _models.GalleryImageVersion, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GalleryImageVersion]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
gallery_name
Required
str

The name of the Shared Image Gallery in which the Image Definition resides. Required.
gallery_image_name
Required
str

The name of the gallery image definition in which the Image Version is to be created. Required.
gallery_image_version_name
Required
str

The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.:code:.:code:. Required.
gallery_image_version
Required
GalleryImageVersion or IO[bytes]

Parameters supplied to the create or update gallery image version operation. Is either a GalleryImageVersion type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[GalleryImageVersion]

An instance of LROPoller that returns either GalleryImageVersion or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a gallery image version.

begin_delete(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image_version_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
gallery_name
Required
str

The name of the Shared Image Gallery in which the Image Definition resides. Required.
gallery_image_name
Required
str

The name of the gallery image definition in which the Image Version resides. Required.
gallery_image_version_name
Required
str

The name of the gallery image version to be deleted. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_update

Update a gallery image version.

begin_update(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image_version_name: str, gallery_image_version: _models.GalleryImageVersionUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GalleryImageVersion]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
gallery_name
Required
str

The name of the Shared Image Gallery in which the Image Definition resides. Required.
gallery_image_name
Required
str

The name of the gallery image definition in which the Image Version is to be updated. Required.
gallery_image_version_name
Required
str

The name of the gallery image version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.:code:.:code:. Required.
gallery_image_version
Required
GalleryImageVersionUpdate or IO[bytes]

Parameters supplied to the update gallery image version operation. Is either a GalleryImageVersionUpdate type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[GalleryImageVersion]

An instance of LROPoller that returns either GalleryImageVersion or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Retrieves information about a gallery image version.

get(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image_version_name: str, *, expand: str | ReplicationStatusTypes | None = None, **kwargs: Any) -> GalleryImageVersion

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
gallery_name
Required
str

The name of the Shared Image Gallery in which the Image Definition resides. Required.
gallery_image_name
Required
str

The name of the gallery image definition in which the Image Version resides. Required.
gallery_image_version_name
Required
str

The name of the gallery image version to be retrieved. Required.

Keyword-Only Parameters

Name Description
expand
str or ReplicationStatusTypes

The expand expression to apply on the operation. Known values are: "ReplicationStatus" and "UefiSettings". Default value is None.

Returns

Type Description
GalleryImageVersion

GalleryImageVersion or the result of cls(response)

Exceptions

Type Description
HttpResponseError

List gallery image versions in a gallery image definition.

list_by_gallery_image(resource_group_name: str, gallery_name: str, gallery_image_name: str, **kwargs: Any) -> Iterable[GalleryImageVersion]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
gallery_name
Required
str

The name of the Shared Image Gallery in which the Image Definition resides. Required.
gallery_image_name
Required
str

The name of the Shared Image Gallery Image Definition from which the Image Versions are to be listed. Required.

Returns

Type Description
ItemPaged[GalleryImageVersion]

An iterator like instance of either GalleryImageVersion or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.compute.v2022_08_03.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2022_08_03\\models\\__init__.py'>