Partager via

ContainerRepository interface

Paquet:
@azure/container-registry

Un repository dans un registre de conteneurs est un regroupement logique d’images ou d’artefacts qui partagent le même nom. Par exemple, différentes versions d’une application hello-world peuvent avoir des balises v1 et v2, et être regroupées par le référentiel hello-world.

L’interface ContainerRepository est un assistance qui regroupe des informations et des opérations sur un référentiel dans ce registre de conteneurs.

Propriétés

name

Nom du référentiel.
registryEndpoint

Point de terminaison Azure Container Registry.

Méthodes

delete(DeleteRepositoryOptions)

Supprime ce référentiel et tous les artefacts qui font partie de son groupe logique.
getArtifact(string)

Retourne une instance d’assistance de RegistryArtifact pour la balise ou la synthèse donnée.
getProperties(GetRepositoryPropertiesOptions)

Récupère les propriétés de ce référentiel.
listManifestProperties(ListManifestPropertiesOptions)

Retourne un itérateur itérable asynchrone pour répertorier les propriétés du manifeste. Cela est utile pour déterminer la collection d’artefacts associés à ce référentiel, car chaque artefact est identifié de manière unique par son manifeste.

Exemple utilisant for-await-of syntaxe :

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

Exemple utilisant iter.next():

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

Exemple utilisant 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();
}
updateProperties(UpdateRepositoryPropertiesOptions)

Met à jour les propriétés de ce référentiel.

Exemple d’utilisation :

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
const updated = await repository.updateProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

Détails de la propriété

name

Nom du référentiel.

name: string

Valeur de propriété

string

registryEndpoint

Point de terminaison Azure Container Registry.

registryEndpoint: string

Valeur de propriété

string

Détails de la méthode

delete(DeleteRepositoryOptions)

Supprime ce référentiel et tous les artefacts qui font partie de son groupe logique.

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

Paramètres

options
DeleteRepositoryOptions

configuration facultative pour l’opération

Retours

Promise<void>

getArtifact(string)

Retourne une instance d’assistance de RegistryArtifact pour la balise ou la synthèse donnée.

function getArtifact(tagOrDigest: string): RegistryArtifact

Paramètres

tagOrDigest

string

balise ou synthèse de l’artefact

Retours

RegistryArtifact

getProperties(GetRepositoryPropertiesOptions)

Récupère les propriétés de ce référentiel.

function getProperties(options?: GetRepositoryPropertiesOptions): Promise<ContainerRepositoryProperties>

Paramètres

options
GetRepositoryPropertiesOptions

Retours

Promise<ContainerRepositoryProperties>

listManifestProperties(ListManifestPropertiesOptions)

Retourne un itérateur itérable asynchrone pour répertorier les propriétés du manifeste. Cela est utile pour déterminer la collection d’artefacts associés à ce référentiel, car chaque artefact est identifié de manière unique par son manifeste.

Exemple utilisant for-await-of syntaxe :

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

Exemple utilisant iter.next():

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

Exemple utilisant 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();
}

function listManifestProperties(options?: ListManifestPropertiesOptions): PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

Paramètres

options
ListManifestPropertiesOptions

Retours

PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

updateProperties(UpdateRepositoryPropertiesOptions)

Met à jour les propriétés de ce référentiel.

Exemple d’utilisation :

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
const updated = await repository.updateProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

function updateProperties(options: UpdateRepositoryPropertiesOptions): Promise<ContainerRepositoryProperties>

Paramètres

options
UpdateRepositoryPropertiesOptions

Retours

Promise<ContainerRepositoryProperties>