ContainerRegistryContentClient class

パッケージ:

@azure/container-registry

Azure Container Registry BLOB クライアント。BLOB とマニフェストのアップロードとダウンロードを担当し、成果物の構成要素です。

コンストラクター

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 Container Registry エンドポイント。
repositoryName	成果物パーツを論理的にグループ化するリポジトリの名前。

メソッド

deleteBlob(string, DeleteBlobOptions)	BLOB を削除する
deleteManifest(string, DeleteManifestOptions)	マニフェストを削除します。 これにより、効果的にレジストリから成果物が削除されます。
downloadBlob(string, DownloadBlobOptions)	成果物の一部である BLOB をダウンロードします。
getManifest(string, GetManifestOptions)	OCI 成果物のマニフェストをダウンロードします。
setManifest(Buffer | ReadableStream | OciImageManifest | Record<string, unknown>, SetManifestOptions)	OCI 成果物のマニフェストをアップロードします。
uploadBlob(Buffer | ReadableStream, UploadBlobOptions)	成果物 BLOB をアップロードします。

コンストラクターの詳細

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 Container Registry エンドポイント。

endpoint: string

プロパティ値

string

repositoryName

成果物パーツを論理的にグループ化するリポジトリの名前。

repositoryName: string

プロパティ値

string

メソッドの詳細

deleteBlob(string, DeleteBlobOptions)

BLOB を削除する

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

パラメーター

digest

string

削除する BLOB のダイジェスト

options

DeleteBlobOptions

サービスに要求を送信するために使用されるオプションの構成

戻り値

Promise<void>

deleteManifest(string, DeleteManifestOptions)

マニフェストを削除します。 これにより、効果的にレジストリから成果物が削除されます。

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

パラメーター

digest

string

削除するマニフェストのダイジェスト

options

DeleteManifestOptions

サービスに要求を送信するために使用されるオプションの構成

戻り値

Promise<void>

downloadBlob(string, DownloadBlobOptions)

成果物の一部である BLOB をダウンロードします。

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

パラメーター

digest

string

ダウンロードする BLOB のダイジェスト

options

DownloadBlobOptions

サービスに要求を送信するために使用されるオプションの構成

戻り値

Promise<DownloadBlobResult>

• ダウンロードした BLOB

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)

成果物 BLOB をアップロードします。

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

パラメーター

blob

Buffer | ReadableStream

options

UploadBlobOptions

戻り値

Promise<UploadBlobResult>