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

RegistryArtifact interface

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

Artifact — это общий термин для элементов, хранящихся в реестре контейнеров, и может включать образы Docker или другие типы артефактов Open Container Initiative (OCI).

Интерфейс registryArtifact — это вспомогательный интерфейс, который группирует сведения и операции с изображением или артефактом в реестре контейнеров.

Свойства

fullyQualifiedReference

полный справочник по артефакту.
registryEndpoint

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

Имя репозитория.

Методы

delete(DeleteArtifactOptions)

Удаляет этот артефакт реестра, удалив его манифест.
deleteTag(string, DeleteTagOptions)

Удаляет тег. При этом тег удаляется из артефакта и его манифеста.
getManifestProperties(GetManifestPropertiesOptions)

Извлекает свойства манифеста, который однозначно идентифицирует этот артефакт.
getTagProperties(string, GetTagPropertiesOptions)

Извлекает свойства указанного тега.
listTagProperties(ListTagPropertiesOptions)

Возвращает асинхронный итератор для перечисления тегов, однозначно определяющих этот артефакт и свойства каждого из них.

Пример использования синтаксиса for-await-of:

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

const endpoint = "https://myregistryname.azurecr.io";
const repositoryName = "library/hello-world";
const artifactTagOrDigest = "latest";
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());

const artifact = client.getArtifact(repositoryName, artifactTagOrDigest);
for await (const tag of artifact.listTagProperties()) {
  console.log("tag: ", tag);
}
updateManifestProperties(UpdateManifestPropertiesOptions)

Обновляет свойства манифеста артефакта.

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

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

const endpoint = "https://myregistryname.azurecr.io";
const repositoryName = "library/hello-world";
const artifactTagOrDigest = "latest";
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());

const artifact = client.getArtifact(repositoryName, artifactTagOrDigest);
const updated = await artifact.updateManifestProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false,
});
updateTagProperties(string, UpdateTagPropertiesOptions)

Обновляет свойства заданного тега.

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

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

const endpoint = "https://myregistryname.azurecr.io";
const repositoryName = "library/hello-world";
const artifactTagOrDigest = "latest";
const tag = "latest";
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());

const artifact = client.getArtifact(repositoryName, artifactTagOrDigest);
const updated = await artifact.updateTagProperties(tag, {
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false,
});

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

fullyQualifiedReference

полный справочник по артефакту.

fullyQualifiedReference: string

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

string

registryEndpoint

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

registryEndpoint: string

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

string

repositoryName

Имя репозитория.

repositoryName: string

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

string

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

delete(DeleteArtifactOptions)

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

function delete(options?: DeleteArtifactOptions): Promise<void>

Параметры

options
DeleteArtifactOptions

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

Promise<void>

deleteTag(string, DeleteTagOptions)

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

function deleteTag(tag: string, options?: DeleteTagOptions): Promise<void>

Параметры

tag

string

имя тега для удаления.

options
DeleteTagOptions

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

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

Извлекает свойства манифеста, который однозначно идентифицирует этот артефакт.

function getManifestProperties(options?: GetManifestPropertiesOptions): Promise<ArtifactManifestProperties>

Параметры

options
GetManifestPropertiesOptions

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

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

Извлекает свойства указанного тега.

function getTagProperties(tag: string, options?: GetTagPropertiesOptions): Promise<ArtifactTagProperties>

Параметры

tag

string

тег для получения свойств.

options
GetTagPropertiesOptions

Опции получения свойств тегов

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

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

Возвращает асинхронный итератор для перечисления тегов, однозначно определяющих этот артефакт и свойства каждого из них.

Пример использования синтаксиса for-await-of:

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

const endpoint = "https://myregistryname.azurecr.io";
const repositoryName = "library/hello-world";
const artifactTagOrDigest = "latest";
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());

const artifact = client.getArtifact(repositoryName, artifactTagOrDigest);
for await (const tag of artifact.listTagProperties()) {
  console.log("tag: ", tag);
}

function listTagProperties(options?: ListTagPropertiesOptions): PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

Параметры

options
ListTagPropertiesOptions

Опции перечисления тегов

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

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

Обновляет свойства манифеста артефакта.

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

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

const endpoint = "https://myregistryname.azurecr.io";
const repositoryName = "library/hello-world";
const artifactTagOrDigest = "latest";
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());

const artifact = client.getArtifact(repositoryName, artifactTagOrDigest);
const updated = await artifact.updateManifestProperties({
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false,
});

function updateManifestProperties(options: UpdateManifestPropertiesOptions): Promise<ArtifactManifestProperties>

Параметры

options
UpdateManifestPropertiesOptions

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

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

Обновляет свойства заданного тега.

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

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

const endpoint = "https://myregistryname.azurecr.io";
const repositoryName = "library/hello-world";
const artifactTagOrDigest = "latest";
const tag = "latest";
const client = new ContainerRegistryClient(endpoint, new DefaultAzureCredential());

const artifact = client.getArtifact(repositoryName, artifactTagOrDigest);
const updated = await artifact.updateTagProperties(tag, {
  canDelete: false,
  canList: false,
  canRead: false,
  canWrite: false,
});

function updateTagProperties(tag: string, options: UpdateTagPropertiesOptions): Promise<ArtifactTagProperties>

Параметры

tag

string

имя тега для обновления свойств

options
UpdateTagPropertiesOptions

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

Promise<ArtifactTagProperties>