BlobServiceClient.FindBlobsByTagsAsync(String, CancellationToken) 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 Filter Blobs operation enables callers to list blobs across all containers whose tags match a given search expression. Filter blobs searches across all containers within a storage account but can be scoped within the expression to a single container.
For more information, see Find Blobs by Tags.
public virtual Azure.AsyncPageable<Azure.Storage.Blobs.Models.TaggedBlobItem> FindBlobsByTagsAsync (string tagFilterSqlExpression, System.Threading.CancellationToken cancellationToken = default);
abstract member FindBlobsByTagsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Blobs.Models.TaggedBlobItem>
override this.FindBlobsByTagsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Blobs.Models.TaggedBlobItem>
Public Overridable Function FindBlobsByTagsAsync (tagFilterSqlExpression As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of TaggedBlobItem)
Parameters
- tagFilterSqlExpression
- String
The where parameter finds blobs in the storage account whose tags match a given expression. The expression must evaluate to true for a blob to be returned in the result set. The storage service supports a subset of the ANSI SQL WHERE clause grammar for the value of the where=expression query parameter. The following operators are supported: =, >, >=, <, <=, AND. and @container. Example expression: "tagKey"='tagValue'.
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be cancelled.
Returns
An AsyncPageable<T> describing the blobs.
Remarks
A RequestFailedException will be thrown if a failure occurs.