Share via

QueryOptions interface

  • Reference
Package:
@azure/arm-policyinsights

Parameter group

Properties

apply

OData apply expression for aggregations.
expand

The $expand query parameter. For example, to expand components use $expand=components
filter

OData filter expression.
from

ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day).
orderBy

Ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc".
select

Select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId".
skipToken

Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element.
to

ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time.
top

Maximum number of records to return.

Property Details

apply

OData apply expression for aggregations.

apply?: string

Property Value

string

expand

The $expand query parameter. For example, to expand components use $expand=components

expand?: string

Property Value

string

filter

OData filter expression.

filter?: string

Property Value

string

from

ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day).

from?: Date

Property Value

Date

orderBy

Ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc".

orderBy?: string

Property Value

string

select

Select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId".

select?: string

Property Value

string

skipToken

Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element.

skipToken?: string

Property Value

string

to

ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time.

to?: Date

Property Value

Date

top

Maximum number of records to return.

top?: number

Property Value

number