Condividi tramite

RegistryArtifact interface

  • Riferimento
Pacchetto:
@azure/container-registry

Artifact è il termine generale per gli elementi archiviati in un registro contenitori e può includere immagini Docker o altri tipi di artefatti OCI (Open Container Initiative).

L'interfaccia RegistryArtifact è un helper che raggruppa informazioni e operazioni su un'immagine o un artefatto in un registro contenitori.

Proprietà

fullyQualifiedReference

Riferimento completo dell'artefatto.
registryEndpoint

Endpoint del Registro Azure Container.
repositoryName

Nome del repository.

Metodi

delete(DeleteArtifactOptions)

Elimina questo artefatto del Registro di sistema eliminandone il manifesto.
deleteTag(string, DeleteTagOptions)

Elimina un tag. In questo modo il tag viene rimosso dall'artefatto e dal relativo manifesto.
getManifestProperties(GetManifestPropertiesOptions)

Recupera le proprietà del manifesto che identificano in modo univoco questo artefatto.
getTagProperties(string, GetTagPropertiesOptions)

Recupera le proprietà del tag specificato.
listTagProperties(ListTagPropertiesOptions)

Restituisce un iteratore iteratore asincrono per elencare i tag che identificano in modo univoco questo artefatto e le proprietà di ogni elemento.

Esempio di utilizzo della sintassi for-await-of:

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

Esempio di utilizzo di iter.next():

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

Esempio di utilizzo di 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)

Aggiorna le proprietà del manifesto dell'artefatto.

Esempio di utilizzo:

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)

Aggiorna le proprietà di un tag specificato.

Esempio di utilizzo:

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

Dettagli proprietà

fullyQualifiedReference

Riferimento completo dell'artefatto.

fullyQualifiedReference: string

Valore della proprietà

string

registryEndpoint

Endpoint del Registro Azure Container.

registryEndpoint: string

Valore della proprietà

string

repositoryName

Nome del repository.

repositoryName: string

Valore della proprietà

string

Dettagli metodo

delete(DeleteArtifactOptions)

Elimina questo artefatto del Registro di sistema eliminandone il manifesto.

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

Parametri

options
DeleteArtifactOptions

Restituisce

Promise<void>

deleteTag(string, DeleteTagOptions)

Elimina un tag. In questo modo il tag viene rimosso dall'artefatto e dal relativo manifesto.

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

Parametri

tag

string

nome del tag da eliminare.

options
DeleteTagOptions

Restituisce

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

Recupera le proprietà del manifesto che identificano in modo univoco questo artefatto.

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

Parametri

options
GetManifestPropertiesOptions

Restituisce

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

Recupera le proprietà del tag specificato.

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

Parametri

tag

string

tag per recuperare le proprietà.

options
GetTagPropertiesOptions

Restituisce

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

Restituisce un iteratore iteratore asincrono per elencare i tag che identificano in modo univoco questo artefatto e le proprietà di ogni elemento.

Esempio di utilizzo della sintassi for-await-of:

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

Esempio di utilizzo di iter.next():

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

Esempio di utilizzo di 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>

Parametri

options
ListTagPropertiesOptions

Restituisce

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

Aggiorna le proprietà del manifesto dell'artefatto.

Esempio di utilizzo:

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>

Parametri

options
UpdateManifestPropertiesOptions

Restituisce

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

Aggiorna le proprietà di un tag specificato.

Esempio di utilizzo:

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>

Parametri

tag

string

nome del tag in cui aggiornare le proprietà

options
UpdateTagPropertiesOptions

Restituisce

Promise<ArtifactTagProperties>