Dela via

RegistryArtifact interface

  • Referens
Paket:
@azure/container-registry

Artifact är den allmänna termen för objekt som lagras i ett containerregister och kan innehålla Docker-avbildningar eller andra OCI-artefakttyper (Open Container Initiative).

RegistryArtifact-gränssnittet är en hjälpkomponent som grupperar information och åtgärder om en avbildning eller artefakt i ett containerregister.

Egenskaper

fullyQualifiedReference

fullständigt kvalificerad referens för artefakten.
registryEndpoint

Den Azure Container Registry slutpunkten.
repositoryName

Namn på lagringsplats.

Metoder

delete(DeleteArtifactOptions)

Tar bort den här registerartefakten genom att ta bort dess manifest.
deleteTag(string, DeleteTagOptions)

Tar bort en tagg. Detta tar bort taggen från artefakten och dess manifest.
getManifestProperties(GetManifestPropertiesOptions)

Hämtar egenskaperna för manifestet som unikt identifierar artefakten.
getTagProperties(string, GetTagPropertiesOptions)

Hämtar egenskaperna för den angivna taggen.
listTagProperties(ListTagPropertiesOptions)

Returnerar en asynkron iterbar iterator för att visa en lista över taggar som unikt identifierar artefakten och egenskaperna för var och en.

Exempel med syntax 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);
}

Exempel med iter.next():

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

Exempel med 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)

Uppdateringar egenskaperna för artefaktens manifest.

Exempel på användning:

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)

Uppdateringar egenskaperna för en viss tagg.

Exempel på användning:

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

Egenskapsinformation

fullyQualifiedReference

fullständigt kvalificerad referens för artefakten.

fullyQualifiedReference: string

Egenskapsvärde

string

registryEndpoint

Den Azure Container Registry slutpunkten.

registryEndpoint: string

Egenskapsvärde

string

repositoryName

Namn på lagringsplats.

repositoryName: string

Egenskapsvärde

string

Metodinformation

delete(DeleteArtifactOptions)

Tar bort den här registerartefakten genom att ta bort dess manifest.

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

Parametrar

options
DeleteArtifactOptions

Returer

Promise<void>

deleteTag(string, DeleteTagOptions)

Tar bort en tagg. Detta tar bort taggen från artefakten och dess manifest.

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

Parametrar

tag

string

namnet på taggen som ska tas bort.

options
DeleteTagOptions

Returer

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

Hämtar egenskaperna för manifestet som unikt identifierar artefakten.

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

Parametrar

options
GetManifestPropertiesOptions

Returer

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

Hämtar egenskaperna för den angivna taggen.

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

Parametrar

tag

string

taggen för att hämta egenskaper.

options
GetTagPropertiesOptions

Returer

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

Returnerar en asynkron iterbar iterator för att visa en lista över taggar som unikt identifierar artefakten och egenskaperna för var och en.

Exempel med syntax 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);
}

Exempel med iter.next():

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

Exempel med 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>

Parametrar

options
ListTagPropertiesOptions

Returer

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

Uppdateringar egenskaperna för artefaktens manifest.

Exempel på användning:

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>

Parametrar

options
UpdateManifestPropertiesOptions

Returer

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

Uppdateringar egenskaperna för en viss tagg.

Exempel på användning:

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>

Parametrar

tag

string

namnet på taggen som egenskaperna ska uppdateras på

options
UpdateTagPropertiesOptions

Returer

Promise<ArtifactTagProperties>