TableServiceClient.Query Method

Definition

Namespace:

Azure.Data.Tables

Assembly:

Azure.Data.Tables.dll

Package:

Azure.Data.Tables v12.9.1

Overloads

Query(FormattableString, Nullable<Int32>, CancellationToken)	Gets a list of tables from the storage account.
Query(Expression<Func<TableItem,Boolean>>, Nullable<Int32>, CancellationToken)	Gets a list of tables from the storage account.
Query(String, Nullable<Int32>, CancellationToken)	Gets a list of tables from the storage account.

Query(FormattableString, Nullable<Int32>, CancellationToken)

Source:

TableServiceClient.cs

Gets a list of tables from the storage account.

public virtual Azure.Pageable<Azure.Data.Tables.Models.TableItem> Query (FormattableString filter, int? maxPerPage = default, System.Threading.CancellationToken cancellationToken = default);

abstract member Query : FormattableString * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Data.Tables.Models.TableItem>
override this.Query : FormattableString * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Data.Tables.Models.TableItem>

Public Overridable Function Query (filter As FormattableString, Optional maxPerPage As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of TableItem)

Parameters

filter

FormattableString

Returns only tables that satisfy the specified filter expression. For example, the following would filter tables with a Name of 'foo': "TableName eq {someStringVariable}". The filter string will be properly quoted and escaped.

maxPerPage

Nullable<Int32>

The maximum number of entities that will be returned per page. Note: This value does not limit the total number of results if the result is fully enumerated.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Pageable<TableItem>

An Pageable<T> containing a collection of TableItem.

Exceptions

RequestFailedException

The server returned an error. See Message for details returned from the server.

Query(Expression<Func<TableItem,Boolean>>, Nullable<Int32>, CancellationToken)

Source:

TableServiceClient.cs

Gets a list of tables from the storage account.

public virtual Azure.Pageable<Azure.Data.Tables.Models.TableItem> Query (System.Linq.Expressions.Expression<Func<Azure.Data.Tables.Models.TableItem,bool>> filter, int? maxPerPage = default, System.Threading.CancellationToken cancellationToken = default);

abstract member Query : System.Linq.Expressions.Expression<Func<Azure.Data.Tables.Models.TableItem, bool>> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Data.Tables.Models.TableItem>
override this.Query : System.Linq.Expressions.Expression<Func<Azure.Data.Tables.Models.TableItem, bool>> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Data.Tables.Models.TableItem>

Public Overridable Function Query (filter As Expression(Of Func(Of TableItem, Boolean)), Optional maxPerPage As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of TableItem)

Parameters

filter

Expression<Func<TableItem,Boolean>>

Returns only tables that satisfy the specified filter expression. For example, the following expression would filter tables with a Name of 'foo': e => e.Name == "foo".

maxPerPage

Nullable<Int32>

The maximum number of entities that will be returned per page. Note: This value does not limit the total number of results if the result is fully enumerated.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Pageable<TableItem>

An Pageable<T> containing a collection of TableItem.

Exceptions

RequestFailedException

The server returned an error. See Message for details returned from the server.

Query(String, Nullable<Int32>, CancellationToken)

Source:

TableServiceClient.cs

Gets a list of tables from the storage account.

public virtual Azure.Pageable<Azure.Data.Tables.Models.TableItem> Query (string filter = default, int? maxPerPage = default, System.Threading.CancellationToken cancellationToken = default);

abstract member Query : string * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Data.Tables.Models.TableItem>
override this.Query : string * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Data.Tables.Models.TableItem>

Public Overridable Function Query (Optional filter As String = Nothing, Optional maxPerPage As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of TableItem)

Parameters

filter

String

Returns only tables that satisfy the specified filter. For example, the following would filter tables with a Name of 'foo': "TableName eq 'foo'".

maxPerPage

Nullable<Int32>

The maximum number tables that will be returned per page. Note: This value does not limit the total number of results if the result is fully enumerated.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Pageable<TableItem>

An Pageable<T> containing a collection of TableItem.