Compartir a través de

ContainerRegistryClient class

  • Referencia
Paquete:
@azure/container-registry

La clase de cliente que se usa para interactuar con el servicio Container Registry.

Constructores

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Crea una instancia de ContainerRegistryClient para interactuar con una Azure Container Registry que tenga habilitado el acceso de extracción anónimo. Solo se habilitan las operaciones que admiten el acceso anónimo. Otros métodos de servicio producirán errores.

Ejemplo de uso:

import { ContainerRegistryClient } from "@azure/container-registry";

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
);
ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Crea una instancia de ContainerRegistryClient.

Ejemplo de uso:

import { ContainerRegistryClient } from "@azure/container-registry";
import { DefaultAzureCredential} from "@azure/identity";

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
   new DefaultAzureCredential()
);

Propiedades

endpoint

Punto de conexión Azure Container Registry.

Métodos

deleteRepository(string, DeleteRepositoryOptions)

Elimina el repositorio identificado por el nombre especificado y todos los artefactos asociados.
getArtifact(string, string)

Devuelve una instancia de RegistryArtifact para llamar a métodos de servicio relacionados con el artefacto especificado por repositoryName y tagOrDigest.
getRepository(string)

Devuelve una instancia de ContainerRepository para llamar a métodos de servicio relacionados con el repositorio especificado por repositoryName.
listRepositoryNames(ListRepositoriesOptions)

Devuelve un iterador asincrónico para enumerar los nombres de los repositorios de este registro.

Ejemplo de uso:

let client = new ContainerRegistryClient(url, credential);
for await (const repository of client.listRepositoryNames()) {
  console.log("repository name: ", repository);
}

Ejemplo con iter.next():

let iter = client.listRepositoryNames();
let item = await iter.next();
while (!item.done) {
  console.log(`repository name: ${item.value}`);
  item = await iter.next();
}

Ejemplo con byPage():

const pages = client.listRepositoryNames().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const name of page.value) {
     console.log(`  repository name: ${name}`);
   }
 }
 page = await pages.next();
}

Detalles del constructor

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Crea una instancia de ContainerRegistryClient para interactuar con una Azure Container Registry que tenga habilitado el acceso de extracción anónimo. Solo se habilitan las operaciones que admiten el acceso anónimo. Otros métodos de servicio producirán errores.

Ejemplo de uso:

import { ContainerRegistryClient } from "@azure/container-registry";

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
);

new ContainerRegistryClient(endpoint: string, options?: ContainerRegistryClientOptions)

Parámetros

endpoint

string

el punto de conexión de dirección URL del registro de contenedor

options
ContainerRegistryClientOptions

configuración opcional que se usa para enviar solicitudes al servicio

ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Crea una instancia de ContainerRegistryClient.

Ejemplo de uso:

import { ContainerRegistryClient } from "@azure/container-registry";
import { DefaultAzureCredential} from "@azure/identity";

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
   new DefaultAzureCredential()
);

new ContainerRegistryClient(endpoint: string, credential: TokenCredential, options?: ContainerRegistryClientOptions)

Parámetros

endpoint

string

el punto de conexión de dirección URL del registro de contenedor

credential
TokenCredential

se usa para autenticar solicitudes en el servicio

options
ContainerRegistryClientOptions

configuración opcional que se usa para enviar solicitudes al servicio

Detalles de las propiedades

endpoint

Punto de conexión Azure Container Registry.

endpoint: string

Valor de propiedad

string

Detalles del método

deleteRepository(string, DeleteRepositoryOptions)

Elimina el repositorio identificado por el nombre especificado y todos los artefactos asociados.

function deleteRepository(repositoryName: string, options?: DeleteRepositoryOptions): Promise<void>

Parámetros

repositoryName

string

el nombre del repositorio que se va a eliminar

options
DeleteRepositoryOptions

configuración opcional para la operación

Devoluciones

Promise<void>

getArtifact(string, string)

Devuelve una instancia de RegistryArtifact para llamar a métodos de servicio relacionados con el artefacto especificado por repositoryName y tagOrDigest.

function getArtifact(repositoryName: string, tagOrDigest: string): RegistryArtifact

Parámetros

repositoryName

string

el nombre del repositorio

tagOrDigest

string

etiqueta o resumen del artefacto que se va a recuperar

Devoluciones

RegistryArtifact

getRepository(string)

Devuelve una instancia de ContainerRepository para llamar a métodos de servicio relacionados con el repositorio especificado por repositoryName.

function getRepository(repositoryName: string): ContainerRepository

Parámetros

repositoryName

string

el nombre del repositorio

Devoluciones

ContainerRepository

listRepositoryNames(ListRepositoriesOptions)

Devuelve un iterador asincrónico para enumerar los nombres de los repositorios de este registro.

Ejemplo de uso:

let client = new ContainerRegistryClient(url, credential);
for await (const repository of client.listRepositoryNames()) {
  console.log("repository name: ", repository);
}

Ejemplo con iter.next():

let iter = client.listRepositoryNames();
let item = await iter.next();
while (!item.done) {
  console.log(`repository name: ${item.value}`);
  item = await iter.next();
}

Ejemplo con byPage():

const pages = client.listRepositoryNames().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const name of page.value) {
     console.log(`  repository name: ${name}`);
   }
 }
 page = await pages.next();
}

function listRepositoryNames(options?: ListRepositoriesOptions): PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>

Parámetros

options
ListRepositoriesOptions

Devoluciones

PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>