Bagikan melalui

RegistryArtifact interface

  • Referensi
Paket:
@azure/container-registry

Artifact adalah istilah umum untuk item yang disimpan dalam registri kontainer, dan dapat menyertakan gambar Docker atau jenis artefak Open Container Initiative (OCI) lainnya.

Antarmuka RegistryArtifact adalah pembantu yang mengelompokkan informasi dan operasi tentang gambar atau artefak dalam registri kontainer.

Properti

fullyQualifiedReference

referensi artefak yang sepenuhnya memenuhi syarat.
registryEndpoint

Titik akhir Azure Container Registry.
repositoryName

Nama repositori.

Metode

delete(DeleteArtifactOptions)

Menghapus artefak registri ini dengan menghapus manifesnya.
deleteTag(string, DeleteTagOptions)

Menghapus tag. Ini menghapus tag dari artefak dan manifesnya.
getManifestProperties(GetManifestPropertiesOptions)

Mengambil properti manifes yang secara unik mengidentifikasi artefak ini.
getTagProperties(string, GetTagPropertiesOptions)

Mengambil properti dari tag yang ditentukan.
listTagProperties(ListTagPropertiesOptions)

Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan tag yang secara unik mengidentifikasi artefak ini dan properti masing-masing.

Contoh menggunakan for-await-of sintaks:

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);
}

Contoh menggunakan iter.next():

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

Contoh menggunakan 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)

Updates sifat manifes artefak.

Contoh penggunaan:

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)

Updates properti tag tertentu.

Contoh penggunaan:

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
});

Detail Properti

fullyQualifiedReference

referensi artefak yang sepenuhnya memenuhi syarat.

fullyQualifiedReference: string

Nilai Properti

string

registryEndpoint

Titik akhir Azure Container Registry.

registryEndpoint: string

Nilai Properti

string

repositoryName

Nama repositori.

repositoryName: string

Nilai Properti

string

Detail Metode

delete(DeleteArtifactOptions)

Menghapus artefak registri ini dengan menghapus manifesnya.

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

Parameter

options
DeleteArtifactOptions

Mengembalikan

Promise<void>

deleteTag(string, DeleteTagOptions)

Menghapus tag. Ini menghapus tag dari artefak dan manifesnya.

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

Parameter

tag

string

nama tag yang akan dihapus.

options
DeleteTagOptions

Mengembalikan

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

Mengambil properti manifes yang secara unik mengidentifikasi artefak ini.

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

Parameter

options
GetManifestPropertiesOptions

Mengembalikan

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

Mengambil properti dari tag yang ditentukan.

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

Parameter

tag

string

tag untuk mengambil properti.

options
GetTagPropertiesOptions

Mengembalikan

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan tag yang secara unik mengidentifikasi artefak ini dan properti masing-masing.

Contoh menggunakan for-await-of sintaks:

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);
}

Contoh menggunakan iter.next():

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

Contoh menggunakan 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>

Parameter

options
ListTagPropertiesOptions

Mengembalikan

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

Updates sifat manifes artefak.

Contoh penggunaan:

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>

Parameter

options
UpdateManifestPropertiesOptions

Mengembalikan

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

Updates properti tag tertentu.

Contoh penggunaan:

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>

Parameter

tag

string

nama tag untuk memperbarui properti pada

options
UpdateTagPropertiesOptions

Mengembalikan

Promise<ArtifactTagProperties>