Partilhar via

ContainerRegistryClient class

  • Referência
Pacote:
@azure/container-registry

A classe de 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 tenha acesso pull anônimo habilitado. Apenas as operações que suportam acesso anónimo estão ativadas. Outros métodos de serviço lançarão erros.

Exemplo de uso:

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.

Exemplo de uso:

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 de 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.

Exemplo de uso:

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 tenha acesso pull anônimo habilitado. Apenas as operações que suportam acesso anónimo estão ativadas. Outros métodos de serviço lançarão erros.

Exemplo 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

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

options
ContainerRegistryClientOptions

Configuração opcional usada para enviar solicitações ao serviço

ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Cria uma instância de um ContainerRegistryClient.

Exemplo 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

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

credential
TokenCredential

usado para autenticar solicitações para o serviço

options
ContainerRegistryClientOptions

Configuração opcional usada para enviar solicitações ao serviço

Detalhes de Propriedade

endpoint

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

endpoint: string

Valor de Propriedade

string

Detalhes de 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

Devoluções

Promise<void>

getArtifact(string, string)

Retorna uma instância de 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

tag ou resumo do artefato a ser recuperado

Devoluções

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

Devoluções

ContainerRepository

listRepositoryNames(ListRepositoriesOptions)

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

Exemplo de uso:

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

Devoluções

PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>