RegistriesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ContainerRegistryManagementClient's
<xref:registries> attribute.
- Inheritance
-
builtins.objectRegistriesOperations
Constructor
RegistriesOperations(*args, **kwargs)
Methods
begin_create |
Creates 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. |
delete |
Deletes a container registry. |
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. |
regenerate_credential |
Regenerates one of the login credentials for the specified container registry. |
update |
Updates a container registry with the specified parameters. |
begin_create
Creates a container registry with the specified parameters.
async begin_create(resource_group_name: str, registry_name: str, registry_create_parameters: _models.RegistryCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Registry]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group to which the container registry belongs. Required. |
registry_name
Required
|
The name of the container registry. Required. |
registry_create_parameters
Required
|
The parameters for creating a container registry. Is either a RegistryCreateParameters 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 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.
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
|
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
|
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 |
---|---|
RegistryNameStatus or the result of cls(response) |
Exceptions
Type | Description |
---|---|
delete
Deletes a container registry.
async delete(resource_group_name: str, registry_name: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group to which the container registry belongs. Required. |
registry_name
Required
|
The name of the container registry. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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
|
The name of the resource group to which the container registry belongs. Required. |
registry_name
Required
|
The name of the container registry. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
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) -> AsyncIterable[Registry]
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 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) -> AsyncIterable[Registry]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group to which the container registry belongs. 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 Registry or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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
|
The name of the resource group to which the container registry belongs. Required. |
registry_name
Required
|
The name of the container registry. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
RegistryListCredentialsResult or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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
|
The name of the resource group to which the container registry belongs. Required. |
registry_name
Required
|
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 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 |
---|---|
RegistryListCredentialsResult or the result of cls(response) |
Exceptions
Type | Description |
---|---|
update
Updates a container registry with the specified parameters.
async update(resource_group_name: str, registry_name: str, registry_update_parameters: _models.RegistryUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Registry
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group to which the container registry belongs. Required. |
registry_name
Required
|
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 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 |
---|---|
Registry or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.containerregistry.v2017_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\containerregistry\\v2017_03_01\\models\\__init__.py'>
Azure SDK for Python