QueryRequestOptions Class

The options for query evaluation.

Constructor

QueryRequestOptions(*, skip_token: str | None = None, top: int | None = None, skip: int | None = None, result_format: str | _models.ResultFormat | None = None, allow_partial_scopes: bool = False, authorization_scope_filter: str | _models.AuthorizationScopeFilter = 'AtScopeAndBelow', **kwargs)

Keyword-Only Parameters

Name	Description
skip_token	str Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. Default value: None
top	int The maximum number of rows that the query should return. Overrides the page size when $skipToken property is present. Default value: None
skip	int The number of rows to skip from the beginning of the results. Overrides the next page offset when $skipToken property is present. Default value: None
result_format	str or ResultFormat Defines in which format query result returned. Known values are: "table" and "objectArray". Default value: None
allow_partial_scopes	bool 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
authorization_scope_filter	str or AuthorizationScopeFilter Defines what level of authorization resources should be returned based on the which subscriptions and management groups are passed as scopes. Known values are: "AtScopeAndBelow", "AtScopeAndAbove", "AtScopeExact", and "AtScopeAboveAndBelow". Default value: AtScopeAndBelow

Variables

Name	Description
skip_token	str Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.
top	int The maximum number of rows that the query should return. Overrides the page size when $skipToken property is present.
skip	int The number of rows to skip from the beginning of the results. Overrides the next page offset when $skipToken property is present.
result_format	str or ResultFormat Defines in which format query result returned. Known values are: "table" and "objectArray".
allow_partial_scopes	bool 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.
authorization_scope_filter	str or AuthorizationScopeFilter Defines what level of authorization resources should be returned based on the which subscriptions and management groups are passed as scopes. Known values are: "AtScopeAndBelow", "AtScopeAndAbove", "AtScopeExact", and "AtScopeAboveAndBelow".