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
|
The name of the resource group. The name is case insensitive. Required. |
|
gallery_name
Required
|
The name of the Shared Image Gallery. Required. |
|
gallery_image_name
Required
|
The name of the gallery image definition to be retrieved. 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. The name is case insensitive. Required. |
|
gallery_name
Required
|
The name of the Shared Image Gallery. Required. |
|
gallery_image_name
Required
|
The name of the gallery image definition to be retrieved. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
gallery_name
Required
|
The name of the Shared Image Gallery. Required. |
|
gallery_image_name
Required
|
The name of the gallery image definition to be retrieved. Required. |
|
gallery_image
Required
|
Parameters supplied to the update gallery image operation. Is either a GalleryImageUpdate 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 |
|---|---|
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. The name is case insensitive. Required. |
|
gallery_name
Required
|
The name of the Shared Image Gallery. 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) -> AsyncItemPaged[GalleryImage]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
gallery_name
Required
|
The name of the Shared Image Gallery. 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.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv89\\Lib\\site-packages\\azure\\mgmt\\compute\\models\\__init__.py'>