{"author":"Microsoft Corporation","author_email":"azuresdkengsysadmins@microsoft.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","License :: OSI Approved :: MIT License","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9"],"description":"# Azure Container Registry client library for Python\n\nAzure Container Registry allows you to store and manage container images and artifacts in a private registry for all types of container deployments.\n\nUse the client library for Azure Container Registry to:\n\n- List images or artifacts in a registry\n- Obtain metadata for images and artifacts, repositories and tags\n- Set read/write/delete properties on registry items\n- Delete images and artifacts, repositories and tags\n\n[Source code][source]\n| [Package (Pypi)][package]\n| [Package (Conda)](https://anaconda.org/microsoft/azure-containerregistry/)\n| [API reference documentation][docs]\n| [REST API documentation][rest_docs]\n| [Product documentation][product_docs]\n\n## _Disclaimer_\n\n_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_\n_Python 3.7 or later is required to use this package. For more details, please refer to [Azure SDK for Python version support policy](https://github.com/Azure/azure-sdk-for-python/wiki/Azure-SDKs-Python-version-support-policy)._\n\n## Getting started\n\n### Install the package\n\nInstall the Azure Container Registry client library for Python with [pip][pip_link]:\n\n```bash\npip install --pre azure-containerregistry\n```\n\n### Prerequisites\n\n* Python 3.7 or later is required to use this package.\n* You need an [Azure subscription][azure_sub] and a [Container Registry account][container_registry_docs] to use this package.\n\nTo create a new Container Registry, you can use the [Azure Portal][container_registry_create_portal],\n[Azure PowerShell][container_registry_create_ps], or the [Azure CLI][container_registry_create_cli].\nHere's an example using the Azure CLI:\n\n```Powershell\naz acr create --name MyContainerRegistry --resource-group MyResourceGroup --location westus --sku Basic\n```\n\n### Authenticate the client\n\nThe [Azure Identity library][identity] provides easy Azure Active Directory support for authentication. The `DefaultAzureCredential` assumes the `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, and `AZURE_CLIENT_SECRET` environment variables are set, for more information refer to the [Azure Identity environment variables section](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#environment-variables)\n\n```python\n# Create a ContainerRegistryClient that will authenticate through Active Directory\nfrom azure.containerregistry import ContainerRegistryClient\nfrom azure.identity import DefaultAzureCredential\n\nendpoint = \"https://mycontainerregistry.azurecr.io\"\naudience = \"https://management.azure.com\"\nclient = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience=audience)\n```\n\n## Key concepts\n\nA **registry** stores Docker images and [OCI Artifacts](https://opencontainers.org/). An image or artifact consists of a **manifest** and **layers**. An image's manifest describes the layers that make up the image, and is uniquely identified by its **digest**. An image can also be \"tagged\" to give it a human-readable alias. An image or artifact can have zero or more **tags** associated with it, and each tag uniquely identifies the image. A collection of images that share the same name but have different tags, is referred to as a **repository**.\n\nFor more information please see [Container Registry Concepts](https://docs.microsoft.com/azure/container-registry/container-registry-concepts).\n\n\n## Examples\n\nThe following sections provide several code snippets covering some of the most common ACR Service tasks, including:\n\n- Registry operations:\n - [List repositories](#list-repositories)\n - [List tags with anonymous access](#list-tags-with-anonymous-access)\n - [Set artifact properties](#set-artifact-properties)\n - [Delete images](#delete-images)\n- Blob and manifest operations:\n - [Upload images](#upload-images)\n - [Download images](#download-images)\n - [Delete manifest](#delete-manifest)\n - [Delete blob](#delete-blob)\n\nPlease note that each sample assumes there is a `CONTAINERREGISTRY_ENDPOINT` environment variable set to a string containing the `https://` prefix and the name of the login server, for example \"https://myregistry.azurecr.io\". Anonymous access samples are getting endpoint value from environment variable`CONTAINERREGISTRY_ANONREGISTRY_ENDPOINT`.\n\n### List repositories\n\nIterate through the collection of repositories in the registry.\n\n\n\n```python\nwith ContainerRegistryClient(self.endpoint, self.credential) as client:\n # Iterate through all the repositories\n for repository_name in client.list_repository_names():\n print(repository_name)\n```\n\n\n\n### List tags with anonymous access\n\nIterate through the collection of tags in the repository with anonymous access.\n\n\n\n```python\nwith ContainerRegistryClient(endpoint) as anon_client:\n manifest = anon_client.get_manifest_properties(\"library/hello-world\", \"latest\")\n print(f\"Tags of {manifest.repository_name}: \")\n # Iterate through all the tags\n for tag in manifest.tags:\n print(tag)\n```\n\n\n\n### Set artifact properties\n\nSet properties of an artifact.\n\n\n\n```python\nwith ContainerRegistryClient(self.endpoint, self.credential) as client:\n # Set permissions on image \"library/hello-world:v1\"\n client.update_manifest_properties(\n \"library/hello-world\",\n \"v1\",\n can_write=False,\n can_delete=False\n )\n```\n\n\n\n### Delete images\n\nDelete images older than the first three in the repository.\n\n\n\n```python\nwith ContainerRegistryClient(self.endpoint, self.credential) as client:\n for repository in client.list_repository_names():\n # Keep the three most recent images, delete everything else\n manifest_count = 0\n for manifest in client.list_manifest_properties(\n repository, order_by=ArtifactManifestOrder.LAST_UPDATED_ON_DESCENDING\n ):\n manifest_count += 1\n if manifest_count > 3:\n # Make sure will have the permission to delete the manifest later\n client.update_manifest_properties(\n repository,\n manifest.digest,\n can_write=True,\n can_delete=True\n )\n print(f\"Deleting {repository}:{manifest.digest}\")\n client.delete_manifest(repository, manifest.digest)\n```\n\n\n\n### Upload images\n\nTo upload a full image, we need to upload individual layers and configuration. After that we can upload a manifest which describes an image or artifact and assign it a tag.\n\n\n\n```python\nself.repository_name = \"sample-oci-image\"\nlayer = BytesIO(b\"Sample layer\")\nconfig = BytesIO(json.dumps(\n {\n \"sample config\": \"content\",\n }).encode())\nwith ContainerRegistryClient(self.endpoint, self.credential) as client:\n # Upload a layer\n layer_digest, layer_size = client.upload_blob(self.repository_name, layer)\n print(f\"Uploaded layer: digest - {layer_digest}, size - {layer_size}\")\n # Upload a config\n config_digest, config_size = client.upload_blob(self.repository_name, config)\n print(f\"Uploaded config: digest - {config_digest}, size - {config_size}\")\n # Create an oci image with config and layer info\n oci_manifest = {\n \"config\": {\n \"mediaType\": \"application/vnd.oci.image.config.v1+json\",\n \"digest\": config_digest,\n \"sizeInBytes\": config_size,\n },\n \"schemaVersion\": 2,\n \"layers\": [\n {\n \"mediaType\": \"application/vnd.oci.image.layer.v1.tar\",\n \"digest\": layer_digest,\n \"size\": layer_size,\n \"annotations\": {\n \"org.opencontainers.image.ref.name\": \"artifact.txt\",\n },\n },\n ],\n }\n # Set the image with tag \"latest\"\n manifest_digest = client.set_manifest(self.repository_name, oci_manifest, tag=\"latest\")\n print(f\"Uploaded manifest: digest - {manifest_digest}\")\n```\n\n\n\n### Download images\n\nTo download a full image, we need to download its manifest and then download individual layers and configuration.\n\n\n\n```python\nwith ContainerRegistryClient(self.endpoint, self.credential) as client:\n # Get the image\n get_manifest_result = client.get_manifest(self.repository_name, \"latest\")\n received_manifest = get_manifest_result.manifest\n print(f\"Got manifest:\\n{received_manifest}\")\n \n # Download and write out the layers\n for layer in received_manifest[\"layers\"]:\n # Remove the \"sha256:\" prefix from digest\n layer_file_name = layer[\"digest\"].split(\":\")[1]\n try:\n stream = client.download_blob(self.repository_name, layer[\"digest\"])\n with open(layer_file_name, \"wb\") as layer_file:\n for chunk in stream:\n layer_file.write(chunk)\n except DigestValidationError:\n print(f\"Downloaded layer digest value did not match. Deleting file {layer_file_name}.\")\n os.remove(layer_file_name)\n print(f\"Got layer: {layer_file_name}\")\n # Download and write out the config\n config_file_name = \"config.json\"\n try:\n stream = client.download_blob(self.repository_name, received_manifest[\"config\"][\"digest\"])\n with open(config_file_name, \"wb\") as config_file:\n for chunk in stream:\n config_file.write(chunk)\n except DigestValidationError:\n print(f\"Downloaded config digest value did not match. Deleting file {config_file_name}.\")\n os.remove(config_file_name)\n print(f\"Got config: {config_file_name}\")\n```\n\n\n\n### Delete manifest\n\n\n\n```python\nwith ContainerRegistryClient(self.endpoint, self.credential) as client:\n get_manifest_result = client.get_manifest(self.repository_name, \"latest\")\n # Delete the image\n client.delete_manifest(self.repository_name, get_manifest_result.digest)\n```\n\n\n\n### Delete blob\n\n\n\n```python\nwith ContainerRegistryClient(self.endpoint, self.credential) as client:\n get_manifest_result = client.get_manifest(self.repository_name, \"latest\")\n received_manifest = get_manifest_result.manifest\n # Delete the layers\n for layer in received_manifest[\"layers\"]:\n client.delete_blob(self.repository_name, layer[\"digest\"])\n # Delete the config\n client.delete_blob(self.repository_name, received_manifest[\"config\"][\"digest\"])\n```\n\n\n\n\n## Troubleshooting\n\nFor infomation about troubleshooting, refer to the [troubleshooting guide].\n### General\nACR client library will raise exceptions defined in [Azure Core][azure_core_exceptions].\n\n### Logging\nThis library uses the standard\n[logging][python_logging] library for logging.\n\nBasic information about HTTP sessions (URLs, headers, etc.) is logged at `INFO` level.\n\nDetailed `DEBUG` level logging, including request/response bodies and **unredacted**\nheaders, can be enabled on the client or per-operation with the `logging_enable` keyword argument.\n\nSee full SDK logging documentation with examples [here][sdk_logging_docs].\n\n### Optional Configuration\n\nOptional keyword arguments can be passed in at the client and per-operation level.\nThe azure-core [reference documentation][azure_core_ref_docs]\ndescribes available configurations for retries, logging, transport protocols, and more.\n\n## Next steps\n\n- Go further with azure.containerregistry and our [samples][samples].\n- Watch a [demo or deep dive video](https://azure.microsoft.com/resources/videos/index/?service=container-registry).\n- Read more about the [Azure Container Registry service](https://docs.microsoft.com/azure/container-registry/container-registry-intro).\n\n## Contributing\n\nThis project welcomes contributions and suggestions. Most contributions require\nyou to agree to a Contributor License Agreement (CLA) declaring that you have\nthe right to, and actually do, grant us the rights to use your contribution. For\ndetails, visit [cla.microsoft.com][cla].\n\nThis project has adopted the [Microsoft Open Source Code of Conduct][coc].\nFor more information see the [Code of Conduct FAQ][coc_faq]\nor contact [opencode@microsoft.com][coc_contact] with any\nadditional questions or comments.\n\n![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fcontainerregistry%2Fazure-containerregistry%2FREADME.png)\n\n\n[source]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/containerregistry/azure-containerregistry\n[package]: https://pypi.org/project/azure-containerregistry/\n[docs]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-containerregistry/1.0.0b1/index.html\n[rest_docs]: https://docs.microsoft.com/rest/api/containerregistry/\n[product_docs]: https://docs.microsoft.com/azure/container-registry\n[pip_link]: https://pypi.org\n[container_registry_docs]: https://docs.microsoft.com/azure/container-registry/container-registry-intro\n[container_registry_create_ps]: https://docs.microsoft.com/azure/container-registry/container-registry-get-started-powershell\n[container_registry_create_cli]: https://docs.microsoft.com/azure/container-registry/container-registry-get-started-azure-cli\n[container_registry_create_portal]: https://docs.microsoft.com/azure/container-registry/container-registry-get-started-portal\n[container_registry_concepts]: https://docs.microsoft.com/azure/container-registry/container-registry-concepts\n[azure_cli]: https://docs.microsoft.com/cli/azure\n[azure_sub]: https://azure.microsoft.com/free/\n[identity]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/identity/azure-identity/README.md\n[samples]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/containerregistry/azure-containerregistry/samples\n[cla]: https://cla.microsoft.com\n[coc]: https://opensource.microsoft.com/codeofconduct/\n[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/\n[coc_contact]: mailto:opencode@microsoft.com\n[azure_core_ref_docs]: https://aka.ms/azsdk/python/core/docs\n[azure_core_exceptions]: https://aka.ms/azsdk/python/core/docs#module-azure.core.exceptions\n[python_logging]: https://docs.python.org/3/library/logging.html\n[sdk_logging_docs]: https://docs.microsoft.com/azure/developer/python/azure-sdk-logging\n[troubleshooting guide]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/containerregistry/azure-containerregistry/TROUBLESHOOTING.md\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/Azure/azure-sdk-for-python","keywords":null,"license":"MIT License","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"azure-containerregistry","package_url":"https://pypi.org/project/azure-containerregistry/","platform":null,"project_url":"https://pypi.org/project/azure-containerregistry/","project_urls":{"Bug Reports":"https://github.com/Azure/azure-sdk-for-python/issues","Homepage":"https://github.com/Azure/azure-sdk-for-python","Source":"https://github.com/Azure/azure-sdk-python"},"provides_extra":null,"release_url":"https://pypi.org/project/azure-containerregistry/1.2.0/","requires_dist":null,"requires_python":">=3.7","summary":"Microsoft Azure Azure Container Registry Client Library for Python","version":"1.2.0","yanked":false,"yanked_reason":null}

Package search

azure-containerregistry

project_urls

Dependencies

All package metadata

Releases