ContainerRegistryContentClient class

Pakiet:

@azure/container-registry

Klient Azure Container Registry obiektów blob, odpowiedzialny za przekazywanie i pobieranie obiektów blob oraz manifestów, bloków konstrukcyjnych artefaktów.

Konstruktory

ContainerRegistryContentClient(string, string, TokenCredential, ContainerRegistryContentClientOptions)

Tworzy wystąpienie klasy ContainerRegistryContentClient do zarządzania obrazami kontenerów i artefaktami. Przykład użycia: import { ContainerRegistryContentClient } from "@azure/container-registry"; import { DefaultAzureCredential} from "@azure/identity"; const client = new ContainerRegistryContentClient( "<container registry API endpoint>", "<repository name>", new DefaultAzureCredential() );

Właściwości

endpoint	Punkt końcowy Azure Container Registry.
repositoryName	Nazwa repozytorium, które logicznie grupuje części artefaktów.

Metody

deleteBlob(string, DeleteBlobOptions)	Usuwanie obiektu blob.
deleteManifest(string, DeleteManifestOptions)	Usuń manifest. W ten sposób skutecznie usuwa artefakt z rejestru.
downloadBlob(string, DownloadBlobOptions)	Pobierz obiekt blob, który jest częścią artefaktu.
getManifest(string, GetManifestOptions)	Pobiera manifest artefaktu OCI.
setManifest(Buffer | ReadableStream | OciImageManifest | Record<string, unknown>, SetManifestOptions)	Przekaż manifest artefaktu OCI.
uploadBlob(Buffer | ReadableStream, UploadBlobOptions)	Przekaż artefaktowy obiekt blob.

Szczegóły konstruktora

ContainerRegistryContentClient(string, string, TokenCredential, ContainerRegistryContentClientOptions)

Tworzy wystąpienie klasy ContainerRegistryContentClient do zarządzania obrazami kontenerów i artefaktami.

Przykład użycia:

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)

Parametry

endpoint

string

punkt końcowy adresu URL rejestru kontenerów

repositoryName

string

nazwa repozytorium, które logicznie grupuje części artefaktów

credential

TokenCredential

używane do uwierzytelniania żądań w usłudze

options

ContainerRegistryContentClientOptions

opcjonalna konfiguracja używana do wysyłania żądań do usługi

Szczegóły właściwości

endpoint

Punkt końcowy Azure Container Registry.

endpoint: string

Wartość właściwości

string

repositoryName

Nazwa repozytorium, które logicznie grupuje części artefaktów.

repositoryName: string

Wartość właściwości

string

Szczegóły metody

deleteBlob(string, DeleteBlobOptions)

Usuwanie obiektu blob.

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

Parametry

digest

string

skrót obiektu blob do usunięcia

options

DeleteBlobOptions

opcjonalna konfiguracja używana do wysyłania żądań do usługi

Zwraca

Promise<void>

deleteManifest(string, DeleteManifestOptions)

Usuń manifest. W ten sposób skutecznie usuwa artefakt z rejestru.

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

Parametry

digest

string

skrót manifestu do usunięcia

options

DeleteManifestOptions

opcjonalna konfiguracja używana do wysyłania żądań do usługi

Zwraca

Promise<void>

downloadBlob(string, DownloadBlobOptions)

Pobierz obiekt blob, który jest częścią artefaktu.

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

Parametry

digest

string

skrót obiektu blob do pobrania

options

DownloadBlobOptions

opcjonalna konfiguracja używana do wysyłania żądań do usługi

Zwraca

Promise<DownloadBlobResult>

• pobrany obiekt blob

getManifest(string, GetManifestOptions)

Pobiera manifest artefaktu OCI.

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

Parametry

tagOrDigest

string

tag lub skrót identyfikujący artefakt

options

GetManifestOptions

Zwraca

Promise<GetManifestResult>

• pobrany manifest.

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

Przekaż manifest artefaktu OCI.

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

Parametry

manifest

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

manifest do przekazania.

options

SetManifestOptions

Zwraca

Promise<SetManifestResult>

uploadBlob(Buffer | ReadableStream, UploadBlobOptions)

Przekaż artefaktowy obiekt blob.

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

Parametry

blob

Buffer | ReadableStream

options

UploadBlobOptions

Zwraca

Promise<UploadBlobResult>