ContainerRegistryContentClient class
Azure 容器注册表 Blob 客户端,负责上传和下载 Blob 和清单,项目构建基块。
构造函数
| Container |
创建 ContainerRegistryContentClient 的实例,用于管理容器映像和项目。 示例用法:
|
属性
| endpoint | Azure 容器注册表终结点。 |
| repository |
逻辑上对项目部件进行分组的存储库的名称。 |
方法
| delete |
删除 Blob。 |
| delete |
删除清单。 这样做会有效地从注册表中删除项目。 |
| download |
下载属于项目的 Blob。 |
| get |
下载 OCI 项目的清单。 |
| set |
上传 OCI 项目的清单。 |
| upload |
上传项目 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
用于对服务的请求进行身份验证
用于向服务发送请求的可选配置
属性详细信息
endpoint
Azure 容器注册表终结点。
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>