RegistriesOperations Class

RegistriesOperations 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
RegistriesOperations

Constructor

RegistriesOperations(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

Creates a container registry with the specified parameters.

begin_delete

Deletes a container registry.

begin_generate_credentials

Generate keys for a token of a specified container registry.

begin_import_image

Copies an image to this container registry from the specified container registry.

begin_update

Updates a container registry with the specified parameters.

check_name_availability

Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length.

get

Gets the properties of the specified container registry.

get_private_link_resource

Gets a private link resource by a specified group name for a container registry.

list

Lists all the container registries under the specified subscription.

list_by_resource_group

Lists all the container registries under the specified resource group.

list_credentials

Lists the login credentials for the specified container registry.

list_private_link_resources

Lists the private link resources for a container registry.

list_usages

Gets the quota usages for the specified container registry.

regenerate_credential

Regenerates one of the login credentials for the specified container registry.

begin_create

Creates a container registry with the specified parameters.

async begin_create(resource_group_name: str, registry_name: str, registry: azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.Registry, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.Registry]

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

registry_name
str
Required

The name of the container registry.

registry
Registry
Required

The parameters for creating a container registry.

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 Registry or the result of cls(response)

Return type

Exceptions

begin_delete

Deletes a container registry.

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

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

registry_name
str
Required

The name of the container registry.

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_generate_credentials

Generate keys for a token of a specified container registry.

async begin_generate_credentials(resource_group_name: str, registry_name: str, generate_credentials_parameters: azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.GenerateCredentialsParameters, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.GenerateCredentialsResult]

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

registry_name
str
Required

The name of the container registry.

generate_credentials_parameters
GenerateCredentialsParameters
Required

The parameters for generating credentials.

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 GenerateCredentialsResult or the result of cls(response)

Return type

Exceptions

begin_import_image

Copies an image to this container registry from the specified container registry.

async begin_import_image(resource_group_name: str, registry_name: str, parameters: azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.ImportImageParameters, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

registry_name
str
Required

The name of the container registry.

parameters
ImportImageParameters
Required

The parameters specifying the image to copy and the source container registry.

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

Updates a container registry with the specified parameters.

async begin_update(resource_group_name: str, registry_name: str, registry_update_parameters: azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.RegistryUpdateParameters, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.Registry]

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

registry_name
str
Required

The name of the container registry.

registry_update_parameters
RegistryUpdateParameters
Required

The parameters for updating a container registry.

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 Registry or the result of cls(response)

Return type

Exceptions

check_name_availability

Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length.

async check_name_availability(registry_name_check_request: azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.RegistryNameCheckRequest, **kwargs: Any) -> azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.RegistryNameStatus

Parameters

registry_name_check_request
RegistryNameCheckRequest
Required

The object containing information for the availability request.

cls
callable

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

Returns

RegistryNameStatus, or the result of cls(response)

Return type

Exceptions

get

Gets the properties of the specified container registry.

async get(resource_group_name: str, registry_name: str, **kwargs: Any) -> azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.Registry

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

registry_name
str
Required

The name of the container registry.

cls
callable

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

Returns

Registry, or the result of cls(response)

Return type

Exceptions

Gets a private link resource by a specified group name for a container registry.

async get_private_link_resource(resource_group_name: str, registry_name: str, group_name: str, **kwargs: Any) -> azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.PrivateLinkResource

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

registry_name
str
Required

The name of the container registry.

group_name
str
Required

The name of the private link resource.

cls
callable

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

Returns

PrivateLinkResource, or the result of cls(response)

Return type

Exceptions

list

Lists all the container registries under the specified subscription.

list(**kwargs: Any) -> AsyncIterable[azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.RegistryListResult]

Parameters

cls
callable

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

Returns

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

Return type

Exceptions

list_by_resource_group

Lists all the container registries under the specified resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.RegistryListResult]

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

cls
callable

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

Returns

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

Return type

Exceptions

list_credentials

Lists the login credentials for the specified container registry.

async list_credentials(resource_group_name: str, registry_name: str, **kwargs: Any) -> azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.RegistryListCredentialsResult

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

registry_name
str
Required

The name of the container registry.

cls
callable

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

Returns

RegistryListCredentialsResult, or the result of cls(response)

Return type

Exceptions

Lists the private link resources for a container registry.

list_private_link_resources(resource_group_name: str, registry_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.PrivateLinkResourceListResult]

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

registry_name
str
Required

The name of the container registry.

cls
callable

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

Returns

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

Return type

Exceptions

list_usages

Gets the quota usages for the specified container registry.

async list_usages(resource_group_name: str, registry_name: str, **kwargs: Any) -> azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.RegistryUsageListResult

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

registry_name
str
Required

The name of the container registry.

cls
callable

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

Returns

RegistryUsageListResult, or the result of cls(response)

Return type

Exceptions

regenerate_credential

Regenerates one of the login credentials for the specified container registry.

async regenerate_credential(resource_group_name: str, registry_name: str, regenerate_credential_parameters: azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.RegenerateCredentialParameters, **kwargs: Any) -> azure.mgmt.containerregistry.v2021_12_01_preview.models._models_py3.RegistryListCredentialsResult

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

registry_name
str
Required

The name of the container registry.

regenerate_credential_parameters
RegenerateCredentialParameters
Required

Specifies name of the password which should be regenerated – password or password2.

cls
callable

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

Returns

RegistryListCredentialsResult, or the result of cls(response)

Return type

Exceptions

Attributes

models

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