Compartir a través de

ContainerRepository interface

Paquete:
@azure/container-registry

Un repository en un registro de contenedor es una agrupación lógica de imágenes o artefactos que comparten el mismo nombre. Por ejemplo, diferentes versiones de una aplicación de hello-world podrían tener etiquetas v1 y v2y agruparlas por el repositorio hello-world.

La interfaz ContainerRepository es un asistente que agrupa información y operaciones sobre un repositorio en este registro de contenedor.

Propiedades

name

Nombre del repositorio.
registryEndpoint

Punto de conexión de Azure Container Registry.

Métodos

delete(DeleteRepositoryOptions)

Elimina este repositorio y todos los artefactos que forman parte de su grupo lógico.
getArtifact(string)

Devuelve una instancia auxiliar de registryArtifact para la etiqueta o resumen especificados.
getProperties(GetRepositoryPropertiesOptions)

Recupera las propiedades de este repositorio.
listManifestProperties(ListManifestPropertiesOptions)

Devuelve un iterador iterable asincrónico para enumerar las propiedades del manifiesto. Esto resulta útil para determinar la colección de artefactos asociados a este repositorio, ya que cada artefacto se identifica de forma única mediante su manifiesto.

Ejemplo de uso de la sintaxis de for-await-of:

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

Ejemplo de uso de iter.next():

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

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

Actualiza las propiedades de este repositorio.

Uso de ejemplo:

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

Detalles de las propiedades

name

Nombre del repositorio.

name: string

Valor de propiedad

string

registryEndpoint

Punto de conexión de Azure Container Registry.

registryEndpoint: string

Valor de propiedad

string

Detalles del método

delete(DeleteRepositoryOptions)

Elimina este repositorio y todos los artefactos que forman parte de su grupo lógico.

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

Parámetros

options
DeleteRepositoryOptions

configuración opcional para la operación

Devoluciones

Promise<void>

getArtifact(string)

Devuelve una instancia auxiliar de registryArtifact para la etiqueta o resumen especificados.

function getArtifact(tagOrDigest: string): RegistryArtifact

Parámetros

tagOrDigest

string

etiqueta o resumen del artefacto

Devoluciones

RegistryArtifact

getProperties(GetRepositoryPropertiesOptions)

Recupera las propiedades de este repositorio.

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

Parámetros

options
GetRepositoryPropertiesOptions

Devoluciones

Promise<ContainerRepositoryProperties>

listManifestProperties(ListManifestPropertiesOptions)

Devuelve un iterador iterable asincrónico para enumerar las propiedades del manifiesto. Esto resulta útil para determinar la colección de artefactos asociados a este repositorio, ya que cada artefacto se identifica de forma única mediante su manifiesto.

Ejemplo de uso de la sintaxis de for-await-of:

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

Ejemplo de uso de iter.next():

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

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

Parámetros

options
ListManifestPropertiesOptions

Devoluciones

PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

updateProperties(UpdateRepositoryPropertiesOptions)

Actualiza las propiedades de este repositorio.

Uso de ejemplo:

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>

Parámetros

options
UpdateRepositoryPropertiesOptions

Devoluciones

Promise<ContainerRepositoryProperties>