Freigeben über

RegistryArtifact interface

Paket:
@azure/container-registry

Artifact ist der allgemeine Begriff für Elemente, die in einer Containerregistrierung gespeichert sind, und kann Docker-Images oder andere OCI-Artefakttypen (Open Container Initiative) enthalten.

Die RegistryArtifact Schnittstelle ist ein Helfer, der Informationen und Vorgänge zu einem Image oder Artefakt in einer Containerregistrierung gruppiert.

Eigenschaften

fullyQualifiedReference

vollqualifizierter Verweis auf das Artefakt.
registryEndpoint

Der Azure-Containerregistrierungsendpunkt.
repositoryName

Repositoryname.

Methoden

delete(DeleteArtifactOptions)

Löscht dieses Registrierungsartefakt, indem es sein Manifest löscht.
deleteTag(string, DeleteTagOptions)

Löscht ein Tag. Dadurch wird das Tag aus dem Artefakt und seinem Manifest entfernt.
getManifestProperties(GetManifestPropertiesOptions)

Ruft die Eigenschaften des Manifests ab, das dieses Artefakt eindeutig identifiziert.
getTagProperties(string, GetTagPropertiesOptions)

Ruft die Eigenschaften des angegebenen Tags ab.
listTagProperties(ListTagPropertiesOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um die Tags auflisten, die dieses Artefakt und die Eigenschaften der einzelnen Elemente eindeutig identifizieren.

Beispiel mit for-await-of Syntax:

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

Beispiel für die Verwendung von iter.next():

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

Beispiel für die Verwendung von 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)

Aktualisiert die Eigenschaften des Artefaktmanifests.

Beispielverwendung:

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)

Aktualisiert die Eigenschaften eines bestimmten Tags.

Beispielverwendung:

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

Details zur Eigenschaft

fullyQualifiedReference

vollqualifizierter Verweis auf das Artefakt.

fullyQualifiedReference: string

Eigenschaftswert

string

registryEndpoint

Der Azure-Containerregistrierungsendpunkt.

registryEndpoint: string

Eigenschaftswert

string

repositoryName

Repositoryname.

repositoryName: string

Eigenschaftswert

string

Details zur Methode

delete(DeleteArtifactOptions)

Löscht dieses Registrierungsartefakt, indem es sein Manifest löscht.

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

Parameter

options
DeleteArtifactOptions

Gibt zurück

Promise<void>

deleteTag(string, DeleteTagOptions)

Löscht ein Tag. Dadurch wird das Tag aus dem Artefakt und seinem Manifest entfernt.

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

Parameter

tag

string

der Name des zu löschenden Tags.

options
DeleteTagOptions

Gibt zurück

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

Ruft die Eigenschaften des Manifests ab, das dieses Artefakt eindeutig identifiziert.

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

Parameter

options
GetManifestPropertiesOptions

Gibt zurück

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

Ruft die Eigenschaften des angegebenen Tags ab.

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

Parameter

tag

string

das Tag zum Abrufen von Eigenschaften.

options
GetTagPropertiesOptions

Gibt zurück

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um die Tags auflisten, die dieses Artefakt und die Eigenschaften der einzelnen Elemente eindeutig identifizieren.

Beispiel mit for-await-of Syntax:

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

Beispiel für die Verwendung von iter.next():

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

Beispiel für die Verwendung von 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

Gibt zurück

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

Aktualisiert die Eigenschaften des Artefaktmanifests.

Beispielverwendung:

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

Gibt zurück

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

Aktualisiert die Eigenschaften eines bestimmten Tags.

Beispielverwendung:

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

Name des Tags zum Aktualisieren von Eigenschaften für

options
UpdateTagPropertiesOptions

Gibt zurück

Promise<ArtifactTagProperties>