通过

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

RegistryArtifact interface

  • 参考
包:
@azure/container-registry

Artifact 是容器注册表中存储的项的通用术语，可以包含 Docker 映像或其他开放容器计划 (OCI) 项目类型。

RegistryArtifact 接口是一个帮助程序，用于对有关容器注册表中的映像或项目的信息和操作进行分组。

属性

fullyQualifiedReference

项目的完全限定引用。
registryEndpoint

Azure 容器注册表终结点。
repositoryName

存储库名称。

方法

delete(DeleteArtifactOptions)

通过删除此注册表项目清单来删除此注册表项目。
deleteTag(string, DeleteTagOptions)

删除标记。 这会从项目及其清单中删除 标记。
getManifestProperties(GetManifestPropertiesOptions)

检索唯一标识此项目的清单的属性。
getTagProperties(string, GetTagPropertiesOptions)

检索指定标记的属性。
listTagProperties(ListTagPropertiesOptions)

返回一个异步可迭代迭代器，以列出唯一标识此项目的标记以及每个项目的属性。

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

const client = new ContainerRegistryClient(url, credentials);
const repository = client.getRepository(repositoryName);
const artifact = repository.getArtifact(digest)
for await (const tag of artifact.listTagProperties()) {
  console.log("tag: ", tag);
}

使用 iter.next() 的示例：

const iter = artifact.listTagProperties();
let item = await iter.next();
while (!item.done) {
  console.log("tag properties: ", item.value);
  item = await iter.next();
}

使用 byPage() 的示例：

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

汇报项目清单的属性。

用法示例：

const client = new ContainerRegistryClient(url, credential);
const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
const updated = await artifact.updateManifestProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});
updateTagProperties(string, UpdateTagPropertiesOptions)

汇报给定标记的属性。

用法示例：

const client = new ContainerRegistryClient(url, credential);
const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
const updated = await artifact.updateTagProperties(tag, {
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

属性详细信息

fullyQualifiedReference

项目的完全限定引用。

fullyQualifiedReference: string

属性值

string

registryEndpoint

Azure 容器注册表终结点。

registryEndpoint: string

属性值

string

repositoryName

存储库名称。

repositoryName: string

属性值

string

方法详细信息

delete(DeleteArtifactOptions)

通过删除此注册表项目清单来删除此注册表项目。

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

参数

options
DeleteArtifactOptions

返回

Promise<void>

deleteTag(string, DeleteTagOptions)

删除标记。 这会从项目及其清单中删除 标记。

function deleteTag(tag: string, options?: DeleteTagOptions): Promise<void>

参数

tag

string

要删除的标记的名称。

options
DeleteTagOptions

返回

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

检索唯一标识此项目的清单的属性。

function getManifestProperties(options?: GetManifestPropertiesOptions): Promise<ArtifactManifestProperties>

参数

options
GetManifestPropertiesOptions

返回

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

检索指定标记的属性。

function getTagProperties(tag: string, options?: GetTagPropertiesOptions): Promise<ArtifactTagProperties>

参数

tag

string

要检索属性的标记。

options
GetTagPropertiesOptions

返回

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

返回一个异步可迭代迭代器，以列出唯一标识此项目的标记以及每个项目的属性。

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

const client = new ContainerRegistryClient(url, credentials);
const repository = client.getRepository(repositoryName);
const artifact = repository.getArtifact(digest)
for await (const tag of artifact.listTagProperties()) {
  console.log("tag: ", tag);
}

使用 iter.next() 的示例：

const iter = artifact.listTagProperties();
let item = await iter.next();
while (!item.done) {
  console.log("tag properties: ", item.value);
  item = await iter.next();
}

使用 byPage() 的示例：

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

function listTagProperties(options?: ListTagPropertiesOptions): PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

参数

options
ListTagPropertiesOptions

返回

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

汇报项目清单的属性。

用法示例：

const client = new ContainerRegistryClient(url, credential);
const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
const updated = await artifact.updateManifestProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

function updateManifestProperties(options: UpdateManifestPropertiesOptions): Promise<ArtifactManifestProperties>

参数

options
UpdateManifestPropertiesOptions

返回

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

汇报给定标记的属性。

用法示例：

const client = new ContainerRegistryClient(url, credential);
const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
const updated = await artifact.updateTagProperties(tag, {
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

function updateTagProperties(tag: string, options: UpdateTagPropertiesOptions): Promise<ArtifactTagProperties>

参数

tag

string

要更新其属性的标记的名称

options
UpdateTagPropertiesOptions

返回

Promise<ArtifactTagProperties>