クイック スタート: Azure Container Registry クライアント ライブラリを使用する

この記事では、Azure Container Registry のクライアント ライブラリの使用を開始する方法について説明します。 イメージと成果物に対するデータ プレーン操作のコード例を試す場合は、こちらの手順に従います。

Azure Container Registry のクライアント ライブラリを使用して、次のことを行います。

  • レジストリ内のイメージまたは成果物を一覧表示する
  • イメージと成果物、リポジトリ、タグのメタデータを取得する
  • レジストリ項目の読み取り、書き込み、削除プロパティを設定する
  • イメージと成果物、リポジトリ、タグを削除する

Azure Container Registry には、レジストリの作成や更新など、コントロール プレーン操作用の管理ライブラリもあります。

前提条件

主要な概念

  • Azure コンテナー レジストリには、"コンテナー イメージ" と OCI 成果物が格納されます。
  • イメージまたは成果物は、"マニフェスト"と "レイヤー" で構成されます。
  • マニフェストは、イメージまたは成果物を構成するレイヤーを記述します。 これは、その "ダイジェスト" で一意に識別されます。
  • イメージまたは成果物に "タグ付け" して、人間が読み取り可能な別名を提供することもできます。 イメージまたは成果物には、0 個以上のタグを関連付けることができ、各タグによって画像が一意に識別されます。
  • 同じ名前を共有しているがタグが異なるイメージまたは成果物のコレクションは、"リポジトリ" です。

詳細については、「レジストリ、リポジトリ、成果物について」を参照してください。

はじめに

ソース コード | パッケージ (NuGet) | API リファレンス | サンプル

Azure Container Registry インスタンスに接続できる .NET アプリケーション コードを開発するには、Azure.Containers.ContainerRegistry ライブラリが必要です。

パッケージをインストールする

NuGet を使用して .NET 用の Azure Container Registry クライアント ライブラリをインストールします。

dotnet add package Azure.Containers.ContainerRegistry --prerelease

クライアントを認証する

アプリケーションをレジストリに接続するには、それによって認証できる ContainerRegistryClient を作成する必要があります。 Azure ID ライブラリを使用して、対応する Azure サービスで Azure SDK クライアントを認証するための Microsoft Entra ID サポートを追加します。

アプリケーションをローカルで開発およびデバッグする場合は、独自のユーザーを使用して自身のレジストリで認証できます。 これを実現する 1 つの方法は、Azure CLI を使用してユーザーを認証し、この環境からアプリケーションを実行することです。 DefaultAzureCredential で認証するように構築されたクライアントをアプリケーションで使用している場合、指定されたエンドポイントのレジストリで正しく認証されます。

// 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
    });

ローカルとデプロイの両方の環境で DefaultAzureCredential を使用して認証するその他の方法については、Azure ID README を参照してください。 パブリックでない Azure クラウド内のレジストリに接続するには、API リファレンスを参照してください。

Azure Container Registry での Microsoft Entra ID の使用に関する詳細については、認証の概要に関するページを参照してください。

各サンプルでは、https:// プレフィックスとログイン サーバーの名前を含む文字列に設定された REGISTRY_ENDPOINT 環境変数 (例: "https://myregistry.azurecr.io"") があることを前提としています。

次のサンプルでは、タスクを返す非同期 API を使用します。 同期 API も使用できます。

リポジトリを非同期的に一覧表示する

レジストリ内のリポジトリのコレクションを反復処理します。

// 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);
}

成果物のプロパティを非同期的に設定する

// 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);
}

イメージを非同期的に削除する

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();
    }
}

はじめに

ソース コード | パッケージ (Maven) | API リファレンス | サンプル

現在サポートされている環境

パッケージを組み込む

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

クライアントを認証する

Azure ID ライブラリでは、認証のために Microsoft Entra ID のサポートが提供されています。

次のサンプルでは、https:// プレフィックスとログイン サーバーの名前を含むレジストリ エンドポイント文字列 (例: "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();

Azure Container Registry での Microsoft Entra ID の使用に関する詳細については、認証の概要に関するページを参照してください。

