GalleryImagesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:gallery_images> attribute.
- Inheritance
-
builtins.objectGalleryImagesOperations
Constructor
GalleryImagesOperations(*args, **kwargs)Methods
| begin_create_or_update |
Create or update a gallery Image Definition. |
| begin_delete |
Delete a gallery image. |
| 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
|
The name of the resource group. Required. |
|
gallery_name
Required
|
The name of the Shared Image Gallery in which the Image Definition is to be created. Required. |
|
gallery_image_name
Required
|
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
|
Parameters supplied to the create or update gallery image operation. Is either a GalleryImage type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either GalleryImage or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. Required. |
|
gallery_name
Required
|
The name of the Shared Image Gallery in which the Image Definition is to be deleted. Required. |
|
gallery_image_name
Required
|
The name of the gallery Image Definition to be deleted. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Retrieves information about a gallery Image Definition.
async get(resource_group_name: str, gallery_name: str, gallery_image_name: str, **kwargs: Any) -> GalleryImageParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
gallery_name
Required
|
The name of the Shared Image Gallery from which the Image Definitions are to be retrieved. Required. |
|
gallery_image_name
Required
|
The name of the gallery Image Definition to be retrieved. Required. |
Returns
| Type | Description |
|---|---|
|
GalleryImage or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_gallery
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
|
The name of the resource group. Required. |
|
gallery_name
Required
|
The name of the Shared Image Gallery from which Image Definitions are to be listed. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either GalleryImage or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.compute.v2019_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2019_03_01\\models\\__init__.py'>
Azure SDK for Python