通过

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

ContainerRepository interface

  • 参考
包:
@azure/container-registry

repository容器注册表中的 是共享同名的映像或项目的逻辑分组。 例如，应用程序的不同版本 hello-world 可以具有 标记 v1 和 v2，并按存储库 hello-world进行分组。

ContainerRepository 接口是一个帮助程序，用于对有关此容器注册表中的存储库的信息和操作进行分组。

属性

name

存储库名称。
registryEndpoint

Azure 容器注册表终结点。

方法

delete(DeleteRepositoryOptions)

删除此存储库及其逻辑组中的所有项目。
getArtifact(string)

返回给定标记或摘要的 RegistryArtifact 的帮助程序实例。
getProperties(GetRepositoryPropertiesOptions)

检索此存储库的属性。
listManifestProperties(ListManifestPropertiesOptions)

返回可列出清单属性的异步可迭代器。 这对于确定与此存储库关联的项目集合很有用，因为每个项目都由其清单唯一标识。

使用 for-await-of 语法的示例：

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
for await (const manifest of repository.listManifestProperties()) {
  console.log("manifest: ", manifest);
}

使用 iter.next() 的示例：

const iter = repository.listManifestProperties();
let item = await iter.next();
while (!item.done) {
  console.log("manifest properties: ", item.value);
  item = await iter.next();
}

使用 byPage() 的示例：

const pages = repository.listManifestProperties().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const manifestProperties of page.value) {
     console.log(`  manifest properties: ${manifestProperties}`);
   }
 }
 page = await pages.next();
}
updateProperties(UpdateRepositoryPropertiesOptions)

汇报此存储库的属性。

用法示例：

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
const updated = await repository.updateProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

属性详细信息

name

存储库名称。

name: string

属性值

string

registryEndpoint

Azure 容器注册表终结点。

registryEndpoint: string

属性值

string

方法详细信息

delete(DeleteRepositoryOptions)

删除此存储库及其逻辑组中的所有项目。

function delete(options?: DeleteRepositoryOptions): Promise<void>

参数

options
DeleteRepositoryOptions

操作的可选配置

返回

Promise<void>

getArtifact(string)

返回给定标记或摘要的 RegistryArtifact 的帮助程序实例。

function getArtifact(tagOrDigest: string): RegistryArtifact

参数

tagOrDigest

string

项目的标记或摘要

返回

RegistryArtifact

getProperties(GetRepositoryPropertiesOptions)

检索此存储库的属性。

function getProperties(options?: GetRepositoryPropertiesOptions): Promise<ContainerRepositoryProperties>

参数

options
GetRepositoryPropertiesOptions

返回

Promise<ContainerRepositoryProperties>

listManifestProperties(ListManifestPropertiesOptions)

返回可列出清单属性的异步可迭代器。 这对于确定与此存储库关联的项目集合很有用，因为每个项目都由其清单唯一标识。

使用 for-await-of 语法的示例：

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
for await (const manifest of repository.listManifestProperties()) {
  console.log("manifest: ", manifest);
}

使用 iter.next() 的示例：

const iter = repository.listManifestProperties();
let item = await iter.next();
while (!item.done) {
  console.log("manifest properties: ", item.value);
  item = await iter.next();
}

使用 byPage() 的示例：

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

function listManifestProperties(options?: ListManifestPropertiesOptions): PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

参数

options
ListManifestPropertiesOptions

返回

PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

updateProperties(UpdateRepositoryPropertiesOptions)

汇报此存储库的属性。

用法示例：

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
const updated = await repository.updateProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

function updateProperties(options: UpdateRepositoryPropertiesOptions): Promise<ContainerRepositoryProperties>

参数

options
UpdateRepositoryPropertiesOptions

返回

Promise<ContainerRepositoryProperties>