Feedback Edit

ContainerRegistryClient Class

  • Reference
Inheritance
azure.containerregistry._base_client.ContainerRegistryBaseClient
ContainerRegistryClient

Constructor

ContainerRegistryClient(endpoint: str, credential: Optional[TokenCredential] = None, **kwargs: Any)

Parameters

endpoint
credential
default value: None

Methods

delete_manifest

Delete a manifest. If the manifest cannot be found or a response status code of 404 is returned an error will not be raised.

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   client.delete_manifest("my_repository", "my_tag_or_digest")
delete_repository

Delete a repository. If the repository cannot be found or a response status code of 404 is returned an error will not be raised.
delete_tag

Delete a tag from a repository. If the tag cannot be found or a response status code of 404 is returned an error will not be raised.

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   for tag in client.list_tag_properties("my_repository"):
       client.delete_tag("my_repository", tag.name)
get_manifest_properties

Get the properties of a registry artifact

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   for artifact in client.list_manifest_properties("my_repository"):
       properties = client.get_manifest_properties("my_repository", artifact.digest)
get_repository_properties

Get the properties of a repository
get_tag_properties

Get the properties for a tag

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   for tag in client.list_tag_properties("my_repository"):
       tag_properties = client.get_tag_properties("my_repository", tag.name)
list_manifest_properties

List the artifacts for a repository
list_repository_names

List all repositories
list_tag_properties

List the tags for a repository

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   for tag in client.list_tag_properties("my_repository"):
       tag_properties = client.get_tag_properties("my_repository", tag.name)
update_manifest_properties

Set the permission properties for a manifest.

The updatable properties include: can_delete, can_list, can_read, and can_write.

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   for artifact in client.list_manifest_properties("my_repository"):
       received_properties = client.update_manifest_properties(
           "my_repository",
           artifact.digest,
           can_delete=False,
           can_list=False,
           can_read=False,
           can_write=False,
       )
update_repository_properties

Set the permission properties of a repository.

The updatable properties include: can_delete, can_list, can_read, and can_write.
update_tag_properties

Set the permission properties for a tag.

The updatable properties include: can_delete, can_list, can_read, and can_write.

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   tag_identifier = "latest"
   received = client.update_tag_properties(
       "my_repository",
       tag_identifier,
       can_delete=False,
       can_list=False,
       can_read=False,
       can_write=False,
   )

delete_manifest

Delete a manifest. If the manifest cannot be found or a response status code of 404 is returned an error will not be raised.

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   client.delete_manifest("my_repository", "my_tag_or_digest")

delete_manifest(repository: str, tag_or_digest: str, **kwargs: Any) -> None

Parameters

repository
str
Required

Name of the repository the manifest belongs to

tag_or_digest
str
Required

Tag or digest of the manifest to be deleted

Returns

None

Return type

None

Exceptions

HttpResponseError

delete_repository

Delete a repository. If the repository cannot be found or a response status code of 404 is returned an error will not be raised.

delete_repository(repository: str, **kwargs: Any) -> None

Parameters

repository
str
Required

The repository to delete

Returns

None

Return type

None

Exceptions

HttpResponseError

Examples

Delete a repository from the ContainerRegistryClient


               client.delete_repository(repository_name, tag.name)

delete_tag

Delete a tag from a repository. If the tag cannot be found or a response status code of 404 is returned an error will not be raised.

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   for tag in client.list_tag_properties("my_repository"):
       client.delete_tag("my_repository", tag.name)

delete_tag(repository: str, tag: str, **kwargs: Any) -> None

Parameters

repository
str
Required

Name of the repository the tag belongs to

tag
str
Required

The tag to be deleted

Returns

None

Return type

None

Exceptions

HttpResponseError

get_manifest_properties

Get the properties of a registry artifact

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   for artifact in client.list_manifest_properties("my_repository"):
       properties = client.get_manifest_properties("my_repository", artifact.digest)

get_manifest_properties(repository: str, tag_or_digest: str, **kwargs: Any) -> azure.containerregistry._models.ArtifactManifestProperties

Parameters

repository
str
Required

Name of the repository

tag_or_digest
str
Required

Tag or digest of the manifest

Return type

ArtifactManifestProperties

Exceptions

ResourceNotFoundError

get_repository_properties

Get the properties of a repository

get_repository_properties(repository: str, **kwargs: Any) -> azure.containerregistry._models.RepositoryProperties

Parameters

repository
str
Required

Name of the repository

Return type

RepositoryProperties

Exceptions

ResourceNotFoundError

get_tag_properties

Get the properties for a tag

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   for tag in client.list_tag_properties("my_repository"):
       tag_properties = client.get_tag_properties("my_repository", tag.name)

