ImagesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:images> attribute.
- Inheritance
-
builtins.objectImagesOperations
Constructor
ImagesOperations(*args, **kwargs)
Methods
begin_create_or_update |
Create or update an image. |
begin_delete |
Deletes an Image. |
begin_update |
Update an image. |
get |
Gets an image. |
list |
Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images. |
list_by_resource_group |
Gets the list of images under a resource group. |
begin_create_or_update
Create or update an image.
async begin_create_or_update(resource_group_name: str, image_name: str, parameters: _models.Image, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Image]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
image_name
Required
|
The name of the image. Required. |
parameters
Required
|
Parameters supplied to the Create Image operation. Is either a Image type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of AsyncLROPoller that returns either Image or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_delete
Deletes an Image.
async begin_delete(resource_group_name: str, image_name: str, **kwargs: Any) -> AsyncLROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
image_name
Required
|
The name of the image. Required. |
Returns
Type | Description |
---|---|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_update
Update an image.
async begin_update(resource_group_name: str, image_name: str, parameters: _models.ImageUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Image]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
image_name
Required
|
The name of the image. Required. |
parameters
Required
|
Parameters supplied to the Update Image operation. Is either a ImageUpdate type or a IO[bytes] type. Required. |
Returns
Type | Description |
---|---|
An instance of AsyncLROPoller that returns either Image or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get
Gets an image.
async get(resource_group_name: str, image_name: str, *, expand: str | None = None, **kwargs: Any) -> Image
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
image_name
Required
|
The name of the image. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
expand
|
The expand expression to apply on the operation. Default value is None. |
Returns
Type | Description |
---|---|
Image or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list
Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.
list(**kwargs: Any) -> AsyncIterable[Image]
Returns
Type | Description |
---|---|
An iterator like instance of either Image or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_by_resource_group
Gets the list of images under a resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[Image]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. Required. |
Returns
Type | Description |
---|---|
An iterator like instance of either Image or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.compute.v2019_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2019_12_01\\models\\__init__.py'>
Azure SDK for Python