BlobContainerClient.GetBlobs 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 GetBlobs(BlobTraits, BlobStates, String, 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.BlobTraits traits = Azure.Storage.Blobs.Models.BlobTraits.None, Azure.Storage.Blobs.Models.BlobStates states = Azure.Storage.Blobs.Models.BlobStates.None, string prefix = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetBlobs : Azure.Storage.Blobs.Models.BlobTraits * Azure.Storage.Blobs.Models.BlobStates * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Blobs.Models.BlobItem>
override this.GetBlobs : Azure.Storage.Blobs.Models.BlobTraits * Azure.Storage.Blobs.Models.BlobStates * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Blobs.Models.BlobItem>
Public Overridable Function GetBlobs (Optional traits As BlobTraits = Azure.Storage.Blobs.Models.BlobTraits.None, Optional states As BlobStates = Azure.Storage.Blobs.Models.BlobStates.None, Optional prefix As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of BlobItem)
Parameters
- traits
- BlobTraits
Specifies trait options for shaping the blobs.
- states
- BlobStates
Specifies state options for filtering the blobs.
- prefix
- String
Specifies a string that filters the results to return only blobs
whose name begins with the specified prefix
.
- 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.