get_tag_properties(repository: str, tag: str, **kwargs: Any) -> azure.containerregistry._models.ArtifactTagProperties

Parameters

repository
str
Required

Name of the repository

tag
str
Required

The tag to get tag properties for

Return type

ArtifactTagProperties

Exceptions

ResourceNotFoundError

list_manifest_properties

List the artifacts for a repository

list_manifest_properties(repository: str, **kwargs: Any) -> azure.core.paging.ItemPaged[azure.containerregistry._models.ArtifactManifestProperties]

Parameters

repository
str
Required

Name of the repository

order_by
ArtifactManifestOrder or str

Query parameter for ordering by time ascending or descending

results_per_page
int

Number of repositories to return per page

Returns

An iterable of ArtifactManifestProperties

Return type

ItemPaged[ArtifactManifestProperties]

Exceptions

ResourceNotFoundError

list_repository_names

List all repositories

list_repository_names(**kwargs: Any) -> azure.core.paging.ItemPaged[str]

Parameters

results_per_page
int

Number of repositories to return per page

Returns

An iterable of strings

Return type

ItemPaged[str]

Exceptions

HttpResponseError

Examples

List repositories in a container registry account


   audience = "https://management.azure.com"
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]

   with ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience=audience) as client:
       for repository in client.list_repository_names():
           print(repository)

list_tag_properties

List the tags for a repository

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   for tag in client.list_tag_properties("my_repository"):
       tag_properties = client.get_tag_properties("my_repository", tag.name)

list_tag_properties(repository: str, **kwargs: Any) -> azure.core.paging.ItemPaged[azure.containerregistry._models.ArtifactTagProperties]

Parameters

repository
str
Required

Name of the repository

order_by
ArtifactTagOrder or str

Query parameter for ordering by time ascending or descending

results_per_page
int

Number of repositories to return per page

Returns

An iterable of ArtifactTagProperties

Return type

ItemPaged[ArtifactTagProperties]

Exceptions

ResourceNotFoundError

update_manifest_properties

Set the permission properties for a manifest.

The updatable properties include: can_delete, can_list, can_read, and can_write.

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   for artifact in client.list_manifest_properties("my_repository"):
       received_properties = client.update_manifest_properties(
           "my_repository",
           artifact.digest,
           can_delete=False,
           can_list=False,
           can_read=False,
           can_write=False,
       )

update_manifest_properties(repository, tag_or_digest, properties, **kwargs)

Parameters

repository
str
Required

Repository the manifest belongs to.

tag_or_digest
str
Required

Tag or digest of the manifest.

properties
ArtifactManifestProperties
Required

The property's values to be set. This is a positional-only parameter. Please provide either this or individual keyword parameters.

can_delete
bool

Delete permissions for a manifest.

can_list
bool

List permissions for a manifest.

can_read
bool

Read permissions for a manifest.

can_write
bool

Write permissions for a manifest.

Return type

ArtifactManifestProperties

Exceptions

ResourceNotFoundError

update_repository_properties

Set the permission properties of a repository.

The updatable properties include: can_delete, can_list, can_read, and can_write.

update_repository_properties(repository, properties, **kwargs)

Parameters

repository
str
Required

Name of the repository.

properties
RepositoryProperties
Required

Properties to set for the repository. This is a positional-only parameter. Please provide either this or individual keyword parameters.

can_delete
bool

Delete permissions for a repository.

can_list
bool

List permissions for a repository.

can_read
bool

Read permissions for a repository.

can_write
bool

Write permissions for a repository.

Return type

RepositoryProperties

Exceptions

ResourceNotFoundError

update_tag_properties

Set the permission properties for a tag.

The updatable properties include: can_delete, can_list, can_read, and can_write.

Example


   from azure.containerregistry import ContainerRegistryClient
   from azure.identity import DefaultAzureCredential
   endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
   client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience="my_audience")
   tag_identifier = "latest"
   received = client.update_tag_properties(
       "my_repository",
       tag_identifier,
       can_delete=False,
       can_list=False,
       can_read=False,
       can_write=False,
   )

update_tag_properties(repository, tag, properties, **kwargs)

Parameters

repository
str
Required

Repository the tag belongs to.

tag
str
Required

Tag to set properties for.

properties
ArtifactTagProperties
Required

The property's values to be set. This is a positional-only parameter. Please provide either this or individual keyword parameters.

can_delete
bool

Delete permissions for a tag.

can_list
bool

List permissions for a tag.

can_read
bool

Read permissions for a tag.

can_write
bool

Write permissions for a tag.

Return type

ArtifactTagProperties

Exceptions

ResourceNotFoundError