azure.containerregistry.aio package¶

class azure.containerregistry.aio.ContainerRegistryClient(endpoint: str, credential: AsyncTokenCredential, **kwargs: Dict[str, Any])[source]¶

Create a ContainerRegistryClient from an endpoint and a credential

Parameters

endpoint (str) – An ACR endpoint
credential (AsyncTokenCredential) – The credential with which to authenticate

Returns

None

Raises

None

async close() → None ¶: Close sockets opened by the client. Calling this method is unnecessary when using the client as a context manager.

async delete_repository(repository: str, **kwargs: Dict[str, Any]) → azure.containerregistry._models.DeletedRepositoryResult[source]¶

Delete a repository

Parameters: repository (str) – The repository to delete
Returns: Object containing information about the deleted repository
Return type: DeletedRepositoryResult
Raises: ResourceNotFoundError

get_repository_client(repository: str, **kwargs: Dict[str, Any]) → azure.containerregistry.aio._async_container_repository_client.ContainerRepositoryClient[source]¶

Get a repository client

Parameters: repository (str) – The repository to create a client for
Returns: ContainerRepositoryClient

list_repositories(**kwargs: Dict[str, Any]) → azure.core.async_paging.AsyncItemPaged[str][source]¶

List all repositories

Keyword Arguments

last (str) – Query parameter for the last item in the previous call. Ensuing call will return values after last lexicallyy
max (int) – Maximum number of repositories to return
results_per_page (int) – Number of repositories to return per page

Returns

ItemPaged[str]

Return type

AsyncItemPaged

Raises

ResourceNotFoundError

class azure.containerregistry.aio.ContainerRepositoryClient(endpoint: str, repository: str, credential: AsyncTokenCredential, **kwargs: Dict[str, Any])[source]¶

Create a ContainerRepositoryClient from an endpoint, repository name, and credential

Parameters

endpoint (str) – An ACR endpoint
repository (str) – The name of a repository
credential (AsyncTokenCredential) – The credential with which to authenticate

Returns

None

Raises

None

async close() → None ¶: Close sockets opened by the client. Calling this method is unnecessary when using the client as a context manager.

async delete(**kwargs: Dict[str, Any]) → azure.containerregistry._models.DeletedRepositoryResult[source]¶

Delete a repository

Returns: Object containing information about the deleted repository
Return type: DeletedRepositoryResult
Raises: ResourceNotFoundError

async delete_registry_artifact(digest: str, **kwargs: Dict[str, Any]) → None [source]¶

Delete a registry artifact

Parameters: digest (str) – The digest of the artifact to be deleted
Returns: None
Raises: ResourceNotFoundError

async delete_tag(tag: str, **kwargs: Dict[str, Any]) → None [source]¶

Delete a tag from a repository

Parameters: tag (str) – The tag to be deleted
Returns: None
Raises: ResourceNotFoundError

async get_properties(**kwargs: Dict[str, Any]) → azure.containerregistry._models.RepositoryProperties[source]¶

Get the properties of a repository

Returns: RepositoryProperties
Raises: ResourceNotFoundError

async get_registry_artifact_properties(tag_or_digest: str, **kwargs: Dict[str, Any]) → azure.containerregistry._models.RegistryArtifactProperties[source]¶

Get the properties of a registry artifact

Parameters: tag_or_digest (str) – The tag/digest of a registry artifact
Returns: RegistryArtifactProperties
Raises: ResourceNotFoundError

async get_tag_properties(tag: str, **kwargs: Dict[str, Any]) → azure.containerregistry._models.TagProperties[source]¶

Get the properties for a tag

Parameters: tag (str) – The tag to get properties for
Returns: TagProperties
Raises: ResourceNotFoundError

list_registry_artifacts(**kwargs: Dict[str, Any]) → azure.core.async_paging.AsyncItemPaged[azure.containerregistry._models.RegistryArtifactProperties][source]¶

List the artifacts for a repository

Keyword Arguments

last (str) – Query parameter for the last item in the previous call. Ensuing call will return values after last lexically
order_by (RegistryArtifactOrderBy) – Query parameter for ordering by time ascending or descending
results_per_page (int) – Number of repositories to return per page

Returns

ItemPaged[RegistryArtifactProperties]

Return type

AsyncItemPaged

Raises

ResourceNotFoundError

list_tags(**kwargs: Dict[str, Any]) → azure.core.async_paging.AsyncItemPaged[azure.containerregistry._models.TagProperties][source]¶

List the tags for a repository

Keyword Arguments

last (str) – Query parameter for the last item in the previous call. Ensuing call will return values after last lexically
order_by (TagOrderBy) – Query parameter for ordering by time ascending or descending
results_per_page (int) – Number of repositories to return per page

Returns

ItemPaged[TagProperties]

Return type

AsyncItemPaged

Raises

ResourceNotFoundError

async set_manifest_properties(digest: str, permissions: azure.containerregistry._models.ContentPermissions, **kwargs: Dict[str, Any]) → None [source]¶

Set the properties for a manifest

Parameters

digest (str) – Digest of a manifest
permissions (ContentPermissions) – The property’s values to be set

Returns

RegistryArtifactProperties

Raises

ResourceNotFoundError

async set_tag_properties(tag: str, permissions: azure.containerregistry._models.ContentPermissions, **kwargs: Dict[str, Any]) → azure.containerregistry._models.TagProperties[source]¶

Set the properties for a tag

Parameters

tag (str) – Tag to set properties for
permissions (ContentPermissions) – The property’s values to be set

Returns

TagProperties

Raises

ResourceNotFoundError