Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RegistryArtifact

Package version

Artifact is the general term for items stored in a container registry, and can include Docker images or other Open Container Initiative (OCI) artifact types.

The RegistryArtifact interface is a helper that groups information and operations about an image or artifact in a container registry.

Hierarchy

  • RegistryArtifact

Index

Properties

fullyQualifiedReference

fullyQualifiedReference: string

fully qualified reference of the artifact.

registryEndpoint

registryEndpoint: string

The Azure Container Registry endpoint.

repositoryName

repositoryName: string

Repository name.

Methods

delete

deleteTag

getManifestProperties

getTagProperties

listTagProperties

  • Returns an async iterable iterator to list the tags that uniquely identify this artifact and the properties of each.

    Example using for-await-of syntax:

    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);
    }

    Example using iter.next():

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

    Example using 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();
    }

    Parameters

    Returns PagedAsyncIterableIterator<ArtifactTagProperties>

updateManifestProperties

updateTagProperties

Generated using TypeDoc