BlobServiceClient.FindBlobsByTags(String, CancellationToken) Method

Definition

Namespace:

Azure.Storage.Blobs

Assembly:

Azure.Storage.Blobs.dll

Package:

Azure.Storage.Blobs v12.23.0

Source:

BlobServiceClient.cs

The Filter Blobs operation enables callers to list blobs across all containers whose tags match a given search expression and only the tags appearing in the expression will be returned. 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.Pageable<Azure.Storage.Blobs.Models.TaggedBlobItem> FindBlobsByTags (string tagFilterSqlExpression, System.Threading.CancellationToken cancellationToken = default);

abstract member FindBlobsByTags : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Blobs.Models.TaggedBlobItem>
override this.FindBlobsByTags : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Blobs.Models.TaggedBlobItem>

Public Overridable Function FindBlobsByTags (tagFilterSqlExpression As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(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

Pageable<TaggedBlobItem>

An AsyncPageable<T> describing the blobs.

Remarks

A RequestFailedException will be thrown if a failure occurs.