次の方法で共有

ContainerRegistryClient class

  • リファレンス
パッケージ:
@azure/container-registry

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

コンストラクター

ContainerRegistryClient(string, ContainerRegistryClientOptions)

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

使用例:

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

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
);
ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

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

使用例:

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

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
   new DefaultAzureCredential()
);

プロパティ

endpoint

Azure Container Registry エンドポイント。

メソッド

deleteRepository(string, DeleteRepositoryOptions)

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

および tagOrDigestでrepositoryName指定された成果物に関連するサービス メソッドを呼び出すための RegistryArtifact のインスタンスを返します。
getRepository(string)

でrepositoryName指定されたリポジトリに関連するサービス メソッドを呼び出すための ContainerRepository のインスタンスを返します。
listRepositoryNames(ListRepositoriesOptions)

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

使用例:

let client = new ContainerRegistryClient(url, credential);
for await (const repository of client.listRepositoryNames()) {
  console.log("repository name: ", repository);
}

iter.next() の使用例:

let iter = client.listRepositoryNames();
let item = await iter.next();
while (!item.done) {
  console.log(`repository name: ${item.value}`);
  item = await iter.next();
}

byPage() の使用例:

const pages = client.listRepositoryNames().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const name of page.value) {
     console.log(`  repository name: ${name}`);
   }
 }
 page = await pages.next();
}

コンストラクターの詳細

ContainerRegistryClient(string, ContainerRegistryClientOptions)

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

使用例:

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

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
);

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

パラメーター

endpoint

string

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

options
ContainerRegistryClientOptions

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

ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

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

使用例:

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

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
   new DefaultAzureCredential()
);

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)

および tagOrDigestでrepositoryName指定された成果物に関連するサービス メソッドを呼び出すための RegistryArtifact のインスタンスを返します。

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

パラメーター

repositoryName

string

リポジトリの名前

tagOrDigest

string

取得する成果物のタグまたはダイジェスト

戻り値

RegistryArtifact

getRepository(string)

でrepositoryName指定されたリポジトリに関連するサービス メソッドを呼び出すための ContainerRepository のインスタンスを返します。

function getRepository(repositoryName: string): ContainerRepository

パラメーター

repositoryName

string

リポジトリの名前

戻り値

ContainerRepository

listRepositoryNames(ListRepositoriesOptions)

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

使用例:

let client = new ContainerRegistryClient(url, credential);
for await (const repository of client.listRepositoryNames()) {
  console.log("repository name: ", repository);
}

iter.next() の使用例:

let iter = client.listRepositoryNames();
let item = await iter.next();
while (!item.done) {
  console.log(`repository name: ${item.value}`);
  item = await iter.next();
}

byPage() の使用例:

const pages = client.listRepositoryNames().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const name of page.value) {
     console.log(`  repository name: ${name}`);
   }
 }
 page = await pages.next();
}

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

パラメーター

options
ListRepositoriesOptions

戻り値

PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>