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

ContainerRegistryContentClient class

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

Клиент большого двоичного объекта Реестра контейнеров Azure, отвечающий за отправку и скачивание больших двоичных объектов и манифестов, стандартных блоков артефактов.

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

ContainerRegistryContentClient(string, string, TokenCredential, ContainerRegistryContentClientOptions)

Создает экземпляр ContainerRegistryContentClient для управления образами контейнеров и артефактами.

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

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

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

Свойства

endpoint

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

Имя репозитория, который логически группирует части артефактов.

Методы

deleteBlob(string, DeleteBlobOptions)

Удаление большого двоичного объекта.
deleteManifest(string, DeleteManifestOptions)

Удаление манифеста. Это эффективно удаляет артефакт из реестра.
downloadBlob(string, DownloadBlobOptions)

Скачайте большой двоичный объект, который является частью артефакта.
getManifest(string, GetManifestOptions)

Загружает манифест для артефакта OCI.
setManifest(Buffer | ReadableStream | OciImageManifest | Record<string, unknown>, SetManifestOptions)

Отправьте манифест для артефакта OCI.
uploadBlob(Buffer | ReadableStream, UploadBlobOptions)

Отправка большого двоичного объекта артефакта.

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

ContainerRegistryContentClient(string, string, TokenCredential, ContainerRegistryContentClientOptions)

Создает экземпляр ContainerRegistryContentClient для управления образами контейнеров и артефактами.

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

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

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

new ContainerRegistryContentClient(endpoint: string, repositoryName: string, credential: TokenCredential, options?: ContainerRegistryContentClientOptions)

Параметры

endpoint

string

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

repositoryName

string

имя репозитория, который логически группирует части артефакта

credential
TokenCredential

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

options
ContainerRegistryContentClientOptions

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

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

endpoint

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

endpoint: string

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

string

repositoryName

Имя репозитория, который логически группирует части артефактов.

repositoryName: string

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

string

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

deleteBlob(string, DeleteBlobOptions)

Удаление большого двоичного объекта.

function deleteBlob(digest: string, options?: DeleteBlobOptions): Promise<void>

Параметры

digest

string

дайджест большого двоичного объекта для удаления

options
DeleteBlobOptions

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

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

Promise<void>

deleteManifest(string, DeleteManifestOptions)

Удаление манифеста. Это эффективно удаляет артефакт из реестра.

function deleteManifest(digest: string, options?: DeleteManifestOptions): Promise<void>

Параметры

digest

string

дайджест манифеста для удаления

options
DeleteManifestOptions

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

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

Promise<void>

downloadBlob(string, DownloadBlobOptions)

Скачайте большой двоичный объект, который является частью артефакта.

function downloadBlob(digest: string, options?: DownloadBlobOptions): Promise<DownloadBlobResult>

Параметры

digest

string

дайджест большого двоичного объекта для скачивания

options
DownloadBlobOptions

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

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

Promise<DownloadBlobResult>

  • скачанный большой двоичный объект

getManifest(string, GetManifestOptions)

Загружает манифест для артефакта OCI.

function getManifest(tagOrDigest: string, options?: GetManifestOptions): Promise<GetManifestResult>

Параметры

tagOrDigest

string

тег или дайджест, определяющий артефакт

options
GetManifestOptions

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

Promise<GetManifestResult>

  • скачанный манифест.

setManifest(Buffer | ReadableStream | OciImageManifest | Record<string, unknown>, SetManifestOptions)

Отправьте манифест для артефакта OCI.

function setManifest(manifest: Buffer | ReadableStream | OciImageManifest | Record<string, unknown>, options?: SetManifestOptions): Promise<SetManifestResult>

Параметры

manifest

Buffer | ReadableStream | OciImageManifest | Record<string, unknown>

манифест для отправки.

options
SetManifestOptions

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

Promise<SetManifestResult>

uploadBlob(Buffer | ReadableStream, UploadBlobOptions)

Отправка большого двоичного объекта артефакта.

function uploadBlob(blob: Buffer | ReadableStream, options?: UploadBlobOptions): Promise<UploadBlobResult>

Параметры

blob

Buffer | ReadableStream

options
UploadBlobOptions

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

Promise<UploadBlobResult>