Partilhar via

RegistryArtifact interface

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

Artifact é o termo geral para itens armazenados em um registro de contêiner e pode incluir imagens do Docker ou outros tipos de artefatos Open Container Initiative (OCI).

A interface RegistryArtifact é um auxiliar que agrupa informações e operações sobre uma imagem ou artefato em um registro de contêiner.

Propriedades

fullyQualifiedReference

referência totalmente qualificada do artefato.
registryEndpoint

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

Nome do repositório.

Métodos

delete(DeleteArtifactOptions)

Exclui esse artefato do Registro excluindo seu manifesto.
deleteTag(string, DeleteTagOptions)

Exclui uma tag. Isso remove a tag do artefato e seu manifesto.
getManifestProperties(GetManifestPropertiesOptions)

Recupera as propriedades do manifesto que identifica exclusivamente esse artefato.
getTagProperties(string, GetTagPropertiesOptions)

Recupera as propriedades da tag especificada.
listTagProperties(ListTagPropertiesOptions)

Retorna um iterador iterável assíncrono para listar as tags que identificam exclusivamente esse artefato e as propriedades de cada um.

Exemplo usando sintaxe for-await-of:

const client = new ContainerRegistryClient(url, credentials);
const repository = client.getRepository(repositoryName);
const artifact = repository.getArtifact(digest)
for await (const tag of artifact.listTagProperties()) {
  console.log("tag: ", tag);
}

Exemplo usando iter.next():

const iter = artifact.listTagProperties();
let item = await iter.next();
while (!item.done) {
  console.log("tag properties: ", item.value);
  item = await iter.next();
}

Exemplo usando byPage():

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

Atualiza as propriedades do manifesto do artefato.

Exemplo de uso:

const client = new ContainerRegistryClient(url, credential);
const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
const updated = await artifact.updateManifestProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});
updateTagProperties(string, UpdateTagPropertiesOptions)

Atualiza as propriedades de uma determinada tag.

Exemplo de uso:

const client = new ContainerRegistryClient(url, credential);
const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
const updated = await artifact.updateTagProperties(tag, {
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

Detalhes de Propriedade

fullyQualifiedReference

referência totalmente qualificada do artefato.

fullyQualifiedReference: string

Valor de Propriedade

string

registryEndpoint

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

registryEndpoint: string

Valor de Propriedade

string

repositoryName

Nome do repositório.

repositoryName: string

Valor de Propriedade

string

Detalhes de Método

delete(DeleteArtifactOptions)

Exclui esse artefato do Registro excluindo seu manifesto.

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

Parâmetros

options
DeleteArtifactOptions

Devoluções

Promise<void>

deleteTag(string, DeleteTagOptions)

Exclui uma tag. Isso remove a tag do artefato e seu manifesto.

function deleteTag(tag: string, options?: DeleteTagOptions): Promise<void>

Parâmetros

tag

string

O nome da tag a ser excluída.

options
DeleteTagOptions

Devoluções

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

Recupera as propriedades do manifesto que identifica exclusivamente esse artefato.

function getManifestProperties(options?: GetManifestPropertiesOptions): Promise<ArtifactManifestProperties>

Parâmetros

options
GetManifestPropertiesOptions

Devoluções

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

Recupera as propriedades da tag especificada.

function getTagProperties(tag: string, options?: GetTagPropertiesOptions): Promise<ArtifactTagProperties>

Parâmetros

tag

string

a tag para recuperar propriedades.

options
GetTagPropertiesOptions

Devoluções

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

Retorna um iterador iterável assíncrono para listar as tags que identificam exclusivamente esse artefato e as propriedades de cada um.

Exemplo usando sintaxe for-await-of:

const client = new ContainerRegistryClient(url, credentials);
const repository = client.getRepository(repositoryName);
const artifact = repository.getArtifact(digest)
for await (const tag of artifact.listTagProperties()) {
  console.log("tag: ", tag);
}

Exemplo usando iter.next():

const iter = artifact.listTagProperties();
let item = await iter.next();
while (!item.done) {
  console.log("tag properties: ", item.value);
  item = await iter.next();
}

Exemplo usando byPage():

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

function listTagProperties(options?: ListTagPropertiesOptions): PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

Parâmetros

options
ListTagPropertiesOptions

Devoluções

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

Atualiza as propriedades do manifesto do artefato.

Exemplo de uso:

const client = new ContainerRegistryClient(url, credential);
const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
const updated = await artifact.updateManifestProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

function updateManifestProperties(options: UpdateManifestPropertiesOptions): Promise<ArtifactManifestProperties>

Parâmetros

options
UpdateManifestPropertiesOptions

Devoluções

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

Atualiza as propriedades de uma determinada tag.

Exemplo de uso:

const client = new ContainerRegistryClient(url, credential);
const artifact = client.getArtifact(repositoryName, artifactTagOrDigest)
const updated = await artifact.updateTagProperties(tag, {
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

function updateTagProperties(tag: string, options: UpdateTagPropertiesOptions): Promise<ArtifactTagProperties>

Parâmetros

tag

string

nome da tag para atualizar as propriedades em

options
UpdateTagPropertiesOptions

Devoluções

Promise<ArtifactTagProperties>