[ACR] Fix failing samples (Azure#28203)

Author: Yalin Li

sdk/containerregistry/azure-containerregistry/samples/async_samples/sample_delete_images_async.py

@@ -17,36 +17,50 @@
 
     Set the environment variables with your own values before running the sample:
     1) CONTAINERREGISTRY_ENDPOINT - The URL of you Container Registry account
-"""
 
+    This sample assumes your registry has at least four repositories.
+"""
 import asyncio
-from dotenv import find_dotenv, load_dotenv
 import os
-
+from dotenv import find_dotenv, load_dotenv
 from azure.containerregistry import ArtifactManifestOrder
 from azure.containerregistry.aio import ContainerRegistryClient
-from azure.identity.aio import DefaultAzureCredential
+from samples.sample_utilities import load_registry, get_authority, get_audience, get_credential
 
 
 class DeleteImagesAsync(object):
     def __init__(self):
         load_dotenv(find_dotenv())
+        self.endpoint = os.environ.get("CONTAINERREGISTRY_ENDPOINT")
+        self.authority = get_authority(self.endpoint)
+        self.audience = get_audience(self.authority)
+        self.credential = get_credential(
+            self.authority, exclude_environment_credential=True, is_async=True
+        )
 
     async def delete_images(self):
+        load_registry()
         # Instantiate an instance of ContainerRegistryClient
-        audience = "https://management.azure.com"
-        endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
-        credential = DefaultAzureCredential()
-
-        async with ContainerRegistryClient(endpoint, credential, audience=audience) as client:
+        async with ContainerRegistryClient(self.endpoint, self.credential, audience=self.audience) as client:
             async for repository in client.list_repository_names():
                 print(repository)
 
                 # Keep the three most recent images, delete everything else
                 manifest_count = 0
-                async for manifest in client.list_manifest_properties(repository, order_by=ArtifactManifestOrder.LAST_UPDATED_ON_DESCENDING):
+                async for manifest in client.list_manifest_properties(
+                    repository, order_by=ArtifactManifestOrder.LAST_UPDATED_ON_DESCENDING
+                ):
                     manifest_count += 1
                     if manifest_count > 3:
+                        # Make sure will have the permission to delete the manifest later
+                        await client.update_manifest_properties(
+                            repository,
+                            manifest.digest,
+                            can_write=True,
+                            can_delete=True
+                        )
+
+                        print(f"Deleting {repository}:{manifest.digest}")
                         await client.delete_manifest(repository, manifest.digest)
 
 

sdk/containerregistry/azure-containerregistry/samples/async_samples/sample_delete_tags_async.py

@@ -17,37 +17,43 @@
 
     Set the environment variables with your own values before running the sample:
     1) CONTAINERREGISTRY_ENDPOINT - The URL of you Container Registry account
-"""
 
+    This sample assumes your registry has at least one repository with more than three tags.
+"""
 import asyncio
-from dotenv import find_dotenv, load_dotenv
 import os
-
+from dotenv import find_dotenv, load_dotenv
 from azure.containerregistry import ArtifactTagOrder
 from azure.containerregistry.aio import ContainerRegistryClient
-from azure.identity.aio import DefaultAzureCredential
+from samples.sample_utilities import load_registry, get_authority, get_audience, get_credential
 
 
 class DeleteTagsAsync(object):
     def __init__(self):
         load_dotenv(find_dotenv())
+        self.endpoint = os.environ.get("CONTAINERREGISTRY_ENDPOINT")
+        self.authority = get_authority(self.endpoint)
+        self.audience = get_audience(self.authority)
+        self.credential = get_credential(
+            self.authority, exclude_environment_credential=True, is_async=True
+        )
 
     async def delete_tags(self):
