ContainerRegistryContentClient class

Paket:

@azure/container-registry

Der Azure Container Registry-BLOB-Client, der für das Hochladen und Herunterladen von Blobs und Manifesten verantwortlich ist, die Bausteine von Artefakten.

Konstruktoren

ContainerRegistryContentClient(string, string, TokenCredential, ContainerRegistryContentClientOptions)

Erstellt eine Instanz eines ContainerRegistryContentClient zum Verwalten von Containerimages und Artefakten. Beispielverwendung: import { ContainerRegistryContentClient } from "@azure/container-registry"; import { DefaultAzureCredential} from "@azure/identity"; const client = new ContainerRegistryContentClient( "<container registry API endpoint>", "<repository name>", new DefaultAzureCredential() );

Eigenschaften

endpoint	Der Azure-Containerregistrierungsendpunkt.
repositoryName	Der Name des Repositorys, das die Artefaktteile logisch gruppiert.

Methoden

deleteBlob(string, DeleteBlobOptions)	Löschen eines Blobs.
deleteManifest(string, DeleteManifestOptions)	Löschen eines Manifests. Dadurch wird ein Artefakt effektiv aus der Registrierung gelöscht.
downloadBlob(string, DownloadBlobOptions)	Laden Sie ein Blob herunter, das Teil eines Artefakts ist.
getManifest(string, GetManifestOptions)	Lädt das Manifest für ein OCI-Artefakt herunter.
setManifest(Buffer | ReadableStream | OciImageManifest | Record<string, unknown>, SetManifestOptions)	Laden Sie ein Manifest für ein OCI-Artefakt hoch.
uploadBlob(Buffer | ReadableStream, UploadBlobOptions)	Laden Sie ein Artefakt-Blob hoch.

Details zum Konstruktor

ContainerRegistryContentClient(string, string, TokenCredential, ContainerRegistryContentClientOptions)

Erstellt eine Instanz eines ContainerRegistryContentClient zum Verwalten von Containerimages und Artefakten.

Beispielverwendung:

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)

Parameter

endpoint

string

der URL-Endpunkt der Containerregistrierung

repositoryName

string

der Name des Repositorys, das die Artefaktteile logisch gruppiert

credential

TokenCredential

wird verwendet, um Anforderungen an den Dienst zu authentifizieren

options

ContainerRegistryContentClientOptions

optionale Konfiguration zum Senden von Anforderungen an den Dienst

Details zur Eigenschaft

endpoint

Der Azure-Containerregistrierungsendpunkt.

endpoint: string

Eigenschaftswert

string

repositoryName

Der Name des Repositorys, das die Artefaktteile logisch gruppiert.

repositoryName: string

Eigenschaftswert

string

Details zur Methode

deleteBlob(string, DeleteBlobOptions)

Löschen eines Blobs.

function deleteBlob(digest: string, options?: DeleteBlobOptions): Promise<void>

Parameter

digest

string

Der Digest des zu löschenden Blobs

options

DeleteBlobOptions

optionale Konfiguration zum Senden von Anforderungen an den Dienst

Gibt zurück

Promise<void>

deleteManifest(string, DeleteManifestOptions)

Löschen eines Manifests. Dadurch wird ein Artefakt effektiv aus der Registrierung gelöscht.

function deleteManifest(digest: string, options?: DeleteManifestOptions): Promise<void>

Parameter

digest

string

den Digest des zu löschenden Manifests

options

DeleteManifestOptions

optionale Konfiguration zum Senden von Anforderungen an den Dienst

Gibt zurück

Promise<void>

downloadBlob(string, DownloadBlobOptions)

Laden Sie ein Blob herunter, das Teil eines Artefakts ist.

function downloadBlob(digest: string, options?: DownloadBlobOptions): Promise<DownloadBlobResult>

Parameter

digest

string

Den Digest des herunterzuladenden Blobs

options

DownloadBlobOptions

optionale Konfiguration zum Senden von Anforderungen an den Dienst

Gibt zurück

Promise<DownloadBlobResult>

• das heruntergeladene Blob

getManifest(string, GetManifestOptions)

Lädt das Manifest für ein OCI-Artefakt herunter.

function getManifest(tagOrDigest: string, options?: GetManifestOptions): Promise<GetManifestResult>

Parameter

tagOrDigest

string

ein Tag oder digest, das das Artefakt identifiziert

options

GetManifestOptions

Gibt zurück

Promise<GetManifestResult>

• das heruntergeladene Manifest.

setManifest(Buffer | ReadableStream | OciImageManifest | Record<string, unknown>, SetManifestOptions)

Laden Sie ein Manifest für ein OCI-Artefakt hoch.

function setManifest(manifest: Buffer | ReadableStream | OciImageManifest | Record<string, unknown>, options?: SetManifestOptions): Promise<SetManifestResult>

Parameter

manifest

Buffer | ReadableStream | OciImageManifest | Record<string, unknown>

das Manifest, das hochgeladen werden soll.

options

SetManifestOptions

Gibt zurück

Promise<SetManifestResult>

uploadBlob(Buffer | ReadableStream, UploadBlobOptions)

Laden Sie ein Artefakt-Blob hoch.

function uploadBlob(blob: Buffer | ReadableStream, options?: UploadBlobOptions): Promise<UploadBlobResult>

Parameter

blob

Buffer | ReadableStream

options

UploadBlobOptions

Gibt zurück

Promise<UploadBlobResult>