GalleryImagesOperations Class

GalleryImagesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
GalleryImagesOperations

Constructor

GalleryImagesOperations(client, config, serializer, deserializer)

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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: azure.mgmt.compute.v2020_09_30.models._models_py3.GalleryImage, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.compute.v2020_09_30.models._models_py3.GalleryImage]

Parameters

resource_group_name
str
Required

The name of the resource group.

gallery_name
str
Required

The name of the Shared Image Gallery in which the Image Definition is to be created.

gallery_image_name
str
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.

gallery_image
GalleryImage
Required

Parameters supplied to the create or update gallery image operation.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Exceptions

begin_delete

Delete a gallery image.

async begin_delete(resource_group_name: str, gallery_name: str, gallery_image_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group.

gallery_name
str
Required

The name of the Shared Image Gallery in which the Image Definition is to be deleted.

gallery_image_name
str
Required

The name of the gallery image definition to be deleted.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Exceptions

begin_update

Update a gallery image definition.

async begin_update(resource_group_name: str, gallery_name: str, gallery_image_name: str, gallery_image: azure.mgmt.compute.v2020_09_30.models._models_py3.GalleryImageUpdate, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.compute.v2020_09_30.models._models_py3.GalleryImage]

Parameters

resource_group_name
str
Required

The name of the resource group.

gallery_name
str
Required

The name of the Shared Image Gallery in which the Image Definition is to be updated.

gallery_image_name
str
Required

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.

gallery_image
GalleryImageUpdate
Required

Parameters supplied to the update gallery image operation.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Exceptions

get

Retrieves information about a gallery image definition.

async get(resource_group_name: str, gallery_name: str, gallery_image_name: str, **kwargs: Any) -> azure.mgmt.compute.v2020_09_30.models._models_py3.GalleryImage

Parameters

resource_group_name
str
Required

The name of the resource group.

gallery_name
str
Required

The name of the Shared Image Gallery from which the Image Definitions are to be retrieved.

gallery_image_name
str
Required

The name of the gallery image definition to be retrieved.

cls
callable

A custom type or function that will be passed the direct response

Returns

GalleryImage, or the result of cls(response)

Return type

Exceptions

List gallery image definitions in a gallery.

list_by_gallery(resource_group_name: str, gallery_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.compute.v2020_09_30.models._models_py3.GalleryImageList]

Parameters

resource_group_name
str
Required

The name of the resource group.

gallery_name
str
Required

The name of the Shared Image Gallery from which Image Definitions are to be listed.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.compute.v2020_09_30.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\compute\\v2020_09_30\\models\\__init__.py'>