-        # [START list_repository_names]
-        audience = "https://management.azure.com"
-        endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
-        credential = DefaultAzureCredential()
-
-        async with ContainerRegistryClient(endpoint, credential, audience=audience) as client:
+        load_registry()
+        async with ContainerRegistryClient(self.endpoint, self.credential, audience=self.audience) as client:
+            # [START list_repository_names]
             async for repository in client.list_repository_names():
                 print(repository)
                 # [END list_repository_names]
 
                 # Keep the three most recent tags, delete everything else
                 tag_count = 0
-                async for tag in client.list_tag_properties(repository, order_by=ArtifactTagOrder.LAST_UPDATED_ON_DESCENDING):
+                async for tag in client.list_tag_properties(
+                    repository, order_by=ArtifactTagOrder.LAST_UPDATED_ON_DESCENDING
+                ):
                     tag_count += 1
-                    if tag_count > 3:
+                    if tag_count > 3:                        
+                        print(f"Deleting {repository}:{tag.name}")
                         await client.delete_tag(repository, tag.name)
 
 

sdk/containerregistry/azure-containerregistry/samples/async_samples/sample_hello_world_async.py

@@ -17,38 +17,52 @@
     python sample_hello_world_async.py
 
     Set the environment variables with your own values before running the sample:
-    1) AZURE_CONTAINERREGISTRY_URL - The URL of you Container Registry account
-"""
+    1) CONTAINERREGISTRY_ENDPOINT - The URL of you Container Registry account
 
+    This sample assumes your registry has a repository "library/hello-world".
+"""
 import asyncio
-from dotenv import find_dotenv, load_dotenv
 import os
-
+from dotenv import find_dotenv, load_dotenv
 from azure.containerregistry.aio import ContainerRegistryClient
-from azure.identity.aio import DefaultAzureCredential
+from samples.sample_utilities import load_registry, get_authority, get_audience, get_credential
 
 
 class HelloWorldAsync(object):
     def __init__(self):
         load_dotenv(find_dotenv())
+        self.endpoint = os.environ.get("CONTAINERREGISTRY_ENDPOINT")
+        self.authority = get_authority(self.endpoint)
+        self.audience = get_audience(self.authority)
+        self.credential = get_credential(
+            self.authority, exclude_environment_credential=True, is_async=True
+        )
 
     async def basic_sample(self):
+        load_registry()
         # Instantiate an instance of ContainerRegistryClient
         # [START create_registry_client]
-        endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
-        audience = "https://management.azure.com"
-        client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience=audience)
+        async with ContainerRegistryClient(self.endpoint, self.credential, audience=self.audience) as client:
         # [END create_registry_client]
-        async with client:
             # Iterate through all the repositories
             async for repository_name in client.list_repository_names():
-                if repository_name == "hello-world":
-                    # Create a repository client from the registry client
+                print(repository_name)
+                if repository_name == "library/hello-world":
+                    print("Tags of repository library/hello-world:")
                     async for tag in client.list_tag_properties(repository_name):
-                        print(tag.digest)
+                        print(tag.name)
+                        
+                        # Make sure will have the permission to delete the repository later
+                        await client.update_manifest_properties(
+                            repository_name,
+                            tag.name,
+                            can_write=True,
+                            can_delete=True
+                        )
 
+                    print("Deleting " + repository_name)
                     # [START delete_repository]
-                    await client.delete_repository(repository_name, "hello-world")
+                    await client.delete_repository(repository_name)
                     # [END delete_repository]
 
 

sdk/containerregistry/azure-containerregistry/samples/async_samples/sample_list_tags_async.py

@@ -20,32 +20,34 @@
     Set the environment variables with your own values before running the sample:
     1) CONTAINERREGISTRY_ENDPOINT - The URL of you Container Registry account
 
