Delen via

RegistryArtifact interface

Pakket:
@azure/container-registry

Artifact is de algemene term voor items die zijn opgeslagen in een containerregister en kan Docker-installatiekopieën of andere OCI-artefacttypen (Open Container Initiative) bevatten.

De RegistryArtifact-interface is een helper waarmee informatie en bewerkingen over een installatiekopieën of artefact in een containerregister worden gegroepeerd.

Eigenschappen

fullyQualifiedReference

volledig gekwalificeerde verwijzing van het artefact.
registryEndpoint

Het Azure Container Registry-eindpunt.
repositoryName

Naam van opslagplaats.

Methoden

delete(DeleteArtifactOptions)

Hiermee verwijdert u dit registerartefact door het bijbehorende manifest te verwijderen.
deleteTag(string, DeleteTagOptions)

Hiermee verwijdert u een tag. Hiermee verwijdert u de tag uit het artefact en het bijbehorende manifest.
getManifestProperties(GetManifestPropertiesOptions)

Haalt de eigenschappen van het manifest op waarmee dit artefact uniek wordt geïdentificeerd.
getTagProperties(string, GetTagPropertiesOptions)

Haalt de eigenschappen van de opgegeven tag op.
listTagProperties(ListTagPropertiesOptions)

Retourneert een asynchrone iterator om de tags weer te geven die dit artefact en de eigenschappen van elk artefact uniek identificeren.

Voorbeeld van for-await-of syntaxis:

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

Voorbeeld van iter.next():

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

Voorbeeld van 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)

Hiermee worden de eigenschappen van het manifest van het artefact bijgewerkt.

Voorbeeldgebruik:

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)

Hiermee worden de eigenschappen van een bepaalde tag bijgewerkt.

Voorbeeldgebruik:

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

Eigenschapdetails

fullyQualifiedReference

volledig gekwalificeerde verwijzing van het artefact.

fullyQualifiedReference: string

Waarde van eigenschap

string

registryEndpoint

Het Azure Container Registry-eindpunt.

registryEndpoint: string

Waarde van eigenschap

string

repositoryName

Naam van opslagplaats.

repositoryName: string

Waarde van eigenschap

string

Methodedetails

delete(DeleteArtifactOptions)

Hiermee verwijdert u dit registerartefact door het bijbehorende manifest te verwijderen.

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

Parameters

options
DeleteArtifactOptions

Retouren

Promise<void>

deleteTag(string, DeleteTagOptions)

Hiermee verwijdert u een tag. Hiermee verwijdert u de tag uit het artefact en het bijbehorende manifest.

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

Parameters

tag

string

de naam van de tag die u wilt verwijderen.

options
DeleteTagOptions

Retouren

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

Haalt de eigenschappen van het manifest op waarmee dit artefact uniek wordt geïdentificeerd.

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

Parameters

options
GetManifestPropertiesOptions

Retouren

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

Haalt de eigenschappen van de opgegeven tag op.

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

Parameters

tag

string

de tag om eigenschappen op te halen.

options
GetTagPropertiesOptions

Retouren

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

Retourneert een asynchrone iterator om de tags weer te geven die dit artefact en de eigenschappen van elk artefact uniek identificeren.

Voorbeeld van for-await-of syntaxis:

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

Voorbeeld van iter.next():

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

Voorbeeld van 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>

Parameters

options
ListTagPropertiesOptions

Retouren

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

Hiermee worden de eigenschappen van het manifest van het artefact bijgewerkt.

Voorbeeldgebruik:

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>

Parameters

options
UpdateManifestPropertiesOptions

Retouren

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

Hiermee worden de eigenschappen van een bepaalde tag bijgewerkt.

Voorbeeldgebruik:

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>

Parameters

tag

string

naam van de tag voor het bijwerken van eigenschappen op

options
UpdateTagPropertiesOptions

Retouren

Promise<ArtifactTagProperties>