Поделиться через

ContainerRepository interface

  • Ссылка
Пакет:
@azure/container-registry

repository в реестре контейнеров — это логическая группировка изображений или артефактов, которые имеют то же имя. Например, разные версии приложения hello-world могут иметь теги v1 и v2, а также группироваться по репозиторию hello-world.

Интерфейс ContainerRepository — это вспомогательный интерфейс, который группируется сведения и операции с репозиторием в этом реестре контейнеров.

Свойства

name

Имя репозитория.
registryEndpoint

Конечная точка реестра контейнеров Azure.

Методы

delete(DeleteRepositoryOptions)

Удаляет этот репозиторий и все артефакты, которые входят в логическую группу.
getArtifact(string)

Возвращает вспомогательный экземпляр RegistryArtifact для заданного тега или дайджеста.
getProperties(GetRepositoryPropertiesOptions)

Извлекает свойства этого репозитория.
listManifestProperties(ListManifestPropertiesOptions)

Возвращает асинхронный итератор для перечисления свойств манифеста. Это полезно для определения коллекции артефактов, связанных с этим репозиторием, так как каждый артефакт однозначно определяется его манифестом.

Пример использования синтаксиса 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);
}

Пример использования iter.next():

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

Пример использования 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)

Обновляет свойства этого репозитория.

Пример использования:

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

Сведения о свойстве

name

Имя репозитория.

name: string

Значение свойства

string

registryEndpoint

Конечная точка реестра контейнеров Azure.

registryEndpoint: string

Значение свойства

string

Сведения о методе

delete(DeleteRepositoryOptions)

Удаляет этот репозиторий и все артефакты, которые входят в логическую группу.

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

Параметры

options
DeleteRepositoryOptions

необязательная конфигурация для операции

Возвращаемое значение

Promise<void>

getArtifact(string)

Возвращает вспомогательный экземпляр RegistryArtifact для заданного тега или дайджеста.

function getArtifact(tagOrDigest: string): RegistryArtifact

Параметры

tagOrDigest

string

тег или дайджест артефакта

Возвращаемое значение

RegistryArtifact

getProperties(GetRepositoryPropertiesOptions)

Извлекает свойства этого репозитория.

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

Параметры

options
GetRepositoryPropertiesOptions

Возвращаемое значение

Promise<ContainerRepositoryProperties>

listManifestProperties(ListManifestPropertiesOptions)

Возвращает асинхронный итератор для перечисления свойств манифеста. Это полезно для определения коллекции артефактов, связанных с этим репозиторием, так как каждый артефакт однозначно определяется его манифестом.

Пример использования синтаксиса 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);
}

Пример использования iter.next():

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

Пример использования 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>

Параметры

options
ListManifestPropertiesOptions

Возвращаемое значение

PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>

updateProperties(UpdateRepositoryPropertiesOptions)

Обновляет свойства этого репозитория.

Пример использования:

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>

Параметры

options
UpdateRepositoryPropertiesOptions

Возвращаемое значение

Promise<ContainerRepositoryProperties>