GalleryImageVersionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:gallery_image_versions> attribute.

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. 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_version_name Required	str The name of the gallery image version to be retrieved. Required.
gallery_image_version Required	GalleryImageVersion or 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 GalleryImageVersion. The GalleryImageVersion is compatible with MutableMapping

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, *, bypass_soft_delete: bool | None = None, **kwargs: Any) -> LROPoller[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.
gallery_image_version_name Required	str The name of the gallery image version to be retrieved. Required.

Keyword-Only Parameters

Name	Description
bypass_soft_delete	bool Specifies whether to bypass the gallery's soft-delete policy and permanently delete the gallery image version. If true, the version is not retained in the recycle bin and cannot be restored. If false or omitted, the version is soft-deleted when the gallery's soft-delete policy is enabled and permanently deleted when the policy is disabled. Default value is None. Default value: None

Returns

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

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. 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_version_name Required	str The name of the gallery image version to be retrieved. Required.
gallery_image_version Required	GalleryImageVersionUpdate or 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 GalleryImageVersion. The GalleryImageVersion is compatible with MutableMapping

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. 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_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. Default value: None

Returns

Type	Description
GalleryImageVersion	GalleryImageVersion. The GalleryImageVersion is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_gallery_image

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) -> ItemPaged[GalleryImageVersion]

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
ItemPaged[GalleryImageVersion]	An iterator like instance of GalleryImageVersion

Exceptions

Type	Description
HttpResponseError

Comentarios

¿Le ha resultado útil esta página?