Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ContainerRepository

Package version

A repository in a container registry is a logical grouping of images or artifacts that share the same name. For example, different versions of a hello-world application could have tags v1 and v2, and be grouped by the repository hello-world.

The ContainerRepository interface is a helper that groups information and operations about a repository in this container registry.

Hierarchy

  • ContainerRepository

Index

Properties

name

name: string

Repository name.

registryEndpoint

registryEndpoint: string

The Azure Container Registry endpoint.

Methods

delete

getArtifact

getProperties

listManifestProperties

  • Returns an async iterable iterator to list manifest properties. This is useful for determining the collection of artifacts associated with this repository, as each artifact is uniquely identified by its manifest.

    Example using for-await-of syntax:

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

    Example using iter.next():

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

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

    Parameters

    Returns PagedAsyncIterableIterator<ArtifactManifestProperties>

updateProperties

Generated using TypeDoc