ContainerRegistryContentClient class

Balíček:

@azure/container-registry

Klient objektů blob služby Azure Container Registry zodpovědný za nahrávání a stahování objektů blob a manifestů, stavebních bloků artefaktů.

Konstruktory

ContainerRegistryContentClient(string, string, TokenCredential, ContainerRegistryContentClientOptions)

Vytvoří instanci ContainerRegistryContentClient pro správu imagí kontejneru a artefaktů. Příklad použití: import { ContainerRegistryContentClient } from "@azure/container-registry"; import { DefaultAzureCredential} from "@azure/identity"; const client = new ContainerRegistryContentClient( "<container registry API endpoint>", "<repository name>", new DefaultAzureCredential() );

Vlastnosti

endpoint	Koncový bod služby Azure Container Registry.
repositoryName	Název úložiště, které logicky seskupí části artefaktů.

Metody

deleteBlob(string, DeleteBlobOptions)	Odstranění objektu blob
deleteManifest(string, DeleteManifestOptions)	Odstranění manifestu Tím se efektivně odstraní artefakt z registru.
downloadBlob(string, DownloadBlobOptions)	Stáhněte objekt blob, který je součástí artefaktu.
getManifest(string, GetManifestOptions)	Stáhne manifest pro artefakt OCI.
setManifest(Buffer | ReadableStream | OciImageManifest | Record<string, unknown>, SetManifestOptions)	Nahrajte manifest pro artefakt OCI.
uploadBlob(Buffer | ReadableStream, UploadBlobOptions)	Nahrajte objekt blob artefaktu.

Podrobnosti konstruktoru

ContainerRegistryContentClient(string, string, TokenCredential, ContainerRegistryContentClientOptions)

Vytvoří instanci ContainerRegistryContentClient pro správu imagí kontejneru a artefaktů.

Příklad použití:

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

koncový bod adresy URL registru kontejneru

repositoryName

string

název úložiště, které logicky seskupuje části artefaktů

credential

TokenCredential

slouží k ověřování požadavků na službu.

options

ContainerRegistryContentClientOptions

volitelná konfigurace použitá k odesílání požadavků do služby

Podrobnosti vlastnosti

endpoint

Koncový bod služby Azure Container Registry.

endpoint: string

Hodnota vlastnosti

string

repositoryName

Název úložiště, které logicky seskupí části artefaktů.

repositoryName: string

Hodnota vlastnosti

string

Podrobnosti metody

deleteBlob(string, DeleteBlobOptions)

Odstranění objektu blob

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

Parametry

digest

string

hodnota hash objektu blob k odstranění

options

DeleteBlobOptions

volitelná konfigurace použitá k odesílání požadavků do služby

Návraty

Promise<void>

deleteManifest(string, DeleteManifestOptions)

Odstranění manifestu Tím se efektivně odstraní artefakt z registru.

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

Parametry

digest

string

přehled manifestu, který se má odstranit

options

DeleteManifestOptions

volitelná konfigurace použitá k odesílání požadavků do služby

Návraty

Promise<void>

downloadBlob(string, DownloadBlobOptions)

Stáhněte objekt blob, který je součástí artefaktu.

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

Parametry

digest

string

hodnota hash objektu blob ke stažení

options

DownloadBlobOptions

volitelná konfigurace použitá k odesílání požadavků do služby

Návraty

Promise<DownloadBlobResult>

• stažený objekt blob

getManifest(string, GetManifestOptions)

Stáhne manifest pro artefakt OCI.

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

Parametry

tagOrDigest

string

značka nebo hodnota hash, která identifikuje artefakt

options

GetManifestOptions

Návraty

Promise<GetManifestResult>

• stažený manifest.

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

Nahrajte manifest pro artefakt OCI.

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

Parametry

manifest

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

manifest k nahrání.

options

SetManifestOptions

Návraty

Promise<SetManifestResult>

uploadBlob(Buffer | ReadableStream, UploadBlobOptions)

Nahrajte objekt blob artefaktu.

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

Parametry

blob

Buffer | ReadableStream

options

UploadBlobOptions

Návraty

Promise<UploadBlobResult>