Share via

GalleryImagesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ComputeManagementClient's

<xref:gallery_images> attribute.

Inheritance
builtins.object
GalleryImagesOperations

Constructor

GalleryImagesOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or update a gallery image definition.
begin_delete

Delete a gallery image.
begin_update

Update a gallery image definition.
get

Retrieves information about a gallery image definition.
list_by_gallery

List gallery image definitions in a gallery.

begin_create_or_update

Create or update a gallery image definition.

async begin_create_or_update(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image: _models.GalleryImage, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.GalleryImage]

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 is to be created. Required.
gallery_image_name
Required
str

The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. Required.
gallery_image
Required
GalleryImage or IO[bytes]

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

Returns

Type Description
AsyncLROPoller[GalleryImage]

An instance of AsyncLROPoller that returns either GalleryImage or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a gallery image.

async begin_delete(resource_group_name: str, gallery_name: str, gallery_image_name: str, **kwargs: Any) -> AsyncLROPoller[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 is to be deleted. Required.
gallery_image_name
Required
str

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

Returns

Type Description
AsyncLROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_update

Update a gallery image definition.

async begin_update(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image: _models.GalleryImageUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.GalleryImage]

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 is to be updated. Required.
gallery_image_name
Required
str

The name of the gallery image definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. Required.
gallery_image
Required
GalleryImageUpdate or IO[bytes]

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

Returns

Type Description
AsyncLROPoller[GalleryImage]

An instance of AsyncLROPoller that returns either GalleryImage or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Retrieves information about a gallery image definition.

async get(resource_group_name: str, gallery_name: str, gallery_image_name: str, **kwargs: Any) -> GalleryImage

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 from which the Image Definitions are to be retrieved. Required.
gallery_image_name
Required
str

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

Returns

Type Description
GalleryImage

GalleryImage or the result of cls(response)

Exceptions

Type Description
HttpResponseError

List gallery image definitions in a gallery.

list_by_gallery(resource_group_name: str, gallery_name: str, **kwargs: Any) -> AsyncIterable[GalleryImage]

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 from which Image Definitions are to be listed. Required.

Returns

Type Description
AsyncItemPaged[GalleryImage]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

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