ContainerRegistryContentClient.DownloadBlobToAsync Method

Definition

Namespace:

Azure.Containers.ContainerRegistry

Assembly:

Azure.Containers.ContainerRegistry.dll

Package:

Azure.Containers.ContainerRegistry v1.1.1

Overloads

DownloadBlobToAsync(String, Stream, CancellationToken)	Download a blob to a passed-in destination stream. This approach will download the blob to the destination stream in sequential chunks of bytes.
DownloadBlobToAsync(String, String, CancellationToken)	Download a blob to a file specified by the path parameter.

DownloadBlobToAsync(String, Stream, CancellationToken)

Source:

ContainerRegistryContentClient.cs

Download a blob to a passed-in destination stream. This approach will download the blob to the destination stream in sequential chunks of bytes.

public virtual System.Threading.Tasks.Task<Azure.Response> DownloadBlobToAsync (string digest, System.IO.Stream destination, System.Threading.CancellationToken cancellationToken = default);

abstract member DownloadBlobToAsync : string * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DownloadBlobToAsync : string * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DownloadBlobToAsync (digest As String, destination As Stream, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

digest

String

The digest of the blob to download.

destination

Stream

Destination for the downloaded blob.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response>

The raw response corresponding to the final GET blob chunk request.

Exceptions

ArgumentNullException

If destination is null.

RequestFailedException

Thrown when a failure is returned by the Container Registry service.

DownloadBlobToAsync(String, String, CancellationToken)

Source:

ContainerRegistryContentClient.cs

Download a blob to a file specified by the path parameter.

public virtual System.Threading.Tasks.Task<Azure.Response> DownloadBlobToAsync (string digest, string path, System.Threading.CancellationToken cancellationToken = default);

abstract member DownloadBlobToAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DownloadBlobToAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DownloadBlobToAsync (digest As String, path As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

digest

String

The digest of the blob to download.

path

String

A file path to write the downloaded content to.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response>

The raw response corresponding to the final GET blob chunk request.

Exceptions

ArgumentNullException

If path is null.

RequestFailedException

Thrown when a failure is returned by the Container Registry service.