Sdílet prostřednictvím

RegistryArtifact interface

  • Reference
Balíček:
@azure/container-registry

Artifact je obecný termín pro položky uložené v registru kontejneru a může zahrnovat image Dockeru nebo jiné typy artefaktů OCI (Open Container Initiative).

Rozhraní RegistryArtifact je pomocná rutina, která seskupuje informace a operace týkající se image nebo artefaktu v registru kontejneru.

Vlastnosti

fullyQualifiedReference

plně kvalifikovaný odkaz na artefakt.
registryEndpoint

Koncový bod Azure Container Registry.
repositoryName

Název úložiště.

Metody

delete(DeleteArtifactOptions)

Odstraní tento artefakt registru odstraněním jeho manifestu.
deleteTag(string, DeleteTagOptions)

Odstraní značku. Tím se značka odebere z artefaktu a jeho manifestu.
getManifestProperties(GetManifestPropertiesOptions)

Načte vlastnosti manifestu, který jednoznačně identifikuje tento artefakt.
getTagProperties(string, GetTagPropertiesOptions)

Načte vlastnosti zadané značky.
listTagProperties(ListTagPropertiesOptions)

Vrátí asynchronní iterátor pro výpis značek, které jednoznačně identifikují tento artefakt a vlastnosti každého z nich.

Příklad s využitím for-await-of syntaxe:

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

Příklad použití iter.next():

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

Příklad použití 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)

Aktualizace vlastnosti manifestu artefaktu.

Příklad použití:

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)

Aktualizace vlastnosti dané značky.

Příklad použití:

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

Podrobnosti vlastnosti

fullyQualifiedReference

plně kvalifikovaný odkaz na artefakt.

fullyQualifiedReference: string

Hodnota vlastnosti

string

registryEndpoint

Koncový bod Azure Container Registry.

registryEndpoint: string

Hodnota vlastnosti

string

repositoryName

Název úložiště.

repositoryName: string

Hodnota vlastnosti

string

Podrobnosti metody

delete(DeleteArtifactOptions)

Odstraní tento artefakt registru odstraněním jeho manifestu.

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

Parametry

options
DeleteArtifactOptions

Návraty

Promise<void>

deleteTag(string, DeleteTagOptions)

Odstraní značku. Tím se značka odebere z artefaktu a jeho manifestu.

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

Parametry

tag

string

název značky, která se má odstranit.

options
DeleteTagOptions

Návraty

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

Načte vlastnosti manifestu, který jednoznačně identifikuje tento artefakt.

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

Parametry

options
GetManifestPropertiesOptions

Návraty

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

Načte vlastnosti zadané značky.

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

Parametry

tag

string

značku , která načte vlastnosti.

options
GetTagPropertiesOptions

Návraty

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

Vrátí asynchronní iterátor pro výpis značek, které jednoznačně identifikují tento artefakt a vlastnosti každého z nich.

Příklad s využitím for-await-of syntaxe:

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

Příklad použití iter.next():

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

Příklad použití 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>

Parametry

options
ListTagPropertiesOptions

Návraty

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

Aktualizace vlastnosti manifestu artefaktu.

Příklad použití:

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>

Parametry

options
UpdateManifestPropertiesOptions

Návraty

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

Aktualizace vlastnosti dané značky.

Příklad použití:

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>

Parametry

tag

string

název značky, u které se mají aktualizovat vlastnosti

options
UpdateTagPropertiesOptions

Návraty

Promise<ArtifactTagProperties>