RegistriesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerRegistryManagementClient's

<xref:registries> attribute.

Inheritance

builtins.object

RegistriesOperations

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.

async begin_create(resource_group_name: str, registry_name: str, registry: _models.Registry, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_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 IO The parameters for creating a container registry. Is either a Registry type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
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

Type	Description
AsyncLROPoller[Registry]	An instance of AsyncLROPoller that returns either Registry or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a container registry.

async begin_delete(resource_group_name: str, registry_name: str, **kwargs: Any) -> AsyncLROPoller[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.

Keyword-Only Parameters

Name	Description
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

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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: _models.GenerateCredentialsParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_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 IO The parameters for generating credentials. Is either a GenerateCredentialsParameters type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
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

Type	Description
AsyncLROPoller[GenerateCredentialsResult]	An instance of AsyncLROPoller that returns either GenerateCredentialsResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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: _models.ImportImageParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[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 IO The parameters specifying the image to copy and the source container registry. Is either a ImportImageParameters type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
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

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates a container registry with the specified parameters.

async begin_update(resource_group_name: str, registry_name: str, registry_update_parameters: _models.RegistryUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_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 IO The parameters for updating a container registry. Is either a RegistryUpdateParameters type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
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

Type	Description
AsyncLROPoller[Registry]	An instance of AsyncLROPoller that returns either Registry or the result of cls(response)

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.

async 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 IO The object containing information for the availability request. Is either a RegistryNameCheckRequest type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
RegistryNameStatus	RegistryNameStatus or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the properties of the specified container registry.

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Registry	Registry or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_private_link_resource

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) -> 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 resource. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
PrivateLinkResource	PrivateLinkResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists all the container registries under the specified subscription.

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[Registry]	An iterator like instance of either Registry or the result of cls(response)

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) -> AsyncIterable[Registry]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[Registry]	An iterator like instance of either Registry or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_credentials

Lists the login credentials for the specified container registry.

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
RegistryListCredentialsResult	RegistryListCredentialsResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_private_link_resources

Lists the private link resources for a container registry.

list_private_link_resources(resource_group_name: str, registry_name: str, **kwargs: Any) -> AsyncIterable[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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[PrivateLinkResource]	An iterator like instance of either PrivateLinkResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_usages

Gets the quota usages for the specified container registry.

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
RegistryUsageListResult	RegistryUsageListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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: _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 IO Specifies name of the password which should be regenerated – password or password2. Is either a RegenerateCredentialParameters type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
RegistryListCredentialsResult	RegistryListCredentialsResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.containerregistry.v2023_01_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\containerregistry\\v2023_01_01_preview\\models\\__init__.py'>