Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

BlobContainerClient.GetBlobsAsync(GetBlobsOptions, CancellationToken) Method

Definition

Namespace:
Azure.Storage.Blobs
Assembly:
Azure.Storage.Blobs.dll
Package:
Azure.Storage.Blobs v12.29.0
Package:
Azure.Storage.Blobs v12.29.0-beta.1
Source:
BlobContainerClient.cs
Source:
BlobContainerClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The GetBlobsAsync(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.AsyncPageable<Azure.Storage.Blobs.Models.BlobItem> GetBlobsAsync(Azure.Storage.Blobs.Models.GetBlobsOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetBlobsAsync : Azure.Storage.Blobs.Models.GetBlobsOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Blobs.Models.BlobItem>
override this.GetBlobsAsync : Azure.Storage.Blobs.Models.GetBlobsOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Blobs.Models.BlobItem>
Public Overridable Function GetBlobsAsync (Optional options As GetBlobsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of BlobItem)

Parameters

options
GetBlobsOptions

Optional parameters.

cancellationToken
CancellationToken

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

Returns

An AsyncPageable<T> 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

Feedback

Was this page helpful?