共用方式為

RegistryArtifact interface

套件:
@azure/container-registry

Artifact 是儲存在容器登錄中的專案的一般詞彙，而且可以包含 Docker 映像或其他 Open Container Initiative （OCI） 成品類型。

RegistryArtifact 介面是協助程式，可群組容器登錄中映射或成品的相關信息和作業。

屬性

fullyQualifiedReference

成品的完整參考。
registryEndpoint

Azure Container Registry 端點。
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 Container Registry 端點。

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>