ContainerRepository interface
容器注册表中的 repository
是共享相同名称的映像或项目的逻辑分组。 例如,hello-world
应用程序的不同版本可以具有标记 v1
和 v2
,并按存储库 hello-world
分组。
ContainerRepository 接口是一个帮助程序,用于对此容器注册表中的存储库的信息和作进行分组。
属性
name | 存储库名称。 |
registry |
Azure 容器注册表终结点。 |
方法
delete(Delete |
删除此存储库及其逻辑组中的所有项目。 |
get |
返回给定标记或摘要的 RegistryArtifact 的帮助程序实例。 |
get |
检索此存储库的属性。 |
list |
返回一个异步可迭代迭代器以列出清单属性。 这可用于确定与此存储库关联的项目集合,因为每个项目都由其清单唯一标识。 使用
使用
使用
|
update |
更新此存储库的属性。 示例用法:
|
属性详细信息
name
存储库名称。
name: string
属性值
string
registryEndpoint
Azure 容器注册表终结点。
registryEndpoint: string
属性值
string
方法详细信息
delete(DeleteRepositoryOptions)
删除此存储库及其逻辑组中的所有项目。
function delete(options?: DeleteRepositoryOptions): Promise<void>
参数
- options
- DeleteRepositoryOptions
作的可选配置
返回
Promise<void>
getArtifact(string)
返回给定标记或摘要的 RegistryArtifact 的帮助程序实例。
function getArtifact(tagOrDigest: string): RegistryArtifact
参数
- tagOrDigest
-
string
项目的标记或摘要
返回
getProperties(GetRepositoryPropertiesOptions)
检索此存储库的属性。
function getProperties(options?: GetRepositoryPropertiesOptions): Promise<ContainerRepositoryProperties>
参数
- options
- GetRepositoryPropertiesOptions
返回
Promise<ContainerRepositoryProperties>
listManifestProperties(ListManifestPropertiesOptions)
返回一个异步可迭代迭代器以列出清单属性。 这可用于确定与此存储库关联的项目集合,因为每个项目都由其清单唯一标识。
使用 for-await-of
语法的示例:
const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
for await (const manifest of repository.listManifestProperties()) {
console.log("manifest: ", manifest);
}
使用 iter.next()
的示例:
const iter = repository.listManifestProperties();
let item = await iter.next();
while (!item.done) {
console.log("manifest properties: ", item.value);
item = await iter.next();
}
使用 byPage()
的示例:
const pages = repository.listManifestProperties().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
if (page.value) {
console.log(`-- page ${i++}`);
for (const manifestProperties of page.value) {
console.log(` manifest properties: ${manifestProperties}`);
}
}
page = await pages.next();
}
function listManifestProperties(options?: ListManifestPropertiesOptions): PagedAsyncIterableIterator<ArtifactManifestProperties, ArtifactManifestProperties[], PageSettings>
参数
- options
- ListManifestPropertiesOptions
返回
updateProperties(UpdateRepositoryPropertiesOptions)
更新此存储库的属性。
示例用法:
const client = new ContainerRegistryClient(url, credential);
const repository = client.getRepository(repositoryName)
const updated = await repository.updateProperties({
canDelete: false,
canList: false,
canRead: false,
canWrite: false
});
function updateProperties(options: UpdateRepositoryPropertiesOptions): Promise<ContainerRepositoryProperties>
参数
返回
Promise<ContainerRepositoryProperties>