Partager via

RegistryArtifact interface

  • Référence
Paquet:
@azure/container-registry

Artifact est le terme général pour les éléments stockés dans un registre de conteneurs, et peut inclure des images Docker ou d’autres types d’artefacts OCI (Open Container Initiative).

L’interface RegistryArtifact est une assistance qui regroupe des informations et des opérations sur une image ou un artefact dans un registre de conteneurs.

Propriétés

fullyQualifiedReference

référence complète de l’artefact.
registryEndpoint

Point de terminaison Azure Container Registry.
repositoryName

Nom du référentiel.

Méthodes

delete(DeleteArtifactOptions)

Supprime cet artefact de Registre en supprimant son manifeste.
deleteTag(string, DeleteTagOptions)

Supprime une balise. Cela supprime la balise de l’artefact et de son manifeste.
getManifestProperties(GetManifestPropertiesOptions)

Récupère les propriétés du manifeste qui identifie de manière unique cet artefact.
getTagProperties(string, GetTagPropertiesOptions)

Récupère les propriétés de la balise spécifiée.
listTagProperties(ListTagPropertiesOptions)

Retourne un itérateur itérable asynchrone pour répertorier les balises qui identifient de manière unique cet artefact et les propriétés de chacune d’elles.

Exemple utilisant la for-await-of syntaxe :

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

Exemple utilisant iter.next() :

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

Exemple utilisant 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)

Mises à jour les propriétés du manifeste de l’artefact.

Exemple d’utilisation :

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)

Mises à jour les propriétés d’une balise donnée.

Exemple d’utilisation :

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

Détails de la propriété

fullyQualifiedReference

référence complète de l’artefact.

fullyQualifiedReference: string

Valeur de propriété

string

registryEndpoint

Point de terminaison Azure Container Registry.

registryEndpoint: string

Valeur de propriété

string

repositoryName

Nom du référentiel.

repositoryName: string

Valeur de propriété

string

Détails de la méthode

delete(DeleteArtifactOptions)

Supprime cet artefact de Registre en supprimant son manifeste.

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

Paramètres

options
DeleteArtifactOptions

Retours

Promise<void>

deleteTag(string, DeleteTagOptions)

Supprime une balise. Cela supprime la balise de l’artefact et de son manifeste.

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

Paramètres

tag

string

nom de la balise à supprimer.

options
DeleteTagOptions

Retours

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

Récupère les propriétés du manifeste qui identifie de manière unique cet artefact.

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

Paramètres

options
GetManifestPropertiesOptions

Retours

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

Récupère les propriétés de la balise spécifiée.

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

Paramètres

tag

string

balise pour récupérer les propriétés.

options
GetTagPropertiesOptions

Retours

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

Retourne un itérateur itérable asynchrone pour répertorier les balises qui identifient de manière unique cet artefact et les propriétés de chacune d’elles.

Exemple utilisant la for-await-of syntaxe :

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

Exemple utilisant iter.next() :

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

Exemple utilisant 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>

Paramètres

options
ListTagPropertiesOptions

Retours

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

Mises à jour les propriétés du manifeste de l’artefact.

Exemple d’utilisation :

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>

Paramètres

options
UpdateManifestPropertiesOptions

Retours

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

Mises à jour les propriétés d’une balise donnée.

Exemple d’utilisation :

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>

Paramètres

tag

string

nom de la balise sur laquelle mettre à jour les propriétés

options
UpdateTagPropertiesOptions

Retours

Promise<ArtifactTagProperties>