Share via


BlobContainerClient.GetBlobs(GetBlobsOptions, CancellationToken) Method

Definition

The GetBlobs(GetBlobsOptions, CancellationToken) operation returns an async sequence of blobs in this container. Enumerating the blobs may make multiple requests to the service while fetching all the values. Blobs are ordered lexicographically by name.

For more information, see List Blobs.

public virtual Azure.Pageable<Azure.Storage.Blobs.Models.BlobItem> GetBlobs(Azure.Storage.Blobs.Models.GetBlobsOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetBlobs : Azure.Storage.Blobs.Models.GetBlobsOptions * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Blobs.Models.BlobItem>
override this.GetBlobs : Azure.Storage.Blobs.Models.GetBlobsOptions * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Blobs.Models.BlobItem>
Public Overridable Function GetBlobs (Optional options As GetBlobsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of BlobItem)

Parameters

options
GetBlobsOptions

Optional parameters.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

An Pageable<T> of BlobItem describing the blobs in the container.

Remarks

A RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an AggregateException will be thrown, containing each failure instance.

Applies to