ContainerRegistryContentClient class

Paket:

@azure/container-registry

Den Azure Container Registry blobklienten, som ansvarar för att ladda upp och ladda ned blobar och manifest, byggstenarna för artefakter.

Konstruktorer

ContainerRegistryContentClient(string, string, TokenCredential, ContainerRegistryContentClientOptions)

Skapar en instans av en ContainerRegistryContentClient för hantering av containeravbildningar och artefakter. Exempel på användning: import { ContainerRegistryContentClient } from "@azure/container-registry"; import { DefaultAzureCredential} from "@azure/identity"; const client = new ContainerRegistryContentClient( "<container registry API endpoint>", "<repository name>", new DefaultAzureCredential() );

Egenskaper

endpoint	Den Azure Container Registry slutpunkten.
repositoryName	Namnet på lagringsplatsen som logiskt grupperar artefaktdelarna.

Metoder

deleteBlob(string, DeleteBlobOptions)	Ta bort en blob.
deleteManifest(string, DeleteManifestOptions)	Ta bort ett manifest. När du gör det tas en artefakt bort från registret.
downloadBlob(string, DownloadBlobOptions)	Ladda ned en blob som är en del av en artefakt.
getManifest(string, GetManifestOptions)	Laddar ned manifestet för en OCI-artefakt.
setManifest(Buffer | ReadableStream | OciImageManifest | Record<string, unknown>, SetManifestOptions)	Ladda upp ett manifest för en OCI-artefakt.
uploadBlob(Buffer | ReadableStream, UploadBlobOptions)	Ladda upp en artefaktblob.

Konstruktorinformation

ContainerRegistryContentClient(string, string, TokenCredential, ContainerRegistryContentClientOptions)

Skapar en instans av en ContainerRegistryContentClient för hantering av containeravbildningar och artefakter.

Exempel på användning:

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)

Parametrar

endpoint

string

URL-slutpunkten för containerregistret

repositoryName

string

namnet på lagringsplatsen som logiskt grupperar artefaktdelarna

credential

TokenCredential

används för att autentisera begäranden till tjänsten

options

ContainerRegistryContentClientOptions

valfri konfiguration som används för att skicka begäranden till tjänsten

Egenskapsinformation

endpoint

Den Azure Container Registry slutpunkten.

endpoint: string

Egenskapsvärde

string

repositoryName

Namnet på lagringsplatsen som logiskt grupperar artefaktdelarna.

repositoryName: string

Egenskapsvärde

string

Metodinformation

deleteBlob(string, DeleteBlobOptions)

Ta bort en blob.

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

Parametrar

digest

string

sammanfattningen av bloben som ska tas bort

options

DeleteBlobOptions

valfri konfiguration som används för att skicka begäranden till tjänsten

Returer

Promise<void>

deleteManifest(string, DeleteManifestOptions)

Ta bort ett manifest. När du gör det tas en artefakt bort från registret.

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

Parametrar

digest

string

sammanfattningen av manifestet som ska tas bort

options

DeleteManifestOptions

valfri konfiguration som används för att skicka begäranden till tjänsten

Returer

Promise<void>

downloadBlob(string, DownloadBlobOptions)

Ladda ned en blob som är en del av en artefakt.

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

Parametrar

digest

string

sammanfattningen av bloben som ska laddas ned

options

DownloadBlobOptions

valfri konfiguration som används för att skicka begäranden till tjänsten

Returer

Promise<DownloadBlobResult>

• den nedladdade bloben

getManifest(string, GetManifestOptions)

Laddar ned manifestet för en OCI-artefakt.

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

Parametrar

tagOrDigest

string

en tagg eller sammandrag som identifierar artefakten

options

GetManifestOptions

Returer

Promise<GetManifestResult>

• det nedladdade manifestet.

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

Ladda upp ett manifest för en OCI-artefakt.

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

Parametrar

manifest

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

manifestet som ska laddas upp.

options

SetManifestOptions

Returer

Promise<SetManifestResult>

uploadBlob(Buffer | ReadableStream, UploadBlobOptions)

Ladda upp en artefaktblob.

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

Parametrar

blob

Buffer | ReadableStream

options

UploadBlobOptions

Returer

Promise<UploadBlobResult>