Compartir a través de

RegistryArtifact interface

  • Referencia
Paquete:
@azure/container-registry

Artifact es el término general para los elementos almacenados en un registro de contenedor y puede incluir imágenes de Docker u otros tipos de artefactos de Open Container Initiative (OCI).

La interfaz registryArtifact de es un asistente que agrupa información y operaciones sobre una imagen o artefacto en un registro de contenedor.

Propiedades

fullyQualifiedReference

referencia completa del artefacto.
registryEndpoint

Punto de conexión de Azure Container Registry.
repositoryName

Nombre del repositorio.

Métodos

delete(DeleteArtifactOptions)

Elimina este artefacto del Registro mediante la eliminación de su manifiesto.
deleteTag(string, DeleteTagOptions)

Elimina una etiqueta. Esto quita la etiqueta del artefacto y su manifiesto.
getManifestProperties(GetManifestPropertiesOptions)

Recupera las propiedades del manifiesto que identifica de forma única este artefacto.
getTagProperties(string, GetTagPropertiesOptions)

Recupera las propiedades de la etiqueta especificada.
listTagProperties(ListTagPropertiesOptions)

Devuelve un iterador iterable asincrónico para enumerar las etiquetas que identifican de forma única este artefacto y las propiedades de cada uno.

Ejemplo de uso de la sintaxis de 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);
}

Ejemplo de uso de iter.next():

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

Ejemplo de uso de 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)

Actualiza las propiedades del manifiesto del artefacto.

Uso de ejemplo:

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)

Actualiza las propiedades de una etiqueta determinada.

Uso de ejemplo:

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

Detalles de las propiedades

fullyQualifiedReference

referencia completa del artefacto.

fullyQualifiedReference: string

Valor de propiedad

string

registryEndpoint

Punto de conexión de Azure Container Registry.

registryEndpoint: string

Valor de propiedad

string

repositoryName

Nombre del repositorio.

repositoryName: string

Valor de propiedad

string

Detalles del método

delete(DeleteArtifactOptions)

Elimina este artefacto del Registro mediante la eliminación de su manifiesto.

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

Parámetros

options
DeleteArtifactOptions

Devoluciones

Promise<void>

deleteTag(string, DeleteTagOptions)

Elimina una etiqueta. Esto quita la etiqueta del artefacto y su manifiesto.

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

Parámetros

tag

string

el nombre de la etiqueta que se va a eliminar.

options
DeleteTagOptions

Devoluciones

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

Recupera las propiedades del manifiesto que identifica de forma única este artefacto.

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

Parámetros

options
GetManifestPropertiesOptions

Devoluciones

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

Recupera las propiedades de la etiqueta especificada.

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

Parámetros

tag

string

etiqueta que se va a recuperar.

options
GetTagPropertiesOptions

Devoluciones

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

Devuelve un iterador iterable asincrónico para enumerar las etiquetas que identifican de forma única este artefacto y las propiedades de cada uno.

Ejemplo de uso de la sintaxis de 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);
}

Ejemplo de uso de iter.next():

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

Ejemplo de uso de 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>

Parámetros

options
ListTagPropertiesOptions

Devoluciones

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

Actualiza las propiedades del manifiesto del artefacto.

Uso de ejemplo:

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>

Parámetros

options
UpdateManifestPropertiesOptions

Devoluciones

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

Actualiza las propiedades de una etiqueta determinada.

Uso de ejemplo:

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>

Parámetros

tag

string

nombre de la etiqueta en la que se van a actualizar las propiedades

options
UpdateTagPropertiesOptions

Devoluciones

Promise<ArtifactTagProperties>