Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ContainerRegistryBlobClient

Package version

The Azure Container Registry blob client, responsible for uploading and downloading blobs and manifests, the building blocks of artifacts.

Hierarchy

  • ContainerRegistryBlobClient

Index

Constructors

constructor

  • Creates an instance of a ContainerRegistryBlobClient for managing container images and artifacts.

    Example usage:

    import { ContainerRegistryBlobClient } from "@azure/container-registry";
    import { DefaultAzureCredential} from "@azure/identity";
    
    const client = new ContainerRegistryBlobClient(
       "<container registry API endpoint>",
       "<repository name>",
       new DefaultAzureCredential()
    );

    Parameters

    • endpoint: string

      the URL endpoint of the container registry

    • repositoryName: string

      the name of the repository that logically groups the artifact parts

    • credential: TokenCredential

      used to authenticate requests to the service

    • options: ContainerRegistryBlobClientOptions

      optional configuration used to send requests to the service

    Returns ContainerRegistryBlobClient

Properties

endpoint

endpoint: string

The Azure Container Registry endpoint.

repositoryName

repositoryName: string

The name of the repository that logically groups the artifact parts.

Methods

deleteBlob

deleteManifest

downloadBlob

downloadManifest

uploadBlob

  • uploadBlob(blobStreamFactory: () => NodeJS.ReadableStream): Promise<UploadBlobResult>
  • uploadBlob(blobStream: NodeJS.ReadableStream): Promise<UploadBlobResult>

uploadManifest

Generated using TypeDoc