Sdílet prostřednictvím

ContainerRepository interface

  • Reference
Balíček:
@azure/container-registry

A repository v registru kontejneru je logické seskupení obrázků nebo artefaktů, které mají stejný název. Například různé verze hello-world aplikace můžou mít značky v1 a v2a seskupit podle úložiště hello-world.

Rozhraní ContainerRepository je pomocník, který seskupuje informace a operace týkající se úložiště v tomto registru kontejneru.

Vlastnosti

name

Název úložiště.
registryEndpoint

Koncový bod Azure Container Registry.

Metody

delete(DeleteRepositoryOptions)

Odstraní toto úložiště a všechny artefakty, které jsou součástí jeho logické skupiny.
getArtifact(string)

Vrátí pomocnou instanci RegistryArtifact pro danou značku nebo digest.
getProperties(GetRepositoryPropertiesOptions)

Načte vlastnosti tohoto úložiště.
listManifestProperties(ListManifestPropertiesOptions)

Vrátí asynchronní iterátor pro výpis vlastností manifestu. To je užitečné pro určení kolekce artefaktů přidružených k tomuto úložišti, protože každý artefakt je jedinečně identifikován svým manifestem.

Příklad použití for-await-of syntaxe:

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

Příklad použití iter.next():

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

Příklad použití 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)

Aktualizace vlastnosti tohoto úložiště.

Příklad použití:

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

Podrobnosti vlastnosti

name

Název úložiště.

name: string

Hodnota vlastnosti

string

registryEndpoint

Koncový bod Azure Container Registry.

registryEndpoint: string

Hodnota vlastnosti

string

Podrobnosti metody

delete(DeleteRepositoryOptions)

Odstraní toto úložiště a všechny artefakty, které jsou součástí jeho logické skupiny.

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

Parametry

options
DeleteRepositoryOptions

volitelná konfigurace pro operaci

Návraty

Promise<void>

getArtifact(string)

Vrátí pomocnou instanci RegistryArtifact pro danou značku nebo digest.

function getArtifact(tagOrDigest: string): RegistryArtifact

Parametry

tagOrDigest

string

značka nebo souhrn artefaktu

Návraty

RegistryArtifact

getProperties(GetRepositoryPropertiesOptions)

Načte vlastnosti tohoto úložiště.

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

Parametry

options
GetRepositoryPropertiesOptions

Návraty

Promise<ContainerRepositoryProperties>

listManifestProperties(ListManifestPropertiesOptions)

Vrátí asynchronní iterátor pro výpis vlastností manifestu. To je užitečné pro určení kolekce artefaktů přidružených k tomuto úložišti, protože každý artefakt je jedinečně identifikován svým manifestem.

Příklad použití for-await-of syntaxe:

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

Příklad použití iter.next():

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

Příklad použití 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>

Parametry

options
ListManifestPropertiesOptions

Návraty

PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

updateProperties(UpdateRepositoryPropertiesOptions)

Aktualizace vlastnosti tohoto úložiště.

Příklad použití:

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>

Parametry

options
UpdateRepositoryPropertiesOptions

Návraty

Promise<ContainerRepositoryProperties>