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

ContainerRegistryClient class

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

构造函数

ContainerRegistryClient(string, ContainerRegistryClientOptions)

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

示例用法:

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

方法

deleteRepository(string, DeleteRepositoryOptions)

删除由给定名称和所有关联的项目标识的存储库。

getArtifact(string, string)

返回 RegistryArtifact 的实例,该实例用于调用与 repositoryNametagOrDigest指定的项目相关的服务方法。

getRepository(string)

返回 ContainerRepository 的实例,用于调用与 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)

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

示例用法:

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

endpoint: string

属性值

string

方法详细信息

deleteRepository(string, DeleteRepositoryOptions)

删除由给定名称和所有关联的项目标识的存储库。

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

参数

repositoryName

string

要删除的存储库的名称

options
DeleteRepositoryOptions

作的可选配置

返回

Promise<void>

getArtifact(string, string)

返回 RegistryArtifact 的实例,该实例用于调用与 repositoryNametagOrDigest指定的项目相关的服务方法。

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

参数

repositoryName

string

存储库的名称

tagOrDigest

string

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

返回

getRepository(string)

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

function getRepository(repositoryName: string): ContainerRepository

参数

repositoryName

string

存储库的名称

返回

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

请求的选项

返回