Udostępnij za pośrednictwem

RegistryArtifact interface

  • Odwołanie
Pakiet:
@azure/container-registry

Artifact to ogólny termin dla elementów przechowywanych w rejestrze kontenerów i może zawierać obrazy platformy Docker lub inne typy artefaktów Open Container Initiative (OCI).

Interfejs RegistryArtifact to pomocnik, który grupuje informacje i operacje dotyczące obrazu lub artefaktu w rejestrze kontenerów.

Właściwości

fullyQualifiedReference

w pełni kwalifikowane odwołanie do artefaktu.
registryEndpoint

Punkt końcowy Azure Container Registry.
repositoryName

Nazwa repozytorium.

Metody

delete(DeleteArtifactOptions)

Usuwa ten artefakt rejestru, usuwając jego manifest.
deleteTag(string, DeleteTagOptions)

Usuwa tag. Spowoduje to usunięcie tagu z artefaktu i jego manifestu.
getManifestProperties(GetManifestPropertiesOptions)

Pobiera właściwości manifestu, który jednoznacznie identyfikuje ten artefakt.
getTagProperties(string, GetTagPropertiesOptions)

Pobiera właściwości określonego tagu.
listTagProperties(ListTagPropertiesOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę tagów, które jednoznacznie identyfikują ten artefakt i właściwości każdego z nich.

Przykład użycia for-await-of składni:

const client = new ContainerRegistryClient(url, credentials);
const repository = client.getRepository(repositoryName);
const artifact = repository.getArtifact(digest)
for await (const tag of artifact.listTagProperties()) {
  console.log("tag: ", tag);
}

Przykład użycia polecenia iter.next():

const iter = artifact.listTagProperties();
let item = await iter.next();
while (!item.done) {
  console.log("tag properties: ", item.value);
  item = await iter.next();
}

Przykład użycia polecenia byPage():

const pages = artifact.listTagProperties().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const tagProperties of page.value) {
     console.log(`  repository name: ${tagProperties}`);
   }
 }
 page = await pages.next();
}
updateManifestProperties(UpdateManifestPropertiesOptions)

Aktualizacje właściwości manifestu artefaktu.

Przykład użycia: 

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

Aktualizacje właściwości danego tagu.

Przykład użycia: 

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

Szczegóły właściwości

fullyQualifiedReference

w pełni kwalifikowane odwołanie do artefaktu.

fullyQualifiedReference: string

Wartość właściwości

string

registryEndpoint

Punkt końcowy Azure Container Registry.

registryEndpoint: string

Wartość właściwości

string

repositoryName

Nazwa repozytorium.

repositoryName: string

Wartość właściwości

string

Szczegóły metody

delete(DeleteArtifactOptions)

Usuwa ten artefakt rejestru, usuwając jego manifest.

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

Parametry

options
DeleteArtifactOptions

Zwraca

Promise<void>

deleteTag(string, DeleteTagOptions)

Usuwa tag. Spowoduje to usunięcie tagu z artefaktu i jego manifestu.

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

Parametry

tag

string

nazwa tagu do usunięcia.

options
DeleteTagOptions

Zwraca

Promise<void>

getManifestProperties(GetManifestPropertiesOptions)

Pobiera właściwości manifestu, który jednoznacznie identyfikuje ten artefakt.

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

Parametry

options
GetManifestPropertiesOptions

Zwraca

Promise<ArtifactManifestProperties>

getTagProperties(string, GetTagPropertiesOptions)

Pobiera właściwości określonego tagu.

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

Parametry

tag

string

tag do pobrania właściwości.

options
GetTagPropertiesOptions

Zwraca

Promise<ArtifactTagProperties>

listTagProperties(ListTagPropertiesOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę tagów, które jednoznacznie identyfikują ten artefakt i właściwości każdego z nich.

Przykład użycia for-await-of składni:

const client = new ContainerRegistryClient(url, credentials);
const repository = client.getRepository(repositoryName);
const artifact = repository.getArtifact(digest)
for await (const tag of artifact.listTagProperties()) {
  console.log("tag: ", tag);
}

Przykład użycia polecenia iter.next():

const iter = artifact.listTagProperties();
let item = await iter.next();
while (!item.done) {
  console.log("tag properties: ", item.value);
  item = await iter.next();
}

Przykład użycia polecenia byPage():

const pages = artifact.listTagProperties().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const tagProperties of page.value) {
     console.log(`  repository name: ${tagProperties}`);
   }
 }
 page = await pages.next();
}

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

Parametry

options
ListTagPropertiesOptions

Zwraca

PagedAsyncIterableIterator<ArtifactTagProperties, ArtifactTagProperties[], PageSettings>

updateManifestProperties(UpdateManifestPropertiesOptions)

Aktualizacje właściwości manifestu artefaktu.

Przykład użycia: 

const client = new ContainerRegistryClient(url, credential);
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>

Parametry

options
UpdateManifestPropertiesOptions

Zwraca

Promise<ArtifactManifestProperties>

updateTagProperties(string, UpdateTagPropertiesOptions)

Aktualizacje właściwości danego tagu.

Przykład użycia: 

const client = new ContainerRegistryClient(url, credential);
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>

Parametry

tag

string

nazwa tagu do zaktualizowania właściwości

options
UpdateTagPropertiesOptions

Zwraca

Promise<ArtifactTagProperties>