BlobContainerClient.GetBlobsByHierarchyAsync Method
Definition
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 GetBlobsByHierarchy(GetBlobsByHierarchyOptions, CancellationToken) operation returns an async collection 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. A Delimiter can be used to traverse a virtual hierarchy of blobs as though it were a file system.
For more information, see List Blobs.
public virtual Azure.AsyncPageable<Azure.Storage.Blobs.Models.BlobHierarchyItem> GetBlobsByHierarchyAsync(Azure.Storage.Blobs.Models.GetBlobsByHierarchyOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetBlobsByHierarchyAsync : Azure.Storage.Blobs.Models.GetBlobsByHierarchyOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Blobs.Models.BlobHierarchyItem>
override this.GetBlobsByHierarchyAsync : Azure.Storage.Blobs.Models.GetBlobsByHierarchyOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Blobs.Models.BlobHierarchyItem>Public Overridable Function GetBlobsByHierarchyAsync (Optional options As GetBlobsByHierarchyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of BlobHierarchyItem)Parameters
- options
- GetBlobsByHierarchyOptions
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.
