ContainerRegistryClient class
用來與 Container Registry 服務互動的用戶端類別。
建構函式
Container |
建立 ContainerRegistryClient 的實例,以與已啟用匿名提取存取的Azure Container Registry互動。 只會啟用支援匿名存取的作業。 其他服務方法會擲回錯誤。 使用方式範例:
|
Container |
建立 ContainerRegistryClient 的實例。 使用方式範例:
|
屬性
endpoint | Azure Container Registry端點。 |
方法
delete |
刪除指定名稱和所有相關聯成品所識別的存放庫。 |
get |
傳回RegistryArtifact的實例,以呼叫與 和 |
get |
傳回 ContainerRepository 的實例,以呼叫與 所 |
list |
傳回非同步反覆運算器,以列出此登錄中的存放庫名稱。 使用方式範例:
使用
使用
|
建構函式詳細資料
ContainerRegistryClient(string, ContainerRegistryClientOptions)
建立 ContainerRegistryClient 的實例,以與已啟用匿名提取存取的Azure Container Registry互動。 只會啟用支援匿名存取的作業。 其他服務方法會擲回錯誤。
使用方式範例:
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 Container Registry端點。
endpoint: string
屬性值
string
方法詳細資料
deleteRepository(string, DeleteRepositoryOptions)
刪除指定名稱和所有相關聯成品所識別的存放庫。
function deleteRepository(repositoryName: string, options?: DeleteRepositoryOptions): Promise<void>
參數
- repositoryName
-
string
要刪除的存放庫名稱
- options
- DeleteRepositoryOptions
作業的選擇性組態
傳回
Promise<void>
getArtifact(string, string)
傳回RegistryArtifact的實例,以呼叫與 和 tagOrDigest
所 repositoryName
指定之成品相關的服務方法。
function getArtifact(repositoryName: string, tagOrDigest: string): RegistryArtifact
參數
- repositoryName
-
string
存放庫的名稱
- tagOrDigest
-
string
要擷取之成品的標記或摘要
傳回
getRepository(string)
傳回 ContainerRepository 的實例,以呼叫與 所 repositoryName
指定存放庫相關的服務方法。
function getRepository(repositoryName: string): ContainerRepository
參數
- repositoryName
-
string
存放庫的名稱
傳回
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