Share via


ODATADetailLevel.FilterClause Property

Definition

Gets or sets the OData filter clause. Used to restrict a list operation to items that match specified criteria.

public string FilterClause { get; set; }
member this.FilterClause : string with get, set
Public Property FilterClause As String

Property Value

Remarks

This is an optional OData $filter expression string (see the OData specification). For example, you can restrict a ListPools(DetailLevel, IEnumerable<BatchClientBehavior>) operation to return only active pools with the expression state eq 'active'.

Filters must be specified using REST API attribute names, not .NET property names.

The default is no filter expression, which means all resources are returned.

Applies to