各サンプルでは、https:// プレフィックスとログイン サーバーの名前を含むレジストリ エンドポイント文字列 (例: "https://myregistry.azurecr.io"") があることを前提としています。

リポジトリ名を一覧表示する

レジストリ内のリポジトリのコレクションを反復処理します。

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

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

成果物のプロパティを設定する

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));

イメージを削除する

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();
        });
}

はじめに

ソース コード | パッケージ (npm) | API リファレンス | サンプル

現在サポートされている環境

詳細については、Microsoft のサポート ポリシーを参照してください。

@azure/container-registry パッケージのインストール

npm を使用して JavaScript 用の Container Registry クライアント ライブラリをインストールします。

npm install @azure/container-registry

クライアントを認証する

Azure ID ライブラリでは、認証のために Microsoft Entra ID のサポートが提供されています。

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());

Azure Container Registry での Microsoft Entra ID の使用に関する詳細については、認証の概要に関するページを参照してください。

各サンプルでは、https:// プレフィックスとログイン サーバーの名前を含む文字列に設定された CONTAINER_REGISTRY_ENDPOINT 環境変数 (例: "https://myregistry.azurecr.io"") があることを前提としています。

リポジトリを非同期的に一覧表示する

レジストリ内のリポジトリのコレクションを反復処理します。

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);
});

成果物のプロパティを非同期的に設定する

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);
});

イメージを非同期的に削除する

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);
});

はじめに

ソース コード | パッケージ (Pypi) | API リファレンス | サンプル

パッケージをインストールする

pip を使用して Python 用の Azure Container Registry クライアント ライブラリをインストールします。

pip install --pre azure-containerregistry

クライアントを認証する

Azure ID ライブラリでは、認証のために Microsoft Entra ID のサポートが提供されています。 DefaultAzureCredential では、AZURE_CLIENT_IDAZURE_TENANT_ID および AZURE_CLIENT_SECRET の環境変数が設定されていることを前提としています。 詳細については、Azure ID の環境変数に関するページを参照してください。

# 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())

各サンプルでは、https:// プレフィックスとログイン サーバーの名前を含む文字列に設定された CONTAINERREGISTRY_ENDPOINT 環境変数 (例: "https://myregistry.azurecr.io"") があることを前提としています。

タグを非同期的に一覧表示する

このサンプルでは、レジストリにリポジトリ 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")

成果物のプロパティを非同期的に設定する

このサンプルでは、v1 のタグが付けられたイメージを持つリポジトリ 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 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.

イメージを非同期的に削除する

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]

はじめに

ソース コード | パッケージ (pkg.go.dev) | REST API リファレンス

パッケージをインストールする

go get を使用して Go 用の Azure Container Registry クライアント ライブラリをインストールします。

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

クライアントを認証する

アプリケーションをローカルで開発およびデバッグする場合は、azidentity.NewDefaultAzureCredential を使用して認証できます。 運用環境ではマネージド ID を使用することをお勧めします。

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)
	}
}

その他の認証方法の詳細については、azidentity のドキュメントを参照してください。

各サンプルでは、コンテナー レジストリ エンドポイントの URL が "https://myregistry.azurecr.io" であると想定しています。

タグの一覧を表示する

このサンプルでは、レジストリにリポジトリ 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)
		}
	}
}

成果物のプロパティを設定する

このサンプルでは、latest のタグが付けられたイメージを持つリポジトリ hello-world がレジストリに含まれていることを前提としています。

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)
}

イメージを削除する

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)
					}
				}
			}
		}
	}
}

リソースをクリーンアップする

Azure コンテナー レジストリをクリーンアップして削除する場合は、リソースまたはリソース グループを削除できます。 リソース グループを削除すると、それに関連付けられている他のリソースも削除されます。

次のステップ

このクイックスタートでは、Azure Container Registry クライアント ライブラリを使用して、コンテナー レジストリ内のイメージと成果物に対して操作を実行する方法について学習しました。

  • 詳細については、次の API リファレンス ドキュメントを参照してください。

  • Azure Container Registry REST API について確認します。