-
Notifications
You must be signed in to change notification settings - Fork 180
/
ResourceGraphModels.QueryRequestOptions.yml
97 lines (91 loc) · 2.8 KB
/
ResourceGraphModels.QueryRequestOptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
### YamlMime:TSType
name: QueryRequestOptions
uid: '@azure/arm-resourcegraph.ResourceGraphModels.QueryRequestOptions'
package: '@azure/arm-resourcegraph'
summary: The options for query evaluation
fullName: QueryRequestOptions
remarks: ''
isDeprecated: false
type: interface
properties:
- name: allowPartialScopes
uid: >-
@azure/arm-resourcegraph.ResourceGraphModels.QueryRequestOptions.allowPartialScopes
package: '@azure/arm-resourcegraph'
summary: >-
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.
fullName: allowPartialScopes
remarks: ''
isDeprecated: false
syntax:
content: 'allowPartialScopes?: boolean'
return:
description: ''
type: boolean
- name: resultFormat
uid: >-
@azure/arm-resourcegraph.ResourceGraphModels.QueryRequestOptions.resultFormat
package: '@azure/arm-resourcegraph'
summary: >-
Defines in which format query result returned. Possible values include:
'table',
'objectArray'. Default value: 'objectArray'.
fullName: resultFormat
remarks: ''
isDeprecated: false
syntax:
content: 'resultFormat?: ResultFormat'
return:
description: ''
type: >-
<xref uid="@azure/arm-resourcegraph.ResourceGraphModels.ResultFormat"
/>
- name: skip
uid: '@azure/arm-resourcegraph.ResourceGraphModels.QueryRequestOptions.skip'
package: '@azure/arm-resourcegraph'
summary: >-
The number of rows to skip from the beginning of the results. Overrides
the next page offset
when ```$skipToken``` property is present.
fullName: skip
remarks: ''
isDeprecated: false
syntax:
content: 'skip?: number'
return:
description: ''
type: number
- name: skipToken
uid: '@azure/arm-resourcegraph.ResourceGraphModels.QueryRequestOptions.skipToken'
package: '@azure/arm-resourcegraph'
summary: >-
Continuation token for pagination, capturing the next page size and
offset, as well as the
context of the query.
fullName: skipToken
remarks: ''
isDeprecated: false
syntax:
content: 'skipToken?: string'
return:
description: ''
type: string
- name: top
uid: '@azure/arm-resourcegraph.ResourceGraphModels.QueryRequestOptions.top'
package: '@azure/arm-resourcegraph'
summary: >-
The maximum number of rows that the query should return. Overrides the
page size when
```$skipToken``` property is present.
fullName: top
remarks: ''
isDeprecated: false
syntax:
content: 'top?: number'
return:
description: ''
type: number