internal/functions/other/New-EntraFilterBuilder.ps1
|
function New-EntraFilterBuilder { <# .SYNOPSIS Creates a new OData-Filter construction helper. .DESCRIPTION Creates a new OData-Filter construction helper. This helper class was designed to simplify the creation of OData filters for APIs such as the Microsoft Graph API. Call the ".Add(...)" method to specify filter conditions. There are three ways to do so: A) .Add(property, operator, value) A single property comparison, with a specific operator and value. B) .Add(customFilter) A custom piece of OData filter text. C) .Add(filterbuilder) The output of another filterbuilder becomes part of the conditions for this one. This allows building complex, nested filter statements. Finally, call ".Get()" to retrieve the full OData filter string or ".GetHeader()" to retrieve the filter header hashtable. For more in-depth help with the type, call the '.GetHelp()' method on the object. Useful Resources: List of valid filter conditions: https://learn.microsoft.com/en-us/graph/filter-query-parameter?tabs=http#operators-and-functions-supported-in-filter-expressions .PARAMETER Logic The logic by which individual filter conditions are merged. Options: - AND (default) - OR .EXAMPLE PS C:\> $filter = New-EntraFilterBuilder PS C:\> $filter.Add('displayName', 'eq', 'John Doe') PS C:\> $filter.Add('organization', 'in', @('Contoso', 'Fabrikam')) PS C:\> $filter.Get() Will return: "displayName eq 'John Doe' and organization in ('Contoso', 'Fabrikam')" #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "", Justification = 'Returns a filter-builder object. The New verb names what it produces; nothing local or remote is changed, so there is nothing to confirm.')] #%UNCOMMENT%[OutputType([FilterBuilder])] [CmdletBinding()] param ( [ValidateSet('AND','OR')] [string] $Logic = 'AND' ) process { [FilterBuilder]::new($Logic) } } |