RegistriesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerRegistryManagementClient's

<xref:registries> attribute.

Constructor

RegistriesOperations(*args, **kwargs)

Methods

begin_create

Creates a container registry with the specified parameters.

begin_delete

Deletes a 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.

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_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.

begin_create(resource_group_name: str, registry_name: str, registry: _models.Registry, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Registry]

Parameters

Name Description
resource_group_name
Required
str

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

registry_name
Required
str

The name of the container registry. Required.

registry
Required

The parameters for creating a container registry. Is either a Registry type or a IO[bytes] type. Required.

Returns

Type Description

An instance of LROPoller that returns either Registry or the result of cls(response)

Exceptions

Type Description

begin_delete

Deletes a container registry.

begin_delete(resource_group_name: str, registry_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

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

registry_name
Required
str

The name of the container registry. Required.

Returns

Type Description

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

Exceptions

Type Description

begin_import_image

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

begin_import_image(resource_group_name: str, registry_name: str, parameters: _models.ImportImageParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

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

registry_name
Required
str

The name of the container registry. Required.

parameters
Required

The parameters specifying the image to copy and the source container registry. Is either a ImportImageParameters type or a IO[bytes] type. Required.

Returns

Type Description

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

Exceptions

Type Description

begin_update

Updates a container registry with the specified parameters.

begin_update(resource_group_name: str, registry_name: str, registry_update_parameters: _models.RegistryUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Registry]

Parameters

Name Description
resource_group_name
Required
str

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

registry_name
Required
str

The name of the container registry. Required.

registry_update_parameters
Required

The parameters for updating a container registry. Is either a RegistryUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description

An instance of LROPoller that returns either Registry or the result of cls(response)

Exceptions

Type Description

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.

check_name_availability(registry_name_check_request: _models.RegistryNameCheckRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RegistryNameStatus

Parameters

Name Description
registry_name_check_request
Required

The object containing information for the availability request. Is either a RegistryNameCheckRequest type or a IO[bytes] type. Required.

Returns

Type Description

RegistryNameStatus or the result of cls(response)

Exceptions

Type Description

get

Gets the properties of the specified container registry.

get(resource_group_name: str, registry_name: str, **kwargs: Any) -> Registry

Parameters

Name Description
resource_group_name
Required
str

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

registry_name
Required
str

The name of the container registry. Required.

Returns

Type Description

Registry or the result of cls(response)

Exceptions

Type Description

list

Lists all the container registries under the specified subscription.

list(**kwargs: Any) -> Iterable[Registry]

Returns

Type Description

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

Exceptions

Type Description

list_by_resource_group

Lists all the container registries under the specified resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[Registry]

Parameters

Name Description
resource_group_name
Required
str

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

Returns

Type Description

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

Exceptions

Type Description

list_credentials

Lists the login credentials for the specified container registry.

list_credentials(resource_group_name: str, registry_name: str, **kwargs: Any) -> RegistryListCredentialsResult

Parameters

Name Description
resource_group_name
Required
str

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

registry_name
Required
str

The name of the container registry. Required.

Returns

Type Description

RegistryListCredentialsResult or the result of cls(response)

Exceptions

Type Description

list_usages

Gets the quota usages for the specified container registry.

list_usages(resource_group_name: str, registry_name: str, **kwargs: Any) -> RegistryUsageListResult

Parameters

Name Description
resource_group_name
Required
str

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

registry_name
Required
str

The name of the container registry. Required.

Returns

Type Description

RegistryUsageListResult or the result of cls(response)

Exceptions

Type Description

regenerate_credential

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

regenerate_credential(resource_group_name: str, registry_name: str, regenerate_credential_parameters: _models.RegenerateCredentialParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RegistryListCredentialsResult

Parameters

Name Description
resource_group_name
Required
str

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

registry_name
Required
str

The name of the container registry. Required.

regenerate_credential_parameters
Required

Specifies name of the password which should be regenerated – password or password2. Is either a RegenerateCredentialParameters type or a IO[bytes] type. Required.

Returns

Type Description

RegistryListCredentialsResult or the result of cls(response)

Exceptions

Type Description

Attributes

models

models = <module 'azure.mgmt.containerregistry.v2019_05_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv91\\Lib\\site-packages\\azure\\mgmt\\containerregistry\\v2019_05_01\\models\\__init__.py'>