ContainerRegistryClient class

パッケージ:
@azure/container-registry

Container Registry サービスとの対話に使用されるクライアント クラス。

コンストラクター

ContainerRegistryClient(string, ContainerRegistryClientOptions)

匿名のプル アクセスが有効になっている Azure Container Registry と対話する ContainerRegistryClient のインスタンスを作成します。 匿名アクセスをサポートする操作のみが有効になります。 他のサービス メソッドではエラーがスローされます。

使用例:

import { ContainerRegistryClient, KnownContainerRegistryAudience } from "@azure/container-registry";

const endpoint = "https://myregistryname.azurecr.io";
// Create a new ContainerRegistryClient for anonymous access
const client = new ContainerRegistryClient(endpoint, {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});
ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

ContainerRegistryClient のインスタンスを作成します。

使用例:

import { ContainerRegistryClient, KnownContainerRegistryAudience } from "@azure/container-registry";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://myregistryname.azurecr.io";
// Create a ContainerRegistryClient that will authenticate through Active Directory
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});

プロパティ

endpoint

Azure Container Registry エンドポイント。

メソッド

deleteRepository(string, DeleteRepositoryOptions)

指定された名前で識別されたリポジトリと、関連付けられているすべての成果物を削除します。
getArtifact(string, string)

および repositoryNameで指定 tagOrDigest のインスタンスを返します。
getRepository(string)

で指定 repositoryName のインスタンスを返します。
listRepositoryNames(ListRepositoriesOptions)

このレジストリ内のリポジトリの名前を一覧表示する非同期反復可能反復子を返します。

使用例:

import { ContainerRegistryClient, KnownContainerRegistryAudience } from "@azure/container-registry";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://myregistryname.azurecr.io";
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});

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

コンストラクターの詳細

ContainerRegistryClient(string, ContainerRegistryClientOptions)

匿名のプル アクセスが有効になっている Azure Container Registry と対話する ContainerRegistryClient のインスタンスを作成します。 匿名アクセスをサポートする操作のみが有効になります。 他のサービス メソッドではエラーがスローされます。

使用例:

import { ContainerRegistryClient, KnownContainerRegistryAudience } from "@azure/container-registry";

const endpoint = "https://myregistryname.azurecr.io";
// Create a new ContainerRegistryClient for anonymous access
const client = new ContainerRegistryClient(endpoint, {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});

new ContainerRegistryClient(endpoint: string, options?: ContainerRegistryClientOptions)

パラメーター

endpoint

string

コンテナー レジストリの URL エンドポイント

options
ContainerRegistryClientOptions

サービスに要求を送信するために使用されるオプションの構成

ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

ContainerRegistryClient のインスタンスを作成します。

使用例:

import { ContainerRegistryClient, KnownContainerRegistryAudience } from "@azure/container-registry";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://myregistryname.azurecr.io";
// Create a ContainerRegistryClient that will authenticate through Active Directory
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});

new ContainerRegistryClient(endpoint: string, credential: TokenCredential, options?: ContainerRegistryClientOptions)

パラメーター

endpoint

string

コンテナー レジストリの URL エンドポイント

credential
TokenCredential

サービスへの要求を認証するために使用されます

options
ContainerRegistryClientOptions

サービスに要求を送信するために使用されるオプションの構成

プロパティの詳細

endpoint

Azure Container Registry エンドポイント。

endpoint: string

プロパティ値

string

メソッドの詳細

deleteRepository(string, DeleteRepositoryOptions)

指定された名前で識別されたリポジトリと、関連付けられているすべての成果物を削除します。

function deleteRepository(repositoryName: string, options?: DeleteRepositoryOptions): Promise<void>

パラメーター

repositoryName

string

削除するリポジトリの名前

options
DeleteRepositoryOptions

操作の省略可能な構成

戻り値

Promise<void>

getArtifact(string, string)

および repositoryNameで指定 tagOrDigest のインスタンスを返します。

function getArtifact(repositoryName: string, tagOrDigest: string): RegistryArtifact

パラメーター

repositoryName

string

リポジトリの名前

tagOrDigest

string

取得するアーティファクトのタグまたはダイジェスト

戻り値

RegistryArtifact

getRepository(string)

で指定 repositoryName のインスタンスを返します。

function getRepository(repositoryName: string): ContainerRepository

パラメーター

repositoryName

string

リポジトリの名前

戻り値

ContainerRepository

listRepositoryNames(ListRepositoriesOptions)

このレジストリ内のリポジトリの名前を一覧表示する非同期反復可能反復子を返します。

使用例:

import { ContainerRegistryClient, KnownContainerRegistryAudience } from "@azure/container-registry";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://myregistryname.azurecr.io";
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential(), {
  audience: KnownContainerRegistryAudience.AzureResourceManagerPublicCloud,
});

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

function listRepositoryNames(options?: ListRepositoriesOptions): PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>

パラメーター

options
ListRepositoriesOptions

リクエストの選択肢

戻り値

PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>