Compartilhar via

ContainerRepository interface

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

Um repository em um registro de contêiner é um agrupamento lógico de imagens ou artefatos que compartilham o mesmo nome. Por exemplo, diferentes versões de um hello-world aplicativo podem ter marcas v1 e v2e ser agrupadas pelo repositório hello-world.

A interface ContainerRepository é um auxiliar que agrupa informações e operações sobre um repositório neste registro de contêiner.

Propriedades

name

Nome do repositório.
registryEndpoint

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

Métodos

delete(DeleteRepositoryOptions)

Exclui esse repositório e todos os artefatos que fazem parte de seu grupo lógico.
getArtifact(string)

Retorna uma instância auxiliar de RegistryArtifact para a marca ou resumo fornecidos.
getProperties(GetRepositoryPropertiesOptions)

Recupera as propriedades desse repositório.
listManifestProperties(ListManifestPropertiesOptions)

Retorna um iterador iterável assíncrono para listar propriedades de manifesto. Isso é útil para determinar a coleção de artefatos associados a esse repositório, pois cada artefato é identificado exclusivamente por seu manifesto.

Exemplo usando for-await-of a sintaxe:

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

Exemplo usando iter.next():

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

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

Atualizações as propriedades desse repositório.

Exemplo de uso:

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

Detalhes da propriedade

name

Nome do repositório.

name: string

Valor da propriedade

string

registryEndpoint

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

registryEndpoint: string

Valor da propriedade

string

Detalhes do método

delete(DeleteRepositoryOptions)

Exclui esse repositório e todos os artefatos que fazem parte de seu grupo lógico.

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

Parâmetros

options
DeleteRepositoryOptions

configuração opcional para a operação

Retornos

Promise<void>

getArtifact(string)

Retorna uma instância auxiliar de RegistryArtifact para a marca ou resumo fornecidos.

function getArtifact(tagOrDigest: string): RegistryArtifact

Parâmetros

tagOrDigest

string

a marca ou resumo do artefato

Retornos

RegistryArtifact

getProperties(GetRepositoryPropertiesOptions)

Recupera as propriedades desse repositório.

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

Parâmetros

options
GetRepositoryPropertiesOptions

Retornos

Promise<ContainerRepositoryProperties>

listManifestProperties(ListManifestPropertiesOptions)

Retorna um iterador iterável assíncrono para listar propriedades de manifesto. Isso é útil para determinar a coleção de artefatos associados a esse repositório, pois cada artefato é identificado exclusivamente por seu manifesto.

Exemplo usando for-await-of a sintaxe:

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

Exemplo usando iter.next():

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

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

Retornos

PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

updateProperties(UpdateRepositoryPropertiesOptions)

Atualizações as propriedades desse repositório.

Exemplo de uso:

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

Retornos

Promise<ContainerRepositoryProperties>