通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ContainerRegistryClient class

  • 参考
包:
@azure/container-registry

用于与容器注册表服务交互的客户端类。

构造函数

ContainerRegistryClient(string, ContainerRegistryClientOptions)

创建 ContainerRegistryClient 的实例，以便与启用了匿名拉取访问的Azure 容器注册表进行交互。 仅启用支持匿名访问的操作。 其他服务方法将引发错误。 用法示例：

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 容器注册表终结点。

方法

deleteRepository(string, DeleteRepositoryOptions)

删除由给定名称标识的存储库以及所有相关项目。
getArtifact(string, string)

返回 的实例， RegistryArtifact 用于调用与 repositoryName 和 tagOrDigest指定的项目相关的服务方法。
getRepository(string)

返回 的实例 ContainerRepository ，用于调用与 repositoryName指定的存储库相关的服务方法。
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)

创建 ContainerRegistryClient 的实例，以便与启用了匿名拉取访问的Azure 容器注册表进行交互。 仅启用支持匿名访问的操作。 其他服务方法将引发错误。 用法示例：

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 容器注册表终结点。

endpoint: string

属性值

string

方法详细信息

deleteRepository(string, DeleteRepositoryOptions)

删除由给定名称标识的存储库以及所有相关项目。

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

参数

repositoryName

string

要删除的存储库的名称

options
DeleteRepositoryOptions

操作的可选配置

返回

Promise<void>

getArtifact(string, string)

返回 的实例， RegistryArtifact 用于调用与 repositoryName 和 tagOrDigest指定的项目相关的服务方法。

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

参数

repositoryName

string

存储库的名称

tagOrDigest

string

要检索的项目的标记或摘要

返回

RegistryArtifact

getRepository(string)

返回 的实例 ContainerRepository ，用于调用与 repositoryName指定的存储库相关的服务方法。

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>

参数

options
ListRepositoriesOptions

返回

PagedAsyncIterableIterator<string, RepositoryPageResponse>