ArchivesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ContainerRegistryManagementClient's
<xref:archives> attribute.
- Inheritance
-
builtins.objectArchivesOperations
Constructor
ArchivesOperations(*args, **kwargs)
Methods
begin_create |
Creates a archive for a container registry with the specified parameters. |
begin_delete |
Deletes a archive from a container registry. |
get |
Gets the properties of the archive. |
list |
Lists all archives for the specified container registry and package type. |
update |
Updates a archive for a container registry with the specified parameters. |
begin_create
Creates a archive for a container registry with the specified parameters.
async begin_create(resource_group_name: str, registry_name: str, package_type: str, archive_name: str, archive_create_parameters: _models.Archive, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Archive]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
registry_name
Required
|
The name of the container registry. Required. |
package_type
Required
|
The type of the package resource. Required. |
archive_name
Required
|
The name of the archive resource. Required. |
archive_create_parameters
Required
|
The parameters for creating a archive. Is either a Archive type or a IO type. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of AsyncLROPoller that returns either Archive or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_delete
Deletes a archive from a container registry.
async begin_delete(resource_group_name: str, registry_name: str, package_type: str, archive_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. |
registry_name
Required
|
The name of the container registry. Required. |
package_type
Required
|
The type of the package resource. Required. |
archive_name
Required
|
The name of the archive resource. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get
Gets the properties of the archive.
async get(resource_group_name: str, registry_name: str, package_type: str, archive_name: str, **kwargs: Any) -> Archive
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
registry_name
Required
|
The name of the container registry. Required. |
package_type
Required
|
The type of the package resource. Required. |
archive_name
Required
|
The name of the archive resource. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
Archive or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list
Lists all archives for the specified container registry and package type.
list(resource_group_name: str, registry_name: str, package_type: str, **kwargs: Any) -> AsyncIterable[Archive]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
registry_name
Required
|
The name of the container registry. Required. |
package_type
Required
|
The type of the package resource. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either Archive or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update
Updates a archive for a container registry with the specified parameters.
async update(resource_group_name: str, registry_name: str, package_type: str, archive_name: str, archive_update_parameters: _models.ArchiveUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Archive
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
registry_name
Required
|
The name of the container registry. Required. |
package_type
Required
|
The type of the package resource. Required. |
archive_name
Required
|
The name of the archive resource. Required. |
archive_update_parameters
Required
|
The parameters for updating a archive. Is either a ArchiveUpdateParameters type or a IO type. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
Archive or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.containerregistry.v2023_11_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\containerregistry\\v2023_11_01_preview\\models\\__init__.py'>
Azure SDK for Python