Aracılığıyla paylaş

RegistryArtifact interface

Paket:
@azure/container-registry

Artifact, kapsayıcı kayıt defterinde depolanan öğeler için genel bir terimdir ve Docker görüntülerini veya diğer Open Container Initiative (OCI) yapıt türlerini içerebilir.

RegistryArtifact arabirimi, kapsayıcı kayıt defterindeki bir görüntü veya yapıt hakkındaki bilgileri ve işlemleri gruplandıran bir yardımcıdır.

Özellikler

fullyQualifiedReference

yapıtın tam başvurusu.
registryEndpoint

Azure Container Registry uç noktası.
repositoryName

Depo adı.

Yöntemler

delete(DeleteArtifactOptions)

Bildirimini silerek bu kayıt defteri yapıtını siler.
deleteTag(string, DeleteTagOptions)

Bir etiketi siler. Bu, etiketi yapıttan ve bildiriminden kaldırır.
getManifestProperties(GetManifestPropertiesOptions)

Bu yapıtı benzersiz olarak tanımlayan bildirimin özelliklerini alır.
getTagProperties(string, GetTagPropertiesOptions)

Belirtilen etiketin özelliklerini alır.
listTagProperties(ListTagPropertiesOptions)

Bu yapıtı benzersiz olarak tanımlayan etiketleri ve her birinin özelliklerini listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

for-await-of söz dizimi kullanan örnek:

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

iter.next()kullanan örnek:

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

byPage()kullanan örnek:

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)

Yapıtın bildiriminin özelliklerini güncelleştirir.

Örnek kullanım:

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)

Belirli bir etiketin özelliklerini güncelleştirir.

Örnek kullanım:

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

Özellik Ayrıntıları

fullyQualifiedReference

yapıtın tam başvurusu.

fullyQualifiedReference: string

Özellik Değeri

string

registryEndpoint

Azure Container Registry uç noktası.

registryEndpoint: string

Özellik Değeri

string

repositoryName

Depo adı.

repositoryName: string

Özellik Değeri

string

Yöntem Ayrıntıları

delete(DeleteArtifactOptions)

Bildirimini silerek bu kayıt defteri yapıtını siler.

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

Parametreler

options
DeleteArtifactOptions

Döndürülenler

Promise<void>

deleteTag(string, DeleteTagOptions)

Bir etiketi siler. Bu, etiketi yapıttan ve bildiriminden kaldırır.

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

Parametreler

tag

string

silinecek etiketin adı.

options
DeleteTagOptions

Döndürülenler

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

Bu yapıtı benzersiz olarak tanımlayan bildirimin özelliklerini alır.

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

Parametreler

options
GetManifestPropertiesOptions

Döndürülenler

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

Belirtilen etiketin özelliklerini alır.

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

Parametreler

tag

string

özellikleri almak için etiket.

options
GetTagPropertiesOptions

Döndürülenler

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

Bu yapıtı benzersiz olarak tanımlayan etiketleri ve her birinin özelliklerini listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

for-await-of söz dizimi kullanan örnek:

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

iter.next()kullanan örnek:

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

byPage()kullanan örnek:

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>

Parametreler

options
ListTagPropertiesOptions

Döndürülenler

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

Yapıtın bildiriminin özelliklerini güncelleştirir.

Örnek kullanım:

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>

Parametreler

options
UpdateManifestPropertiesOptions

Döndürülenler

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

Belirli bir etiketin özelliklerini güncelleştirir.

Örnek kullanım:

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>

Parametreler

tag

string

özellikleri güncelleştirilecek etiketin adı

options
UpdateTagPropertiesOptions

Döndürülenler

Promise<ArtifactTagProperties>