GalleryImagesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:gallery_images> attribute.

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. The name is case insensitive. Required.
gallery_name Required	str The name of the Shared Image Gallery. Required.
gallery_image_name Required	str The name of the gallery image definition to be retrieved. Required.
gallery_image Required	GalleryImage or <xref:JSON> or IO[bytes] Parameters supplied to the create or update gallery image operation. Is one of the following types: GalleryImage, JSON, IO[bytes] Required.

Returns

Type	Description
AsyncLROPoller[GalleryImage]	An instance of AsyncLROPoller that returns GalleryImage. The GalleryImage is compatible with MutableMapping

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. The name is case insensitive. Required.
gallery_name Required	str The name of the Shared Image Gallery. Required.
gallery_image_name Required	str The name of the gallery image definition to be retrieved. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns None

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. The name is case insensitive. Required.
gallery_name Required	str The name of the Shared Image Gallery. Required.
gallery_image_name Required	str The name of the gallery image definition to be retrieved. Required.
gallery_image Required	GalleryImageUpdate or <xref:JSON> or IO[bytes] Parameters supplied to the update gallery image operation. Is one of the following types: GalleryImageUpdate, JSON, IO[bytes] Required.

Returns

Type	Description
AsyncLROPoller[GalleryImage]	An instance of AsyncLROPoller that returns GalleryImage. The GalleryImage is compatible with MutableMapping

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. The name is case insensitive. Required.
gallery_name Required	str The name of the Shared Image Gallery. Required.
gallery_image_name Required	str The name of the gallery image definition to be retrieved. Required.

Returns

Type	Description
GalleryImage	GalleryImage. The GalleryImage is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_gallery

List gallery image definitions in a gallery.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
gallery_name Required	str The name of the Shared Image Gallery. Required.

Returns

Type	Description
AsyncItemPaged[GalleryImage]	An iterator like instance of GalleryImage

Exceptions

Type	Description
HttpResponseError

Comentários

Esta página foi útil?