Azure Containerregistry Py

1---
2name: azure-containerregistry-py
3description: |
4  Azure Container Registry SDK for Python. Use for managing container images, artifacts, and repositories.
5  Triggers: "azure-containerregistry", "ContainerRegistryClient", "container images", "docker registry", "ACR".
6package: azure-containerregistry
7---
8 
9# Azure Container Registry SDK for Python
10 
11Manage container images, artifacts, and repositories in Azure Container Registry.
12 
13## Installation
14 
15```bash
16pip install azure-containerregistry
17```
18 
19## Environment Variables
20 
21```bash
22AZURE_CONTAINERREGISTRY_ENDPOINT=https://<registry-name>.azurecr.io
23```
24 
25## Authentication
26 
27### Entra ID (Recommended)
28 
29```python
30from azure.containerregistry import ContainerRegistryClient
31from azure.identity import DefaultAzureCredential
32 
33client = ContainerRegistryClient(
34    endpoint=os.environ["AZURE_CONTAINERREGISTRY_ENDPOINT"],
35    credential=DefaultAzureCredential()
36)
37```
38 
39### Anonymous Access (Public Registry)
40 
41```python
42from azure.containerregistry import ContainerRegistryClient
43 
44client = ContainerRegistryClient(
45    endpoint="https://mcr.microsoft.com",
46    credential=None,
47    audience="https://mcr.microsoft.com"
48)
49```
50 
51## List Repositories
52 
53```python
54client = ContainerRegistryClient(endpoint, DefaultAzureCredential())
55 
56for repository in client.list_repository_names():
57    print(repository)
58```
59 
60## Repository Operations
61 
62### Get Repository Properties
63 
64```python
65properties = client.get_repository_properties("my-image")
66print(f"Created: {properties.created_on}")
67print(f"Modified: {properties.last_updated_on}")
68print(f"Manifests: {properties.manifest_count}")
69print(f"Tags: {properties.tag_count}")
70```
71 
72### Update Repository Properties
73 
74```python
75from azure.containerregistry import RepositoryProperties
76 
77client.update_repository_properties(
78    "my-image",
79    properties=RepositoryProperties(
80        can_delete=False,
81        can_write=False
82    )
83)
84```
85 
86### Delete Repository
87 
88```python
89client.delete_repository("my-image")
90```
91 
92## List Tags
93 
94```python
95for tag in client.list_tag_properties("my-image"):
96    print(f"{tag.name}: {tag.created_on}")
97```
98 
99### Filter by Order
100 
101```python
102from azure.containerregistry import ArtifactTagOrder
103 
104# Most recent first
105for tag in client.list_tag_properties(
106    "my-image",
107    order_by=ArtifactTagOrder.LAST_UPDATED_ON_DESCENDING
108):
109    print(f"{tag.name}: {tag.last_updated_on}")
110```
111 
112## Manifest Operations
113 
114### List Manifests
115 
116```python
117from azure.containerregistry import ArtifactManifestOrder
118 
119for manifest in client.list_manifest_properties(
120    "my-image",
121    order_by=ArtifactManifestOrder.LAST_UPDATED_ON_DESCENDING
122):
123    print(f"Digest: {manifest.digest}")
124    print(f"Tags: {manifest.tags}")
125    print(f"Size: {manifest.size_in_bytes}")
126```
127 
128### Get Manifest Properties
129 
130```python
131manifest = client.get_manifest_properties("my-image", "latest")
132print(f"Digest: {manifest.digest}")
133print(f"Architecture: {manifest.architecture}")
134print(f"OS: {manifest.operating_system}")
135```
136 
137### Update Manifest Properties
138 
139```python
140from azure.containerregistry import ArtifactManifestProperties
141 
142client.update_manifest_properties(
143    "my-image",
144    "latest",
145    properties=ArtifactManifestProperties(
146        can_delete=False,
147        can_write=False
148    )
149)
150```
151 
152### Delete Manifest
153 
154```python
155# Delete by digest
156client.delete_manifest("my-image", "sha256:abc123...")
157 
158# Delete by tag
159manifest = client.get_manifest_properties("my-image", "old-tag")
160client.delete_manifest("my-image", manifest.digest)
161```
162 
163## Tag Operations
164 
165### Get Tag Properties
166 
167```python
168tag = client.get_tag_properties("my-image", "latest")
169print(f"Digest: {tag.digest}")
170print(f"Created: {tag.created_on}")
171```
172 
173### Delete Tag
174 
175```python
176client.delete_tag("my-image", "old-tag")
177```
178 
179## Upload and Download Artifacts
180 
181```python
182from azure.containerregistry import ContainerRegistryClient
183 
184client = ContainerRegistryClient(endpoint, DefaultAzureCredential())
185 
186# Download manifest
187manifest = client.download_manifest("my-image", "latest")
188print(f"Media type: {manifest.media_type}")
189print(f"Digest: {manifest.digest}")
190 
191# Download blob
192blob = client.download_blob("my-image", "sha256:abc123...")
193with open("layer.tar.gz", "wb") as f:
194    for chunk in blob:
195        f.write(chunk)
196```
197 
198## Async Client
199 
200```python
201from azure.containerregistry.aio import ContainerRegistryClient
202from azure.identity.aio import DefaultAzureCredential
203 
204async def list_repos():
205    credential = DefaultAzureCredential()
206    client = ContainerRegistryClient(endpoint, credential)
207    
208    async for repo in client.list_repository_names():
209        print(repo)
210    
211    await client.close()
212    await credential.close()
213```
214 
215## Clean Up Old Images
216 
217```python
218from datetime import datetime, timedelta, timezone
219 
220cutoff = datetime.now(timezone.utc) - timedelta(days=30)
221 
222for manifest in client.list_manifest_properties("my-image"):
223    if manifest.last_updated_on < cutoff and not manifest.tags:
224        print(f"Deleting {manifest.digest}")
225        client.delete_manifest("my-image", manifest.digest)
226```
227 
228## Client Operations
229 
230| Operation | Description |
231|-----------|-------------|
232| `list_repository_names` | List all repositories |
233| `get_repository_properties` | Get repository metadata |
234| `delete_repository` | Delete repository and all images |
235| `list_tag_properties` | List tags in repository |
236| `get_tag_properties` | Get tag metadata |
237| `delete_tag` | Delete specific tag |
238| `list_manifest_properties` | List manifests in repository |
239| `get_manifest_properties` | Get manifest metadata |
240| `delete_manifest` | Delete manifest by digest |
241| `download_manifest` | Download manifest content |
242| `download_blob` | Download layer blob |
243 
244## Best Practices
245 
2461. **Use Entra ID** for authentication in production
2472. **Delete by digest** not tag to avoid orphaned images
2483. **Lock production images** with can_delete=False
2494. **Clean up untagged manifests** regularly
2505. **Use async client** for high-throughput operations
2516. **Order by last_updated** to find recent/old images
2527. **Check manifest.tags** before deleting to avoid removing tagged images
253