Compartilhar 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 artefato OCI (Open Container Initiative).

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 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 marca. Isso remove a marca do artefato e seu manifesto.
getManifestProperties(GetManifestPropertiesOptions)

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

Recupera as propriedades da marca especificada.
listTagProperties(ListTagPropertiesOptions)

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

Exemplo usando for-await-of a sintaxe:

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ções 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ções as propriedades de uma determinada marca.

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 da propriedade

fullyQualifiedReference

referência totalmente qualificada do artefato.

fullyQualifiedReference: string

Valor da propriedade

string

registryEndpoint

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

registryEndpoint: string

Valor da propriedade

string

repositoryName

Nome do repositório.

repositoryName: string

Valor da propriedade

string

Detalhes do método

delete(DeleteArtifactOptions)

Exclui esse artefato do Registro excluindo seu manifesto.

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

Parâmetros

options
DeleteArtifactOptions

Retornos

Promise<void>

deleteTag(string, DeleteTagOptions)

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

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

Parâmetros

tag

string

o nome da marca a ser excluída.

options
DeleteTagOptions

Retornos

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

Recupera as propriedades do manifesto que identificam exclusivamente esse artefato.

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

Parâmetros

options
GetManifestPropertiesOptions

Retornos

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

Recupera as propriedades da marca especificada.

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

Parâmetros

tag

string

a marca para recuperar propriedades.

options
GetTagPropertiesOptions

Retornos

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

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

Exemplo usando for-await-of a sintaxe:

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

Retornos

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

Atualizações 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

Retornos

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

Atualizações as propriedades de uma determinada marca.

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 marca na qual atualizar as propriedades

options
UpdateTagPropertiesOptions

Retornos

Promise<ArtifactTagProperties>