Compartilhar via

ContainerRegistryClient class

Pacote:
@azure/container-registry

A classe cliente usada para interagir com o serviço registro de contêiner.

Construtores

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Cria uma instância de um ContainerRegistryClient para interagir com um Registro de Contêiner do Azure que tem acesso de pull anônimo habilitado. Somente as operações que dão suporte ao acesso anônimo estão habilitadas. Outros métodos de serviço gerarão erros.

Uso de exemplo:

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

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

Cria uma instância de um ContainerRegistryClient.

Uso de exemplo:

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

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

Propriedades

endpoint

O ponto de extremidade do Registro de Contêiner do Azure.

Métodos

deleteRepository(string, DeleteRepositoryOptions)

Exclui o repositório identificado pelo nome fornecido e todos os artefatos associados.
getArtifact(string, string)

Retorna uma instância do RegistryArtifact para chamar métodos de serviço relacionados ao artefato especificado por repositoryName e tagOrDigest.
getRepository(string)

Retorna uma instância de containerRepository para chamar métodos de serviço relacionados ao repositório especificado por repositoryName.
listRepositoryNames(ListRepositoriesOptions)

Retorna um iterador iterável assíncrono para listar nomes de repositórios neste registro.

Uso de exemplo:

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

Exemplo usando iter.next():

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

Exemplo usando 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();
}

Detalhes do construtor

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Cria uma instância de um ContainerRegistryClient para interagir com um Registro de Contêiner do Azure que tem acesso de pull anônimo habilitado. Somente as operações que dão suporte ao acesso anônimo estão habilitadas. Outros métodos de serviço gerarão erros.

Uso de exemplo:

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

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

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

Parâmetros

endpoint

string

o ponto de extremidade de URL do registro de contêiner

options
ContainerRegistryClientOptions

configuração opcional usada para enviar solicitações para o serviço

ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Cria uma instância de um ContainerRegistryClient.

Uso de exemplo:

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

o ponto de extremidade de URL do registro de contêiner

credential
TokenCredential

usado para autenticar solicitações no serviço

options
ContainerRegistryClientOptions

configuração opcional usada para enviar solicitações para o serviço

Detalhes da propriedade

endpoint

O ponto de extremidade do Registro de Contêiner do Azure.

endpoint: string

Valor da propriedade

string

Detalhes do método

deleteRepository(string, DeleteRepositoryOptions)

Exclui o repositório identificado pelo nome fornecido e todos os artefatos associados.

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

Parâmetros

repositoryName

string

o nome do repositório a ser excluído

options
DeleteRepositoryOptions

configuração opcional para a operação

Retornos

Promise<void>

getArtifact(string, string)

Retorna uma instância do RegistryArtifact para chamar métodos de serviço relacionados ao artefato especificado por repositoryName e tagOrDigest.

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

Parâmetros

repositoryName

string

o nome do repositório

tagOrDigest

string

marca ou resumo do artefato a ser recuperado

Retornos

RegistryArtifact

getRepository(string)

Retorna uma instância de containerRepository para chamar métodos de serviço relacionados ao repositório especificado por repositoryName.

function getRepository(repositoryName: string): ContainerRepository

Parâmetros

repositoryName

string

o nome do repositório

Retornos

ContainerRepository

listRepositoryNames(ListRepositoriesOptions)

Retorna um iterador iterável assíncrono para listar nomes de repositórios neste registro.

Uso de exemplo:

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

Exemplo usando iter.next():

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

Exemplo usando 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

Retornos

PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>