Freigeben über

ContainerRepository interface

Paket:
@azure/container-registry

Ein repository in einer Containerregistrierung ist eine logische Gruppierung von Bildern oder Artefakten, die denselben Namen aufweisen. Beispielsweise können unterschiedliche Versionen einer hello-world Anwendung Tags v1 und v2enthalten und nach dem Repository hello-worldgruppiert werden.

Die ContainerRepository Schnittstelle ist ein Helfer, der Informationen und Vorgänge zu einem Repository in dieser Containerregistrierung gruppiert.

Eigenschaften

name

Repositoryname.
registryEndpoint

Der Azure-Containerregistrierungsendpunkt.

Methoden

delete(DeleteRepositoryOptions)

Löscht dieses Repository und alle Artefakte, die Teil seiner logischen Gruppe sind.
getArtifact(string)

Gibt eine Hilfsinstanz von RegistryArtifact- für das angegebene Tag oder digest zurück.
getProperties(GetRepositoryPropertiesOptions)

Ruft die Eigenschaften dieses Repositorys ab.
listManifestProperties(ListManifestPropertiesOptions)

Gibt einen asynchronen iterierbaren Iterator für Listenmanifesteigenschaften zurück. Dies ist nützlich, um die Sammlung von Artefakten zu bestimmen, die diesem Repository zugeordnet sind, da jedes Artefakt durch sein Manifest eindeutig identifiziert wird.

Beispiel mit for-await-of Syntax:

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

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

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

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

Aktualisiert die Eigenschaften dieses Repositorys.

Beispielverwendung:

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

Details zur Eigenschaft

name

Repositoryname.

name: string

Eigenschaftswert

string

registryEndpoint

Der Azure-Containerregistrierungsendpunkt.

registryEndpoint: string

Eigenschaftswert

string

Details zur Methode

delete(DeleteRepositoryOptions)

Löscht dieses Repository und alle Artefakte, die Teil seiner logischen Gruppe sind.

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

Parameter

options
DeleteRepositoryOptions

optionale Konfiguration für den Vorgang

Gibt zurück

Promise<void>

getArtifact(string)

Gibt eine Hilfsinstanz von RegistryArtifact- für das angegebene Tag oder digest zurück.

function getArtifact(tagOrDigest: string): RegistryArtifact

Parameter

tagOrDigest

string

Tag oder Digest des Artefakts

Gibt zurück

RegistryArtifact

getProperties(GetRepositoryPropertiesOptions)

Ruft die Eigenschaften dieses Repositorys ab.

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

Parameter

options
GetRepositoryPropertiesOptions

Gibt zurück

Promise<ContainerRepositoryProperties>

listManifestProperties(ListManifestPropertiesOptions)

Gibt einen asynchronen iterierbaren Iterator für Listenmanifesteigenschaften zurück. Dies ist nützlich, um die Sammlung von Artefakten zu bestimmen, die diesem Repository zugeordnet sind, da jedes Artefakt durch sein Manifest eindeutig identifiziert wird.

Beispiel mit for-await-of Syntax:

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

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

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

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

Parameter

options
ListManifestPropertiesOptions

Gibt zurück

PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

updateProperties(UpdateRepositoryPropertiesOptions)

Aktualisiert die Eigenschaften dieses Repositorys.

Beispielverwendung:

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>

Parameter

options
UpdateRepositoryPropertiesOptions

Gibt zurück

Promise<ContainerRepositoryProperties>