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

ContainerRegistryClient class

Пакет:
@azure/container-registry

Клиентский класс, используемый для взаимодействия со службой реестра контейнеров.

Конструкторы

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Создает экземпляр ContainerRegistryClient для взаимодействия с реестром контейнеров Azure с включенным анонимным доступом к запросу. Включены только операции, поддерживающие анонимный доступ. Другие методы службы вызывают ошибки.

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

import { ContainerRegistryClient } from "@azure/container-registry";

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
);
ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Создает экземпляр ContainerRegistryClient.

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

import { ContainerRegistryClient } from "@azure/container-registry";
import { DefaultAzureCredential} from "@azure/identity";

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
   new DefaultAzureCredential()
);

Свойства

endpoint

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

Методы

deleteRepository(string, DeleteRepositoryOptions)

Удаляет репозиторий, определенный заданным именем и всеми связанными артефактами.
getArtifact(string, string)

Возвращает экземпляр RegistryArtifact для вызова методов службы, связанных с артефактом, указанным repositoryName и tagOrDigest.
getRepository(string)

Возвращает экземпляр ContainerRepository для вызова методов службы, связанных с репозиторием, указанным repositoryName.
listRepositoryNames(ListRepositoriesOptions)

Возвращает асинхронный итератор для перечисления имен репозиториев в этом реестре.

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

let client = new ContainerRegistryClient(url, credential);
for await (const repository of client.listRepositoryNames()) {
  console.log("repository name: ", repository);
}

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

let iter = client.listRepositoryNames();
let item = await iter.next();
while (!item.done) {
  console.log(`repository name: ${item.value}`);
  item = await iter.next();
}

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

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

Сведения о конструкторе

ContainerRegistryClient(string, ContainerRegistryClientOptions)

Создает экземпляр ContainerRegistryClient для взаимодействия с реестром контейнеров Azure с включенным анонимным доступом к запросу. Включены только операции, поддерживающие анонимный доступ. Другие методы службы вызывают ошибки.

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

import { ContainerRegistryClient } from "@azure/container-registry";

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
);

new ContainerRegistryClient(endpoint: string, options?: ContainerRegistryClientOptions)

Параметры

endpoint

string

конечная точка URL-адреса реестра контейнеров

options
ContainerRegistryClientOptions

необязательная конфигурация, используемая для отправки запросов в службу

ContainerRegistryClient(string, TokenCredential, ContainerRegistryClientOptions)

Создает экземпляр ContainerRegistryClient.

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

import { ContainerRegistryClient } from "@azure/container-registry";
import { DefaultAzureCredential} from "@azure/identity";

const client = new ContainerRegistryClient(
   "<container registry API endpoint>",
   new DefaultAzureCredential()
);

new ContainerRegistryClient(endpoint: string, credential: TokenCredential, options?: ContainerRegistryClientOptions)

Параметры

endpoint

string

конечная точка URL-адреса реестра контейнеров

credential
TokenCredential

используется для проверки подлинности запросов к службе

options
ContainerRegistryClientOptions

необязательная конфигурация, используемая для отправки запросов в службу

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

endpoint

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

endpoint: string

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

string

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

deleteRepository(string, DeleteRepositoryOptions)

Удаляет репозиторий, определенный заданным именем и всеми связанными артефактами.

function deleteRepository(repositoryName: string, options?: DeleteRepositoryOptions): Promise<void>

Параметры

repositoryName

string

Имя репозитория для удаления

options
DeleteRepositoryOptions

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

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

Promise<void>

getArtifact(string, string)

Возвращает экземпляр RegistryArtifact для вызова методов службы, связанных с артефактом, указанным repositoryName и tagOrDigest.

function getArtifact(repositoryName: string, tagOrDigest: string): RegistryArtifact

Параметры

repositoryName

string

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

tagOrDigest

string

тег или дайджест артефакта для извлечения

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

RegistryArtifact

getRepository(string)

Возвращает экземпляр ContainerRepository для вызова методов службы, связанных с репозиторием, указанным repositoryName.

function getRepository(repositoryName: string): ContainerRepository

Параметры

repositoryName

string

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

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

ContainerRepository

listRepositoryNames(ListRepositoriesOptions)

Возвращает асинхронный итератор для перечисления имен репозиториев в этом реестре.

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

let client = new ContainerRegistryClient(url, credential);
for await (const repository of client.listRepositoryNames()) {
  console.log("repository name: ", repository);
}

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

let iter = client.listRepositoryNames();
let item = await iter.next();
while (!item.done) {
  console.log(`repository name: ${item.value}`);
  item = await iter.next();
}

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

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

function listRepositoryNames(options?: ListRepositoriesOptions): PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>

Параметры

options
ListRepositoriesOptions

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

PagedAsyncIterableIterator<string, RepositoryPageResponse, PageSettings>