Dela via

ContainerRepository interface

  • Referens
Paket:
@azure/container-registry

A repository i ett containerregister är en logisk gruppering av avbildningar eller artefakter som delar samma namn. Olika versioner av ett hello-world program kan till exempel ha taggar v1 och v2och grupperas efter lagringsplatsen hello-world.

ContainerRepository-gränssnittet är en hjälp som grupperar information och åtgärder om en lagringsplats i det här containerregistret.

Egenskaper

name

Namn på lagringsplats.
registryEndpoint

Den Azure Container Registry slutpunkten.

Metoder

delete(DeleteRepositoryOptions)

Tar bort den här lagringsplatsen och alla artefakter som ingår i dess logiska grupp.
getArtifact(string)

Returnerar en hjälpinstans av RegistryArtifact för den angivna taggen eller sammandraget.
getProperties(GetRepositoryPropertiesOptions)

Hämtar egenskaperna för den här lagringsplatsen.
listManifestProperties(ListManifestPropertiesOptions)

Returnerar en itererbar iterator som kan asynkroniseras för att visa manifestegenskaper. Detta är användbart för att fastställa samlingen av artefakter som är associerade med den här lagringsplatsen, eftersom varje artefakt identifieras unikt av dess manifest.

Exempel med syntax for-await-of :

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
for await (const manifest of repository.listManifestProperties()) {
  console.log("manifest: ", manifest);
}

Exempel med iter.next():

const iter = repository.listManifestProperties();
let item = await iter.next();
while (!item.done) {
  console.log("manifest properties: ", item.value);
  item = await iter.next();
}

Exempel med byPage():

const pages = repository.listManifestProperties().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const manifestProperties of page.value) {
     console.log(`  manifest properties: ${manifestProperties}`);
   }
 }
 page = await pages.next();
}
updateProperties(UpdateRepositoryPropertiesOptions)

Uppdateringar egenskaperna för den här lagringsplatsen.

Exempel på användning:

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
const updated = await repository.updateProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

Egenskapsinformation

name

Namn på lagringsplats.

name: string

Egenskapsvärde

string

registryEndpoint

Den Azure Container Registry slutpunkten.

registryEndpoint: string

Egenskapsvärde

string

Metodinformation

delete(DeleteRepositoryOptions)

Tar bort den här lagringsplatsen och alla artefakter som ingår i dess logiska grupp.

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

Parametrar

options
DeleteRepositoryOptions

valfri konfiguration för åtgärden

Returer

Promise<void>

getArtifact(string)

Returnerar en hjälpinstans av RegistryArtifact för den angivna taggen eller sammandraget.

function getArtifact(tagOrDigest: string): RegistryArtifact

Parametrar

tagOrDigest

string

taggen eller sammanfattningen av artefakten

Returer

RegistryArtifact

getProperties(GetRepositoryPropertiesOptions)

Hämtar egenskaperna för den här lagringsplatsen.

function getProperties(options?: GetRepositoryPropertiesOptions): Promise<ContainerRepositoryProperties>

Parametrar

options
GetRepositoryPropertiesOptions

Returer

Promise<ContainerRepositoryProperties>

listManifestProperties(ListManifestPropertiesOptions)

Returnerar en itererbar iterator som kan asynkroniseras för att visa manifestegenskaper. Detta är användbart för att fastställa samlingen av artefakter som är associerade med den här lagringsplatsen, eftersom varje artefakt identifieras unikt av dess manifest.

Exempel med syntax for-await-of :

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
for await (const manifest of repository.listManifestProperties()) {
  console.log("manifest: ", manifest);
}

Exempel med iter.next():

const iter = repository.listManifestProperties();
let item = await iter.next();
while (!item.done) {
  console.log("manifest properties: ", item.value);
  item = await iter.next();
}

Exempel med byPage():

const pages = repository.listManifestProperties().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const manifestProperties of page.value) {
     console.log(`  manifest properties: ${manifestProperties}`);
   }
 }
 page = await pages.next();
}

function listManifestProperties(options?: ListManifestPropertiesOptions): PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

Parametrar

options
ListManifestPropertiesOptions

Returer

PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

updateProperties(UpdateRepositoryPropertiesOptions)

Uppdateringar egenskaperna för den här lagringsplatsen.

Exempel på användning:

const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
const updated = await repository.updateProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false
});

function updateProperties(options: UpdateRepositoryPropertiesOptions): Promise<ContainerRepositoryProperties>

Parametrar

options
UpdateRepositoryPropertiesOptions

Returer

Promise<ContainerRepositoryProperties>