Share via

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

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. The name is case insensitive. Required.
registry_name
Required
str

The name of the container registry. Required.
registry
Required
Registry or <xref:JSON> or IO[bytes]

The parameters for creating a container registry. Is one of the following types: Registry, JSON, IO[bytes] Required.

Returns

Type Description
LROPoller[Registry]

An instance of LROPoller that returns Registry. The Registry is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

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. The name is case insensitive. Required.
registry_name
Required
str

The name of the container registry. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns None

Exceptions

Type Description
HttpResponseError

begin_generate_credentials

Generate keys for a token of a specified container registry.

begin_generate_credentials(resource_group_name: str, registry_name: str, generate_credentials_parameters: _models.GenerateCredentialsParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenerateCredentialsResult]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
registry_name
Required
str

The name of the container registry. Required.
generate_credentials_parameters
Required
GenerateCredentialsParameters or <xref:JSON> or IO[bytes]

The parameters for generating credentials. Is one of the following types: GenerateCredentialsParameters, JSON, IO[bytes] Required.

Returns

Type Description
LROPoller[GenerateCredentialsResult]

An instance of LROPoller that returns GenerateCredentialsResult. The GenerateCredentialsResult is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

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. The name is case insensitive. Required.
registry_name
Required
str

The name of the container registry. Required.
parameters
Required
ImportImageParameters or <xref:JSON> or IO[bytes]

The parameters specifying the image to copy and the source container registry. Is one of the following types: ImportImageParameters, JSON, IO[bytes] Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns None

Exceptions

Type Description
HttpResponseError

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. The name is case insensitive. Required.
registry_name
Required
str

The name of the container registry. Required.
registry_update_parameters
Required
RegistryUpdateParameters or <xref:JSON> or IO[bytes]

The parameters for updating a container registry. Is one of the following types: RegistryUpdateParameters, JSON, IO[bytes] Required.

Returns

Type Description
LROPoller[Registry]

An instance of LROPoller that returns Registry. The Registry is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

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
RegistryNameCheckRequest or <xref:JSON> or IO[bytes]

The request body. Is one of the following types: RegistryNameCheckRequest, JSON, IO[bytes] Required.

Returns

Type Description
RegistryNameStatus

RegistryNameStatus. The RegistryNameStatus is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

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. The name is case insensitive. Required.
registry_name
Required
str

The name of the container registry. Required.

Returns

Type Description
Registry

Registry. The Registry is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

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

get_private_link_resource(resource_group_name: str, registry_name: str, group_name: str, **kwargs: Any) -> PrivateLinkResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
registry_name
Required
str

The name of the container registry. Required.
group_name
Required
str

The name of the private link associated with the Azure resource. Required.

Returns

Type Description
PrivateLinkResource

PrivateLinkResource. The PrivateLinkResource is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

list

Lists all the container registries under the specified subscription.

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

Returns

Type Description
ItemPaged[Registry]

An iterator like instance of Registry

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Lists all the container registries under the specified resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

Returns

Type Description
ItemPaged[Registry]

An iterator like instance of Registry

Exceptions

Type Description
HttpResponseError

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. The name is case insensitive. Required.
registry_name
Required
str

The name of the container registry. Required.

Returns

Type Description
RegistryListCredentialsResult

RegistryListCredentialsResult. The RegistryListCredentialsResult is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

Lists the private link resources for a container registry.

list_private_link_resources(resource_group_name: str, registry_name: str, **kwargs: Any) -> ItemPaged[PrivateLinkResource]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
registry_name
Required
str

The name of the container registry. Required.

Returns

Type Description
ItemPaged[PrivateLinkResource]

An iterator like instance of PrivateLinkResource

Exceptions

Type Description
HttpResponseError

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. The name is case insensitive. Required.
registry_name
Required
str

The name of the container registry. Required.

Returns

Type Description
RegistryUsageListResult

RegistryUsageListResult. The RegistryUsageListResult is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

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. The name is case insensitive. Required.
registry_name
Required
str

The name of the container registry. Required.
regenerate_credential_parameters
Required
RegenerateCredentialParameters or <xref:JSON> or IO[bytes]

Specifies name of the password which should be regenerated – password or password2. Is one of the following types: RegenerateCredentialParameters, JSON, IO[bytes] Required.

Returns

Type Description
RegistryListCredentialsResult

RegistryListCredentialsResult. The RegistryListCredentialsResult is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError