Rychlý start: Použití klientských knihoven služby Azure Container Registry

  • Článek

V tomto článku se seznámíte s klientskou knihovnou pro Azure Container Registry. Pomocí těchto kroků si můžete vyzkoušet ukázkový kód pro operace roviny dat na obrázcích a artefaktech.

Ke službě Azure Container Registry použijte klientskou knihovnu pro:

  • Výpis imagí nebo artefaktů v registru
  • Získání metadat pro obrázky a artefakty, úložiště a značky
  • Nastavení vlastností čtení, zápisu a odstranění u položek registru
  • Odstranění obrázků a artefaktů, úložišť a značek

Azure Container Registry má také knihovnu pro správu pro operace roviny řízení, včetně vytváření a aktualizací registru.

Předpoklady

Klíčové koncepty

  • Registr kontejnerů Azure ukládá image kontejnerů a artefakty OCI.
  • Obrázek nebo artefakt se skládá z manifestu a vrstev.
  • Manifest popisuje vrstvy, které tvoří obrázek nebo artefakt. Je jednoznačně identifikován hodnotou hash.
  • Obrázek nebo artefakt lze také označit , aby byl alias čitelný pro člověka. K obrázku nebo artefaktu může být přidružena nula nebo více značek a každá značka obrázek jednoznačně identifikuje.
  • Kolekce obrázků nebo artefaktů, které sdílejí stejný název, ale mají různé značky, je úložiště.

Další informace najdete v tématu o registrech, úložištích a artefaktech.

Začínáme

Ukázky referenčních informací | k balíčku zdrojového kódu | (NuGet) API |

K vývoji kódu aplikace .NET, který se může připojit k instanci služby Azure Container Registry, budete potřebovat knihovnu Azure.Containers.ContainerRegistry .

Nainstalujte balíček .

Nainstalujte klientskou knihovnu Azure Container Registry pro .NET pomocí NuGetu:

dotnet add package Azure.Containers.ContainerRegistry --prerelease

Ověření klienta

Aby se vaše aplikace připojila k vašemu registru, budete muset vytvořit, ContainerRegistryClient která se s ním může ověřit. Pomocí knihovny Azure Identity přidejte podporu Microsoft Entra ID pro ověřování klientů Azure SDK s odpovídajícími službami Azure.

Když vyvíjíte a ladíte aplikaci místně, můžete k ověření v registru použít vlastního uživatele. Jedním ze způsobů, jak toho dosáhnout, je ověřit uživatele pomocí Azure CLI a spustit aplikaci z tohoto prostředí. Pokud vaše aplikace používá klienta vytvořeného k ověření DefaultAzureCredential, provede se správně ověření v registru v zadaném koncovém bodu.

// Create a ContainerRegistryClient that will authenticate to your registry through Azure Active Directory
Uri endpoint = new Uri("https://myregistry.azurecr.io");
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
    new ContainerRegistryClientOptions()
    {
        Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
    });

Další přístupy k ověřování v DefaultAzureCredentialprostředích nasazení i v prostředích nasazení najdete v souboru README služby Azure Identity. Informace o připojení k registrům v nepřístupných cloudech Azure najdete v referenčních informacích k rozhraní API.

Další informace o použití ID Microsoft Entra se službou Azure Container Registry najdete v přehledu ověřování.

Příklady

Každá ukázka předpokládá, že existuje REGISTRY_ENDPOINT proměnná prostředí nastavená na řetězec obsahující předponu https:// a název přihlašovacího serveru, například ;https://myregistry.azurecr.io".

Následující ukázky používají asynchronní rozhraní API, která vracejí úlohu. K dispozici jsou také synchronní rozhraní API.

Asynchronní výpis úložišť

Iterujte prostřednictvím kolekce úložišť v registru.

// Get the service endpoint from the environment
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
    new ContainerRegistryClientOptions()
    {
        Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
    });

// Get the collection of repository names from the registry
AsyncPageable<string> repositories = client.GetRepositoryNamesAsync();
await foreach (string repository in repositories)
{
    Console.WriteLine(repository);
}

Asynchronní nastavení vlastností artefaktů

// Get the service endpoint from the environment
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
    new ContainerRegistryClientOptions()
    {
        Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
    });

// Get the collection of repository names from the registry
AsyncPageable<string> repositories = client.GetRepositoryNamesAsync();
await foreach (string repository in repositories)
{
    Console.WriteLine(repository);
}

Asynchronní odstranění imagí

using System.Linq;
using Azure.Containers.ContainerRegistry;
using Azure.Identity;

// Get the service endpoint from the environment
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("REGISTRY_ENDPOINT"));

// Create a new ContainerRegistryClient
ContainerRegistryClient client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(),
    new ContainerRegistryClientOptions()
    {
        Audience = ContainerRegistryAudience.AzureResourceManagerPublicCloud
    });

// Iterate through repositories
AsyncPageable<string> repositoryNames = client.GetRepositoryNamesAsync();
await foreach (string repositoryName in repositoryNames)
{
    ContainerRepository repository = client.GetRepository(repositoryName);

    // Obtain the images ordered from newest to oldest
    AsyncPageable<ArtifactManifestProperties> imageManifests =
        repository.GetManifestPropertiesCollectionAsync(orderBy: ArtifactManifestOrderBy.LastUpdatedOnDescending);

    // Delete images older than the first three.
    await foreach (ArtifactManifestProperties imageManifest in imageManifests.Skip(3))
    {
        RegistryArtifact image = repository.GetArtifact(imageManifest.Digest);
        Console.WriteLine($"Deleting image with digest {imageManifest.Digest}.");
        Console.WriteLine($"   Deleting the following tags from the image: ");
        foreach (var tagName in imageManifest.Tags)
        {
            Console.WriteLine($"        {imageManifest.RepositoryName}:{tagName}");
            await image.DeleteTagAsync(tagName);
        }
        await image.DeleteAsync();
    }
}

Začínáme

Ukázky referenčních informací | k rozhraní API balíčku zdrojového kódu | (Maven) |

Aktuálně podporovaná prostředí

Zahrnout balíček

<dependency>
  <groupId>com.azure</groupId>
  <artifactId>azure-containers-containerregistry</artifactId>
  <version>1.0.0-beta.3</version>
</dependency>

Ověření klienta

Knihovna Identit Azure poskytuje podporu id Microsoft Entra pro ověřování.

Následující ukázky předpokládají, že máte řetězec koncového bodu registru obsahující předponu https:// a název přihlašovacího serveru, například ;https://myregistry.azurecr.io".

DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
ContainerRegistryClient client = new ContainerRegistryClientBuilder()
    .endpoint(endpoint)
    .credential(credential)
    .buildClient();

DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
ContainerRegistryAsyncClient client = new ContainerRegistryClientBuilder()
    .endpoint(endpoint)
    .credential(credential)
    .buildAsyncClient();

Další informace o použití ID Microsoft Entra se službou Azure Container Registry najdete v přehledu ověřování.

Příklady

Každá ukázka předpokládá, že existuje řetězec koncového bodu registru obsahující předponu https:// a název přihlašovacího serveru, například ;https://myregistry.azurecr.io".

Výpis názvů úložišť

Iterujte prostřednictvím kolekce úložišť v registru.

DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
ContainerRegistryClient client = new ContainerRegistryClientBuilder()
    .endpoint(endpoint)
    .credential(credential)
    .buildClient();

client.listRepositoryNames().forEach(repository -> System.out.println(repository));

Nastavení vlastností artefaktů

TokenCredential defaultCredential = new DefaultAzureCredentialBuilder().build();

ContainerRegistryClient client = new ContainerRegistryClientBuilder()
    .endpoint(endpoint)
    .credential(defaultCredential)
    .buildClient();

RegistryArtifact image = client.getArtifact(repositoryName, digest);

image.updateTagProperties(
    tag,
    new ArtifactTagProperties()
        .setWriteEnabled(false)
        .setDeleteEnabled(false));

Odstranění imagí

TokenCredential defaultCredential = new DefaultAzureCredentialBuilder().build();

ContainerRegistryClient client = new ContainerRegistryClientBuilder()
    .endpoint(endpoint)
    .credential(defaultCredential)
    .buildClient();

final int imagesCountToKeep = 3;
for (String repositoryName : client.listRepositoryNames()) {
    final ContainerRepository repository = client.getRepository(repositoryName);

    // Obtain the images ordered from newest to oldest
    PagedIterable<ArtifactManifestProperties> imageManifests =
        repository.listManifestProperties(
            ArtifactManifestOrderBy.LAST_UPDATED_ON_DESCENDING,
            Context.NONE);

    imageManifests.stream().skip(imagesCountToKeep)
        .forEach(imageManifest -> {
            System.out.printf(String.format("Deleting image with digest %s.%n", imageManifest.getDigest()));
            System.out.printf("    This image has the following tags: ");

            for (String tagName : imageManifest.getTags()) {
                System.out.printf("        %s:%s", imageManifest.getRepositoryName(), tagName);
            }

            repository.getArtifact(imageManifest.getDigest()).delete();
        });
}

Začínáme

Referenční informace k | rozhraní API balíčku zdrojového kódu | (npm) |

Aktuálně podporovaná prostředí

Další podrobnosti najdete v zásadách podpory.

Nainstalujte balíček @azure/container-registry.

Nainstalujte klientskou knihovnu Container Registry pro JavaScript pomocí npm:

npm install @azure/container-registry

Ověření klienta

Knihovna Identit Azure poskytuje podporu id Microsoft Entra pro ověřování.

const { ContainerRegistryClient } = require("@azure/container-registry");
const { DefaultAzureCredential } = require("@azure/identity");

const endpoint = process.env.CONTAINER_REGISTRY_ENDPOINT;
// Create a ContainerRegistryClient that will authenticate through Active Directory
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());

Další informace o použití ID Microsoft Entra se službou Azure Container Registry najdete v přehledu ověřování.

Příklady

Každá ukázka předpokládá, že existuje CONTAINER_REGISTRY_ENDPOINT proměnná prostředí nastavená na řetězec obsahující předponu https:// a název přihlašovacího serveru, například ;https://myregistry.azurecr.io".

Asynchronní výpis úložišť

Iterujte prostřednictvím kolekce úložišť v registru.

const { ContainerRegistryClient } = require("@azure/container-registry");
const { DefaultAzureCredential } = require("@azure/identity");

async function main() {
  // endpoint should be in the form of "https://myregistryname.azurecr.io"
  // where "myregistryname" is the actual name of your registry
  const endpoint = process.env.CONTAINER_REGISTRY_ENDPOINT || "<endpoint>";
  const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());

  console.log("Listing repositories");
  const iterator = client.listRepositoryNames();
  for await (const repository of iterator) {
    console.log(`  repository: ${repository}`);
  }
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

Asynchronní nastavení vlastností artefaktů

const { ContainerRegistryClient } = require("@azure/container-registry");
const { DefaultAzureCredential } = require("@azure/identity");

async function main() {
  // Get the service endpoint from the environment
  const endpoint = process.env.CONTAINER_REGISTRY_ENDPOINT || "<endpoint>";

  // Create a new ContainerRegistryClient and RegistryArtifact to access image operations
  const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());
  const image = client.getArtifact("library/hello-world", "v1");

  // Set permissions on the image's "latest" tag
  await image.updateTagProperties("latest", { canWrite: false, canDelete: false });
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

Asynchronní odstranění imagí

const { ContainerRegistryClient } = require("@azure/container-registry");
const { DefaultAzureCredential } = require("@azure/identity");

async function main() {
  // Get the service endpoint from the environment
  const endpoint = process.env.CONTAINER_REGISTRY_ENDPOINT || "<endpoint>";
  // Create a new ContainerRegistryClient
  const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());

  // Iterate through repositories
  const repositoryNames = client.listRepositoryNames();
  for await (const repositoryName of repositoryNames) {
    const repository = client.getRepository(repositoryName);
    // Obtain the images ordered from newest to oldest by passing the `orderBy` option
    const imageManifests = repository.listManifestProperties({
      orderBy: "LastUpdatedOnDescending"
    });
    const imagesToKeep = 3;
    let imageCount = 0;
    // Delete images older than the first three.
    for await (const manifest of imageManifests) {
      imageCount++;
      if (imageCount > imagesToKeep) {
        const image = repository.getArtifact(manifest.digest);
        console.log(`Deleting image with digest ${manifest.digest}`);
        console.log(`  Deleting the following tags from the image:`);
        for (const tagName of manifest.tags) {
          console.log(`    ${manifest.repositoryName}:${tagName}`);
          image.deleteTag(tagName);
        }
        await image.delete();
      }
    }
  }
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

Začínáme

Ukázky referenčních informací | k rozhraní API balíčku zdrojového kódu | (Pypi) |

Nainstalujte balíček .

Nainstalujte klientskou knihovnu Azure Container Registry pro Python pomocí pipu:

pip install --pre azure-containerregistry

Ověření klienta

Knihovna Identit Azure poskytuje podporu id Microsoft Entra pro ověřování. Předpokládá DefaultAzureCredential , AZURE_CLIENT_IDAZURE_TENANT_IDa AZURE_CLIENT_SECRET proměnné prostředí jsou nastaveny. Další informace najdete v tématu Proměnné prostředí azure Identity.

# Create a ContainerRegistryClient that will authenticate through Active Directory
from azure.containerregistry import ContainerRegistryClient
from azure.identity import DefaultAzureCredential

account_url = "https://mycontainerregistry.azurecr.io"
client = ContainerRegistryClient(account_url, DefaultAzureCredential())

Příklady

Každá ukázka předpokládá, že existuje CONTAINERREGISTRY_ENDPOINT proměnná prostředí nastavená na řetězec obsahující předponu https:// a název přihlašovacího serveru, například ;https://myregistry.azurecr.io".

Asynchronní výpis značek

Tato ukázka předpokládá, že registr má úložiště hello-world.

import asyncio
from dotenv import find_dotenv, load_dotenv
import os

from azure.containerregistry.aio import ContainerRegistryClient
from azure.identity.aio import DefaultAzureCredential


class ListTagsAsync(object):
    def __init__(self):
        load_dotenv(find_dotenv())

    async def list_tags(self):
        # Create a new ContainerRegistryClient      
        audience = "https://management.azure.com"
        account_url = os.environ["CONTAINERREGISTRY_ENDPOINT"]
        credential = DefaultAzureCredential()
        client = ContainerRegistryClient(account_url, credential, audience=audience)

        manifest = await client.get_manifest_properties("library/hello-world", "latest")
        print(manifest.repository_name + ": ")
        for tag in manifest.tags:
            print(tag + "\n")

Asynchronní nastavení vlastností artefaktů

Tato ukázka předpokládá, že registr má úložiště hello-world se značkou v1image .

import asyncio
from dotenv import find_dotenv, load_dotenv
import os

from azure.containerregistry.aio import ContainerRegistryClient
from azure.identity.aio import DefaultAzureCredential


class SetImagePropertiesAsync(object):
    def __init__(self):
        load_dotenv(find_dotenv())

    async def set_image_properties(self):
        # Create a new ContainerRegistryClient
        account_url = os.environ["CONTAINERREGISTRY_ENDPOINT"]
        audience = "https://management.azure.com"
        credential = DefaultAzureCredential()
        client = ContainerRegistryClient(account_url, credential, audience=audience)

        # [START update_manifest_properties]
        # Set permissions on the v1 image's "latest" tag
        await client.update_manifest_properties(
            "library/hello-world",
            "latest",
            can_write=False,
            can_delete=False
        )
        # [END update_manifest_properties]
        # 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"
        # (which references the same image), it would succeed.

Asynchronní odstranění imagí

import asyncio
from dotenv import find_dotenv, load_dotenv
import os

from azure.containerregistry import ManifestOrder
from azure.containerregistry.aio import ContainerRegistryClient
from azure.identity.aio import DefaultAzureCredential


class DeleteImagesAsync(object):
    def __init__(self):
        load_dotenv(find_dotenv())

    async def delete_images(self):
        # [START list_repository_names]   
        audience = "https://management.azure.com"
        account_url = os.environ["CONTAINERREGISTRY_ENDPOINT"]
        credential = DefaultAzureCredential()
        client = ContainerRegistryClient(account_url, credential, audience=audience)

        async with client:
            async for repository in client.list_repository_names():
                print(repository)
                # [END list_repository_names]

                # [START list_manifest_properties]
                # Keep the three most recent images, delete everything else
                manifest_count = 0
                async for manifest in client.list_manifest_properties(repository, order_by=ManifestOrder.LAST_UPDATE_TIME_DESCENDING):
                    manifest_count += 1
                    if manifest_count > 3:
                        await client.delete_manifest(repository, manifest.digest)
                # [END list_manifest_properties]

Začínáme

Referenční informace k rozhraní REST API balíčku zdrojového kódu | (pkg.go.dev) |

Nainstalujte balíček .

Nainstalujte klientskou knihovnu Azure Container Registry pro Go pomocí go get:

go get github.com/Azure/azure-sdk-for-go/sdk/containers/azcontainerregistry

Ověření klienta

Při vývoji a ladění aplikace místně můžete použít azidentity. NewDefaultAzureCredential pro ověření. Doporučujeme používat spravovanou identitu v produkčním prostředí.

import (
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/containers/azcontainerregistry"
	"log"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}

	client, err := azcontainerregistry.NewClient("https://myregistry.azurecr.io", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
}

Další informace o dalších přístupech ověřování najdete v dokumentaci k azidentity .

Příklady

Každá ukázka předpokládá, že adresa URL koncového bodu registru kontejneru je ;https://myregistry.azurecr.io".

Výpis značek

Tato ukázka předpokládá, že registr má úložiště hello-world.

import (
	"context"
	"fmt"
	"github.com/Azure/azure-sdk-for-go/sdk/containers/azcontainerregistry"
	"log"
)

func Example_listTagsWithAnonymousAccess() {
	client, err := azcontainerregistry.NewClient("https://myregistry.azurecr.io", nil, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	ctx := context.Background()
	pager := client.NewListTagsPager("library/hello-world", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Tags {
			fmt.Printf("tag: %s\n", *v.Name)
		}
	}
}

Nastavení vlastností artefaktů

Tato ukázka předpokládá, že registr má úložiště hello-world se značkou latestimage .

package azcontainerregistry_test

import (
	"context"
	"fmt"
	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/containers/azcontainerregistry"
	"log"
)

func Example_setArtifactProperties() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	client, err := azcontainerregistry.NewClient("https://myregistry.azurecr.io", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	ctx := context.Background()
	res, err := client.UpdateTagProperties(ctx, "library/hello-world", "latest", &azcontainerregistry.ClientUpdateTagPropertiesOptions{
		Value: &azcontainerregistry.TagWriteableProperties{
			CanWrite:  to.Ptr(false),
			CanDelete: to.Ptr(false),
		}})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	fmt.Printf("repository library/hello-world - tag latest: 'CanWrite' property: %t, 'CanDelete' property: %t\n", *res.Tag.ChangeableAttributes.CanWrite, *res.Tag.ChangeableAttributes.CanDelete)
}

Odstranění imagí

package azcontainerregistry_test

import (
	"context"
	"fmt"
	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/containers/azcontainerregistry"
	"log"
)

func Example_deleteImages() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	client, err := azcontainerregistry.NewClient("https://myregistry.azurecr.io", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	ctx := context.Background()
	repositoryPager := client.NewListRepositoriesPager(nil)
	for repositoryPager.More() {
		repositoryPage, err := repositoryPager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance repository page: %v", err)
		}
		for _, r := range repositoryPage.Repositories.Names {
			manifestPager := client.NewListManifestsPager(*r, &azcontainerregistry.ClientListManifestsOptions{
				OrderBy: to.Ptr(azcontainerregistry.ArtifactManifestOrderByLastUpdatedOnDescending),
			})
			for manifestPager.More() {
				manifestPage, err := manifestPager.NextPage(ctx)
				if err != nil {
					log.Fatalf("failed to advance manifest page: %v", err)
				}
				imagesToKeep := 3
				for i, m := range manifestPage.Manifests.Attributes {
					if i >= imagesToKeep {
						for _, t := range m.Tags {
							fmt.Printf("delete tag from image: %s", *t)
							_, err := client.DeleteTag(ctx, *r, *t, nil)
							if err != nil {
								log.Fatalf("failed to delete tag: %v", err)
							}
						}
						_, err := client.DeleteManifest(ctx, *r, *m.Digest, nil)
						if err != nil {
							log.Fatalf("failed to delete manifest: %v", err)
						}
						fmt.Printf("delete image with digest: %s", *m.Digest)
					}
				}
			}
		}
	}
}

Vyčištění prostředků

Pokud chcete vyčistit a odebrat registr kontejneru Azure, můžete odstranit prostředek nebo skupinu prostředků. Odstraněním skupiny prostředků se odstraní také všechny ostatní prostředky, které jsou k ní přidružené.

Další kroky

V tomto rychlém startu jste se dozvěděli o používání klientské knihovny služby Azure Container Registry k provádění operací s imagemi a artefakty v registru kontejneru.