fully qualified reference of the artifact.
The Azure Container Registry endpoint.
Repository name.
Deletes this registry artifact by deleting its manifest.
-
Deletes a tag. This removes the tag from the artifact and its manifest.
the name of the tag to delete.
-
Retrieves the properties of the manifest that uniquely identifies this artifact.
-
Retrieves the properties of the specified tag.
the tag to retrieve properties.
-
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();
}
-
Updates the properties of the artifact's manifest.
Example usage:
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
});
-
Updates the properties of a given tag.
Example usage:
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
});
name of the tag to update properties on
-
Generated using TypeDoc
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.