-    This sample assumes the registry "myacr.azurecr.io" has a repository "hello-world".
+    This sample assumes your registry has a repository "library/hello-world".
 """
-
 import asyncio
-from dotenv import find_dotenv, load_dotenv
 import os
-
+from dotenv import find_dotenv, load_dotenv
 from azure.containerregistry.aio import ContainerRegistryClient
-from azure.identity.aio import DefaultAzureCredential
+from samples.sample_utilities import load_registry, get_authority, get_audience, get_credential
 
 
 class ListTagsAsync(object):
     def __init__(self):
         load_dotenv(find_dotenv())
+        self.endpoint = os.environ.get("CONTAINERREGISTRY_ENDPOINT")
+        self.authority = get_authority(self.endpoint)
+        self.audience = get_audience(self.authority)
+        self.credential = get_credential(
+            self.authority, exclude_environment_credential=True, is_async=True
+        )
 
     async def list_tags(self):
+        load_registry()
         # Instantiate an instance of ContainerRegistryClient    
-        audience = "https://management.azure.com"
-        endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
-        credential = DefaultAzureCredential()
-        async with ContainerRegistryClient(endpoint, credential, audience=audience) as client:
+        async with ContainerRegistryClient(self.endpoint, self.credential, audience=self.audience) as client:
             manifest = await client.get_manifest_properties("library/hello-world", "latest")
-            print(manifest.repository_name + ": ")
+            print("Tags of " + manifest.repository_name + ": ")
             # Iterate through all the tags
             for tag in manifest.tags:
-                print(tag + "\n")
+                print(tag)
 
 
 async def main():

sdk/containerregistry/azure-containerregistry/samples/async_samples/sample_set_image_properties_async.py

@@ -19,38 +19,40 @@
     Set the environment variables with your own values before running the sample:
     1) CONTAINERREGISTRY_ENDPOINT - The URL of you Container Registry account
 
-    This sample assumes the registry "myacr.azurecr.io" has a repository "hello-world" with image tagged "v1".
+    This sample assumes your registry has a repository "library/hello-world" with image tagged "v1".
 """
-
 import asyncio
-from dotenv import find_dotenv, load_dotenv
 import os
-
+from dotenv import find_dotenv, load_dotenv
 from azure.containerregistry.aio import ContainerRegistryClient
-from azure.identity.aio import DefaultAzureCredential
+from samples.sample_utilities import load_registry, get_authority, get_audience, get_credential
 
 
 class SetImagePropertiesAsync(object):
     def __init__(self):
         load_dotenv(find_dotenv())
+        self.endpoint = os.environ.get("CONTAINERREGISTRY_ENDPOINT")
+        self.authority = get_authority(self.endpoint)
+        self.audience = get_audience(self.authority)
+        self.credential = get_credential(
+            self.authority, exclude_environment_credential=True, is_async=True
+        )
 
     async def set_image_properties(self):
+        load_registry()
         # Instantiate an instance of ContainerRegistryClient
-        endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
-        audience = "https://management.azure.com"
-        credential = DefaultAzureCredential()
-        async with ContainerRegistryClient(endpoint, credential, audience=audience) as client:
+        async with ContainerRegistryClient(self.endpoint, self.credential, audience=self.audience) as client:
             # Set permissions on the v1 image's "latest" tag
             await client.update_manifest_properties(
                 "library/hello-world",
-                "latest",
+                "v1",
                 can_write=False,
                 can_delete=False
             )
-            # After this update, if someone were to push an update to "myacr.azurecr.io\hello-world:v1", it would fail.
-            # It's worth noting that if this image also had another tag, such as "latest", and that tag did not have
-            # permissions set to prevent reads or deletes, the image could still be overwritten. For example,
-            # if someone were to push an update to "myacr.azurecr.io\hello-world:latest"
+            # After this update, if someone were to push an update to `<registry endpoint>\library\hello-world:v1`,
+            # it would fail. It's worth noting that if this image also had another tag, such as `latest`,
+            # and that tag did not have permissions set to prevent reads or deletes, the image could still be
+            # overwritten. For example, if someone were to push an update to `<registry endpoint>\hello-world:latest`
             # (which references the same image), it would succeed.
 
 

sdk/containerregistry/azure-containerregistry/samples/sample_delete_images.py

