QueryRequestOptions interface

Package:

@azure/arm-resourcegraph

The options for query evaluation

Properties

allowPartialScopes	Only applicable for tenant and management group level queries to decide whether to allow partial scopes for result in case the number of subscriptions exceed allowed limits. Default value: false.
resultFormat	Defines in which format query result returned. Possible values include: 'table', 'objectArray'. Default value: 'objectArray'.
skip	The number of rows to skip from the beginning of the results. Overrides the next page offset when $skipToken property is present.
skipToken	Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.
top	The maximum number of rows that the query should return. Overrides the page size when $skipToken property is present.

Property Details

allowPartialScopes

Only applicable for tenant and management group level queries to decide whether to allow partial scopes for result in case the number of subscriptions exceed allowed limits. Default value: false.

allowPartialScopes?: boolean

Property Value

boolean

resultFormat

Defines in which format query result returned. Possible values include: 'table', 'objectArray'. Default value: 'objectArray'.

resultFormat?: ResultFormat

Property Value

ResultFormat

skip

The number of rows to skip from the beginning of the results. Overrides the next page offset when $skipToken property is present.

skip?: number

Property Value

number

skipToken

Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.

skipToken?: string

Property Value

string

top

The maximum number of rows that the query should return. Overrides the page size when $skipToken property is present.

top?: number

Property Value

number