Registry / azure / azure-containerregistry

azure-containerregistry

library1.2.0pypypi✓ verified 24d ago

The Microsoft Azure Container Registry Client Library for Python provides an interface to interact with Azure Container Registry (ACR) services. It allows developers to manage container images, repositories, and other artifacts stored in ACR. The library is currently at version 1.2.0 and follows the Azure SDK for Python's regular release cadence, ensuring updates and feature parity with the service.

azure devops

pip install azure-containerregistry azure-identity

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · AZURE-CONTAINERREG

azure-containerregistry

azurepythonv1.2.0

Install

3.8s avg

Import

436ms

Disk

43MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.2.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.452s · 43.9MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 3.8s · import 0.420s · 44MB

43MB installed

● package 43MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ContainerRegistryClient

✓ from azure.containerregistry import ContainerRegistryClient

DefaultAzureCredential

✓ from azure.identity import DefaultAzureCredential

Required for authentication using Azure Identity.

This quickstart demonstrates how to authenticate with Azure Container Registry using `DefaultAzureCredential` and then list all repository names within the specified registry. Ensure the `AZURE_CONTAINER_REGISTRY_URL` environment variable is set to your registry's URL (e.g., `https://myregistry.azurecr.io`) and that your authenticated identity has sufficient permissions (e.g., 'AcrPull' role).

import os from azure.containerregistry import ContainerRegistryClient from azure.identity import DefaultAzureCredential # Set your ACR endpoint, e.g., 'https://myregistry.azurecr.io' registry_url = os.environ.get('AZURE_CONTAINER_REGISTRY_URL', 'https://yourregistryname.azurecr.io') # DefaultAzureCredential will try various authentication methods # (environment variables, managed identity, VS Code, Azure CLI, etc.) credential = DefaultAzureCredential() client = ContainerRegistryClient(endpoint=registry_url, credential=credential) try: print(f"Listing repositories in {registry_url}:") for repository_name in client.list_repository_names(): print(f"- {repository_name}") except Exception as e: print(f"An error occurred: {e}") finally: client.close() credential.close()

Debug

Known issues

gotchaAuthentication with Azure Container Registry requires the `azure-identity` package and proper credential setup. `DefaultAzureCredential` is the recommended way, but relies on environment variables (e.g., `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, `AZURE_TENANT_ID`) or other configured Azure SDK authentication methods. Without correct setup, authentication will fail.

fix

Ensure `pip install azure-identity` is run and that your environment variables are correctly configured for `DefaultAzureCredential`, or explicitly pass other credential types. Refer to Azure Identity documentation for detailed setup.

affects: All versions

gotchaThe authenticated identity (e.g., service principal, managed identity, user account) must have appropriate Azure RBAC roles assigned to the Container Registry. Common roles include `AcrPull` (read-only), `AcrPush` (read/write), or `Owner`/`Contributor` for full management. Insufficient permissions will result in authorization errors.

fix

Verify that the Azure AD principal used for authentication has the necessary permissions granted on the Azure Container Registry resource in the Azure portal or via Azure CLI/PowerShell.

affects: All versions

gotchaThis library (`azure-containerregistry`) is the data-plane client for interacting with repositories, images, and manifests. It should not be confused with the management-plane client (`azure-mgmt-containerregistry`), which is used for creating, updating, and deleting the Container Registry *resource itself*.

fix

If you intend to manage the ACR resource (e.g., create/delete registries, configure geo-replication), use `azure-mgmt-containerregistry`. If you need to push/pull images, list repositories, or manage manifests within an existing registry, use `azure-containerregistry`.

affects: All versions

Upgrade

Version history

1.2.0latest on PyPI · released Jul 11, 2023

Audit

Dependencies

azure-identityrequiredRequired for authentication with Azure services, including Azure Container Registry. Provides various credential types like DefaultAzureCredential.

Agent activity

50 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

githubhttps://github.com/Azure/azure-sdk-for-python ↗

packagehttps://pypi.org/project/azure-containerregistry/ ↗

homepagehttps://azure.microsoft.com/en-us/services/container-registry/ ↗