Udostępnij za pośrednictwem

ContainerRepository interface

  • Odwołanie
Pakiet:
@azure/container-registry

Element repository w rejestrze kontenerów to logiczne grupowanie obrazów lub artefaktów, które mają taką samą nazwę. Na przykład różne wersje hello-world aplikacji mogą zawierać tagi v1 i v2grupowane według repozytorium hello-world.

Interfejs ContainerRepository to pomocnik, który grupuje informacje i operacje dotyczące repozytorium w tym rejestrze kontenerów.

Właściwości

name

Nazwa repozytorium.
registryEndpoint

Punkt końcowy Azure Container Registry.

Metody

delete(DeleteRepositoryOptions)

Usuwa to repozytorium i wszystkie artefakty będące częścią jej grupy logicznej.
getArtifact(string)

Zwraca wystąpienie pomocnika RegistryArtifact dla danego tagu lub skrótu.
getProperties(GetRepositoryPropertiesOptions)

Pobiera właściwości tego repozytorium.
listManifestProperties(ListManifestPropertiesOptions)

Zwraca iterator asynchroniczny do wyświetlania listy właściwości manifestu. Jest to przydatne do określania kolekcji artefaktów skojarzonych z tym repozytorium, ponieważ każdy artefakt jest jednoznacznie identyfikowany przez jego manifest.

Przykład użycia for-await-of składni:

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

Przykład przy użyciu polecenia iter.next():

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

Przykład przy użyciu polecenia 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)

Aktualizacje właściwości tego repozytorium.

Przykład użycia: 

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

Szczegóły właściwości

name

Nazwa repozytorium.

name: string

Wartość właściwości

string

registryEndpoint

Punkt końcowy Azure Container Registry.

registryEndpoint: string

Wartość właściwości

string

Szczegóły metody

delete(DeleteRepositoryOptions)

Usuwa to repozytorium i wszystkie artefakty będące częścią jej grupy logicznej.

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

Parametry

options
DeleteRepositoryOptions

opcjonalna konfiguracja operacji

Zwraca

Promise<void>

getArtifact(string)

Zwraca wystąpienie pomocnika RegistryArtifact dla danego tagu lub skrótu.

function getArtifact(tagOrDigest: string): RegistryArtifact

Parametry

tagOrDigest

string

tag lub skrót artefaktu

Zwraca

RegistryArtifact

getProperties(GetRepositoryPropertiesOptions)

Pobiera właściwości tego repozytorium.

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

Parametry

options
GetRepositoryPropertiesOptions

Zwraca

Promise<ContainerRepositoryProperties>

listManifestProperties(ListManifestPropertiesOptions)

Zwraca iterator asynchroniczny do wyświetlania listy właściwości manifestu. Jest to przydatne do określania kolekcji artefaktów skojarzonych z tym repozytorium, ponieważ każdy artefakt jest jednoznacznie identyfikowany przez jego manifest.

Przykład użycia for-await-of składni:

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

Przykład przy użyciu polecenia iter.next():

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

Przykład przy użyciu polecenia 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

Zwraca

PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

updateProperties(UpdateRepositoryPropertiesOptions)

Aktualizacje właściwości tego repozytorium.

Przykład użycia: 

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

Zwraca

Promise<ContainerRepositoryProperties>