@@ -17,33 +17,46 @@
 
     Set the environment variables with your own values before running the sample:
     1) CONTAINERREGISTRY_ENDPOINT - The URL of you Container Registry account
-"""
 
-from dotenv import find_dotenv, load_dotenv
+    This sample assumes your registry has at least four repositories.
+"""
 import os
-
+from dotenv import find_dotenv, load_dotenv
 from azure.containerregistry import ContainerRegistryClient, ArtifactManifestOrder
-from azure.identity import DefaultAzureCredential
+from sample_utilities import load_registry, get_authority, get_audience, get_credential
+
 
 class DeleteImages(object):
     def __init__(self):
         load_dotenv(find_dotenv())
+        self.endpoint = os.environ.get("CONTAINERREGISTRY_ENDPOINT")
+        self.authority = get_authority(self.endpoint)
+        self.audience = get_audience(self.authority)
+        self.credential = get_credential(
+            self.authority, exclude_environment_credential=True
+        )
 
     def delete_images(self):
+        load_registry()
         # Instantiate an instance of ContainerRegistryClient
-        audience = "https://management.azure.com"
-        endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
-
-        with ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience=audience) as client:
+        with ContainerRegistryClient(self.endpoint, self.credential, audience=self.audience) as client:
             for repository in client.list_repository_names():
                 print(repository)
 
                 # Keep the three most recent images, delete everything else
                 manifest_count = 0
                 for manifest in client.list_manifest_properties(
-                    repository, order_by=ArtifactManifestOrder.LAST_UPDATED_ON_DESCENDING):
+                    repository, order_by=ArtifactManifestOrder.LAST_UPDATED_ON_DESCENDING
+                ):
                     manifest_count += 1
                     if manifest_count > 3:
+                        # Make sure will have the permission to delete the manifest later
+                        client.update_manifest_properties(
+                            repository,
+                            manifest.digest,
+                            can_write=True,
+                            can_delete=True
+                        )
                         print(f"Deleting {repository}:{manifest.digest}")
                         client.delete_manifest(repository, manifest.digest)
 

sdk/containerregistry/azure-containerregistry/samples/sample_delete_tags.py

@@ -17,32 +17,38 @@
 
     Set the environment variables with your own values before running the sample:
     1) CONTAINERREGISTRY_ENDPOINT - The URL of you Container Registry account
-"""
 
-from dotenv import find_dotenv, load_dotenv
+    This sample assumes your registry has at least one repository with more than three tags.
+"""
 import os
-
+from dotenv import find_dotenv, load_dotenv
 from azure.containerregistry import ContainerRegistryClient, ArtifactTagOrder
-from azure.identity import DefaultAzureCredential
+from sample_utilities import load_registry, get_authority, get_audience, get_credential
 
 
 class DeleteTags(object):
     def __init__(self):
         load_dotenv(find_dotenv())
+        self.endpoint = os.environ.get("CONTAINERREGISTRY_ENDPOINT")
+        self.authority = get_authority(self.endpoint)
+        self.audience = get_audience(self.authority)
+        self.credential = get_credential(
+            self.authority, exclude_environment_credential=True
+        )
 
     def delete_tags(self):
-        # [START list_repository_names]      
-        audience = "https://management.azure.com"
-        endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
-
-        with ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience=audience) as client:
+        load_registry()
+        with ContainerRegistryClient(self.endpoint, self.credential, audience=self.audience) as client:
+            # [START list_repository_names]
             for repository in client.list_repository_names():
                 print(repository)
                 # [END list_repository_names]
 
                 # Keep the three most recent tags, delete everything else
                 tag_count = 0
-                for tag in client.list_tag_properties(repository, order_by=ArtifactTagOrder.LAST_UPDATED_ON_DESCENDING):
+                for tag in client.list_tag_properties(
+                    repository, order_by=ArtifactTagOrder.LAST_UPDATED_ON_DESCENDING
+                ):
                     tag_count += 1
                     if tag_count > 3:
                         print(f"Deleting {repository}:{tag.name}")