@azure/arm-resourcegraph 5.0.0-beta.3 → 5.0.0-beta.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (215) hide show
  1. package/CHANGELOG.md +12 -2
  2. package/LICENSE +4 -4
  3. package/README.md +26 -17
  4. package/dist/browser/index.d.ts +5 -0
  5. package/dist/browser/index.d.ts.map +1 -0
  6. package/{dist-esm/src → dist/browser}/index.js +4 -4
  7. package/dist/browser/index.js.map +1 -0
  8. package/{dist-esm/src → dist/browser}/models/index.d.ts +9 -9
  9. package/dist/browser/models/index.d.ts.map +1 -0
  10. package/dist/browser/models/index.js.map +1 -0
  11. package/{dist-esm/src → dist/browser}/models/mappers.js +14 -6
  12. package/dist/browser/models/mappers.js.map +1 -0
  13. package/{dist-esm/src → dist/browser}/models/parameters.js +1 -1
  14. package/dist/browser/models/parameters.js.map +1 -0
  15. package/dist/browser/operations/index.d.ts +2 -0
  16. package/{dist-esm/src → dist/browser}/operations/index.d.ts.map +1 -1
  17. package/{dist-esm/src → dist/browser}/operations/index.js +1 -1
  18. package/dist/browser/operations/index.js.map +1 -0
  19. package/{dist-esm/src → dist/browser}/operations/operations.d.ts +3 -3
  20. package/dist/browser/operations/operations.d.ts.map +1 -0
  21. package/{dist-esm/src → dist/browser}/operations/operations.js +12 -27
  22. package/dist/browser/operations/operations.js.map +1 -0
  23. package/dist/browser/operationsInterfaces/index.d.ts +2 -0
  24. package/{dist-esm/src → dist/browser}/operationsInterfaces/index.d.ts.map +1 -1
  25. package/{dist-esm/src → dist/browser}/operationsInterfaces/index.js +1 -1
  26. package/dist/browser/operationsInterfaces/index.js.map +1 -0
  27. package/{dist-esm/src → dist/browser}/operationsInterfaces/operations.d.ts +1 -1
  28. package/{dist-esm/src → dist/browser}/operationsInterfaces/operations.d.ts.map +1 -1
  29. package/dist/browser/operationsInterfaces/operations.js.map +1 -0
  30. package/dist/browser/package.json +3 -0
  31. package/{dist-esm/src → dist/browser}/pagingHelper.js +2 -4
  32. package/dist/browser/pagingHelper.js.map +1 -0
  33. package/{dist-esm/src → dist/browser}/resourceGraphClient.d.ts +2 -2
  34. package/dist/browser/resourceGraphClient.d.ts.map +1 -0
  35. package/{dist-esm/src → dist/browser}/resourceGraphClient.js +31 -26
  36. package/dist/browser/resourceGraphClient.js.map +1 -0
  37. package/dist/commonjs/index.d.ts +5 -0
  38. package/dist/commonjs/index.d.ts.map +1 -0
  39. package/dist/commonjs/index.js +19 -0
  40. package/dist/commonjs/index.js.map +1 -0
  41. package/{types/arm-resourcegraph.d.ts → dist/commonjs/models/index.d.ts} +216 -295
  42. package/dist/commonjs/models/index.d.ts.map +1 -0
  43. package/dist/commonjs/models/index.js +10 -0
  44. package/dist/commonjs/models/index.js.map +1 -0
  45. package/dist/commonjs/models/mappers.d.ts +26 -0
  46. package/dist/commonjs/models/mappers.d.ts.map +1 -0
  47. package/dist/commonjs/models/mappers.js +666 -0
  48. package/dist/commonjs/models/mappers.js.map +1 -0
  49. package/dist/commonjs/models/parameters.d.ts +8 -0
  50. package/dist/commonjs/models/parameters.d.ts.map +1 -0
  51. package/dist/commonjs/models/parameters.js +64 -0
  52. package/dist/commonjs/models/parameters.js.map +1 -0
  53. package/dist/commonjs/operations/index.d.ts +2 -0
  54. package/dist/commonjs/operations/index.d.ts.map +1 -0
  55. package/dist/commonjs/operations/index.js +12 -0
  56. package/dist/commonjs/operations/index.js.map +1 -0
  57. package/dist/commonjs/operations/operations.d.ts +26 -0
  58. package/dist/commonjs/operations/operations.d.ts.map +1 -0
  59. package/dist/commonjs/operations/operations.js +84 -0
  60. package/dist/commonjs/operations/operations.js.map +1 -0
  61. package/dist/commonjs/operationsInterfaces/index.d.ts +2 -0
  62. package/dist/commonjs/operationsInterfaces/index.d.ts.map +1 -0
  63. package/dist/commonjs/operationsInterfaces/index.js +12 -0
  64. package/dist/commonjs/operationsInterfaces/index.js.map +1 -0
  65. package/dist/commonjs/operationsInterfaces/operations.d.ts +11 -0
  66. package/dist/commonjs/operationsInterfaces/operations.d.ts.map +1 -0
  67. package/dist/commonjs/operationsInterfaces/operations.js +10 -0
  68. package/dist/commonjs/operationsInterfaces/operations.js.map +1 -0
  69. package/dist/commonjs/package.json +3 -0
  70. package/dist/commonjs/pagingHelper.d.ts +13 -0
  71. package/dist/commonjs/pagingHelper.d.ts.map +1 -0
  72. package/dist/commonjs/pagingHelper.js +34 -0
  73. package/dist/commonjs/pagingHelper.js.map +1 -0
  74. package/dist/commonjs/resourceGraphClient.d.ts +30 -0
  75. package/dist/commonjs/resourceGraphClient.d.ts.map +1 -0
  76. package/dist/commonjs/resourceGraphClient.js +162 -0
  77. package/dist/commonjs/resourceGraphClient.js.map +1 -0
  78. package/{types → dist/commonjs}/tsdoc-metadata.json +11 -11
  79. package/dist/esm/index.d.ts +5 -0
  80. package/dist/esm/index.d.ts.map +1 -0
  81. package/{src/index.ts → dist/esm/index.js} +5 -5
  82. package/dist/esm/index.js.map +1 -0
  83. package/dist/esm/models/index.d.ts +216 -0
  84. package/dist/esm/models/index.d.ts.map +1 -0
  85. package/{src/operations/index.ts → dist/esm/models/index.js} +2 -2
  86. package/dist/esm/models/index.js.map +1 -0
  87. package/dist/esm/models/mappers.d.ts +26 -0
  88. package/dist/esm/models/mappers.d.ts.map +1 -0
  89. package/dist/{index.js → esm/models/mappers.js} +35 -402
  90. package/dist/esm/models/mappers.js.map +1 -0
  91. package/dist/esm/models/parameters.d.ts +8 -0
  92. package/dist/esm/models/parameters.d.ts.map +1 -0
  93. package/dist/esm/models/parameters.js +61 -0
  94. package/dist/esm/models/parameters.js.map +1 -0
  95. package/dist/esm/operations/index.d.ts +2 -0
  96. package/dist/esm/operations/index.d.ts.map +1 -0
  97. package/dist/esm/operations/index.js +9 -0
  98. package/dist/esm/operations/index.js.map +1 -0
  99. package/dist/esm/operations/operations.d.ts +26 -0
  100. package/dist/esm/operations/operations.d.ts.map +1 -0
  101. package/dist/esm/operations/operations.js +79 -0
  102. package/dist/esm/operations/operations.js.map +1 -0
  103. package/dist/esm/operationsInterfaces/index.d.ts +2 -0
  104. package/dist/esm/operationsInterfaces/index.d.ts.map +1 -0
  105. package/dist/esm/operationsInterfaces/index.js +9 -0
  106. package/dist/esm/operationsInterfaces/index.js.map +1 -0
  107. package/dist/esm/operationsInterfaces/operations.d.ts +11 -0
  108. package/dist/esm/operationsInterfaces/operations.d.ts.map +1 -0
  109. package/dist/esm/operationsInterfaces/operations.js +9 -0
  110. package/dist/esm/operationsInterfaces/operations.js.map +1 -0
  111. package/dist/esm/package.json +3 -0
  112. package/dist/esm/pagingHelper.d.ts +13 -0
  113. package/dist/esm/pagingHelper.d.ts.map +1 -0
  114. package/dist/esm/pagingHelper.js +30 -0
  115. package/dist/esm/pagingHelper.js.map +1 -0
  116. package/dist/esm/resourceGraphClient.d.ts +30 -0
  117. package/dist/esm/resourceGraphClient.d.ts.map +1 -0
  118. package/dist/esm/resourceGraphClient.js +157 -0
  119. package/dist/esm/resourceGraphClient.js.map +1 -0
  120. package/dist/react-native/index.d.ts +5 -0
  121. package/dist/react-native/index.d.ts.map +1 -0
  122. package/dist/react-native/index.js +13 -0
  123. package/dist/react-native/index.js.map +1 -0
  124. package/dist/react-native/models/index.d.ts +216 -0
  125. package/dist/react-native/models/index.d.ts.map +1 -0
  126. package/{src/operationsInterfaces/index.ts → dist/react-native/models/index.js} +2 -2
  127. package/dist/react-native/models/index.js.map +1 -0
  128. package/dist/react-native/models/mappers.d.ts +26 -0
  129. package/dist/react-native/models/mappers.d.ts.map +1 -0
  130. package/dist/react-native/models/mappers.js +663 -0
  131. package/dist/react-native/models/mappers.js.map +1 -0
  132. package/dist/react-native/models/parameters.d.ts +8 -0
  133. package/dist/react-native/models/parameters.d.ts.map +1 -0
  134. package/dist/react-native/models/parameters.js +61 -0
  135. package/dist/react-native/models/parameters.js.map +1 -0
  136. package/dist/react-native/operations/index.d.ts +2 -0
  137. package/dist/react-native/operations/index.d.ts.map +1 -0
  138. package/dist/react-native/operations/index.js +9 -0
  139. package/dist/react-native/operations/index.js.map +1 -0
  140. package/dist/react-native/operations/operations.d.ts +26 -0
  141. package/dist/react-native/operations/operations.d.ts.map +1 -0
  142. package/dist/react-native/operations/operations.js +79 -0
  143. package/dist/react-native/operations/operations.js.map +1 -0
  144. package/dist/react-native/operationsInterfaces/index.d.ts +2 -0
  145. package/dist/react-native/operationsInterfaces/index.d.ts.map +1 -0
  146. package/dist/react-native/operationsInterfaces/index.js +9 -0
  147. package/dist/react-native/operationsInterfaces/index.js.map +1 -0
  148. package/dist/react-native/operationsInterfaces/operations.d.ts +11 -0
  149. package/dist/react-native/operationsInterfaces/operations.d.ts.map +1 -0
  150. package/dist/react-native/operationsInterfaces/operations.js +9 -0
  151. package/dist/react-native/operationsInterfaces/operations.js.map +1 -0
  152. package/dist/react-native/package.json +3 -0
  153. package/dist/react-native/pagingHelper.d.ts +13 -0
  154. package/dist/react-native/pagingHelper.d.ts.map +1 -0
  155. package/dist/react-native/pagingHelper.js +30 -0
  156. package/dist/react-native/pagingHelper.js.map +1 -0
  157. package/dist/react-native/resourceGraphClient.d.ts +30 -0
  158. package/dist/react-native/resourceGraphClient.d.ts.map +1 -0
  159. package/dist/react-native/resourceGraphClient.js +157 -0
  160. package/dist/react-native/resourceGraphClient.js.map +1 -0
  161. package/package.json +82 -71
  162. package/dist/index.js.map +0 -1
  163. package/dist/index.min.js +0 -1
  164. package/dist/index.min.js.map +0 -1
  165. package/dist-esm/samples-dev/operationsListSample.d.ts +0 -2
  166. package/dist-esm/samples-dev/operationsListSample.d.ts.map +0 -1
  167. package/dist-esm/samples-dev/operationsListSample.js +0 -42
  168. package/dist-esm/samples-dev/operationsListSample.js.map +0 -1
  169. package/dist-esm/samples-dev/resourcesHistorySample.d.ts +0 -2
  170. package/dist-esm/samples-dev/resourcesHistorySample.d.ts.map +0 -1
  171. package/dist-esm/samples-dev/resourcesHistorySample.js +0 -63
  172. package/dist-esm/samples-dev/resourcesHistorySample.js.map +0 -1
  173. package/dist-esm/samples-dev/resourcesSample.d.ts +0 -2
  174. package/dist-esm/samples-dev/resourcesSample.d.ts.map +0 -1
  175. package/dist-esm/samples-dev/resourcesSample.js +0 -245
  176. package/dist-esm/samples-dev/resourcesSample.js.map +0 -1
  177. package/dist-esm/src/index.d.ts +0 -6
  178. package/dist-esm/src/index.d.ts.map +0 -1
  179. package/dist-esm/src/index.js.map +0 -1
  180. package/dist-esm/src/models/index.d.ts.map +0 -1
  181. package/dist-esm/src/models/index.js.map +0 -1
  182. package/dist-esm/src/models/mappers.js.map +0 -1
  183. package/dist-esm/src/models/parameters.js.map +0 -1
  184. package/dist-esm/src/operations/index.d.ts +0 -2
  185. package/dist-esm/src/operations/index.js.map +0 -1
  186. package/dist-esm/src/operations/operations.d.ts.map +0 -1
  187. package/dist-esm/src/operations/operations.js.map +0 -1
  188. package/dist-esm/src/operationsInterfaces/index.d.ts +0 -2
  189. package/dist-esm/src/operationsInterfaces/index.js.map +0 -1
  190. package/dist-esm/src/operationsInterfaces/operations.js.map +0 -1
  191. package/dist-esm/src/pagingHelper.js.map +0 -1
  192. package/dist-esm/src/resourceGraphClient.d.ts.map +0 -1
  193. package/dist-esm/src/resourceGraphClient.js.map +0 -1
  194. package/dist-esm/test/sampleTest.d.ts +0 -2
  195. package/dist-esm/test/sampleTest.d.ts.map +0 -1
  196. package/dist-esm/test/sampleTest.js +0 -38
  197. package/dist-esm/test/sampleTest.js.map +0 -1
  198. package/rollup.config.js +0 -122
  199. package/src/models/index.ts +0 -261
  200. package/src/models/mappers.ts +0 -684
  201. package/src/models/parameters.ts +0 -75
  202. package/src/operations/operations.ts +0 -103
  203. package/src/operationsInterfaces/operations.ts +0 -22
  204. package/src/pagingHelper.ts +0 -39
  205. package/src/resourceGraphClient.ts +0 -213
  206. package/tsconfig.json +0 -33
  207. /package/{dist-esm/src → dist/browser}/models/index.js +0 -0
  208. /package/{dist-esm/src → dist/browser}/models/mappers.d.ts +0 -0
  209. /package/{dist-esm/src → dist/browser}/models/mappers.d.ts.map +0 -0
  210. /package/{dist-esm/src → dist/browser}/models/parameters.d.ts +0 -0
  211. /package/{dist-esm/src → dist/browser}/models/parameters.d.ts.map +0 -0
  212. /package/{dist-esm/src → dist/browser}/operationsInterfaces/operations.js +0 -0
  213. /package/{dist-esm/src → dist/browser}/pagingHelper.d.ts +0 -0
  214. /package/{dist-esm/src → dist/browser}/pagingHelper.d.ts.map +0 -0
  215. /package/review/{arm-resourcegraph.api.md → arm-resourcegraph-node.api.md} +0 -0
@@ -1,295 +1,216 @@
1
- import * as coreAuth from '@azure/core-auth';
2
- import * as coreClient from '@azure/core-client';
3
- import { PagedAsyncIterableIterator } from '@azure/core-paging';
4
-
5
- /** Defines values for AuthorizationScopeFilter. */
6
- export declare type AuthorizationScopeFilter = "AtScopeAndBelow" | "AtScopeAndAbove" | "AtScopeExact" | "AtScopeAboveAndBelow";
7
-
8
- /** Query result column descriptor. */
9
- export declare interface Column {
10
- /** Column name. */
11
- name: string;
12
- /** Column data type. */
13
- type: ColumnDataType;
14
- }
15
-
16
- /** Defines values for ColumnDataType. */
17
- export declare type ColumnDataType = "string" | "integer" | "number" | "boolean" | "object" | "datetime";
18
-
19
- /** An interval in time specifying the date and time for the inclusive start and exclusive end, i.e. `[start, end)`. */
20
- export declare interface DateTimeInterval {
21
- /** A datetime indicating the inclusive/closed start of the time interval, i.e. `[`**`start`**`, end)`. Specifying a `start` that occurs chronologically after `end` will result in an error. */
22
- start: Date;
23
- /** A datetime indicating the exclusive/open end of the time interval, i.e. `[start, `**`end`**`)`. Specifying an `end` that occurs chronologically before `start` will result in an error. */
24
- end: Date;
25
- }
26
-
27
- /** Error details. */
28
- export declare interface ErrorDetails {
29
- /** Describes unknown properties. The value of an unknown property can be of "any" type. */
30
- [property: string]: any;
31
- /** Error code identifying the specific error. */
32
- code: string;
33
- /** A human readable error message. */
34
- message: string;
35
- }
36
-
37
- /** Error details. */
38
- export declare interface ErrorModel {
39
- /** Error code identifying the specific error. */
40
- code: string;
41
- /** A human readable error message. */
42
- message: string;
43
- /** Error details */
44
- details?: ErrorDetails[];
45
- }
46
-
47
- /** An error response from the API. */
48
- export declare interface ErrorResponse {
49
- /** Error information. */
50
- error: ErrorModel;
51
- }
52
-
53
- /** A facet containing additional statistics on the response of a query. Can be either FacetResult or FacetError. */
54
- export declare interface Facet {
55
- /** Polymorphic discriminator, which specifies the different types this object can be */
56
- resultType: "FacetResult" | "FacetError";
57
- /** Facet expression, same as in the corresponding facet request. */
58
- expression: string;
59
- }
60
-
61
- /** A facet whose execution resulted in an error. */
62
- export declare interface FacetError extends Facet {
63
- /** Polymorphic discriminator, which specifies the different types this object can be */
64
- resultType: "FacetError";
65
- /** An array containing detected facet errors with details. */
66
- errors: ErrorDetails[];
67
- }
68
-
69
- /** A request to compute additional statistics (facets) over the query results. */
70
- export declare interface FacetRequest {
71
- /** The column or list of columns to summarize by */
72
- expression: string;
73
- /** The options for facet evaluation */
74
- options?: FacetRequestOptions;
75
- }
76
-
77
- /** The options for facet evaluation */
78
- export declare interface FacetRequestOptions {
79
- /** The column name or query expression to sort on. Defaults to count if not present. */
80
- sortBy?: string;
81
- /** The sorting order by the selected column (count by default). */
82
- sortOrder?: FacetSortOrder;
83
- /** Specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting. */
84
- filter?: string;
85
- /** The maximum number of facet rows that should be returned. */
86
- top?: number;
87
- }
88
-
89
- /** Successfully executed facet containing additional statistics on the response of a query. */
90
- export declare interface FacetResult extends Facet {
91
- /** Polymorphic discriminator, which specifies the different types this object can be */
92
- resultType: "FacetResult";
93
- /** Number of total records in the facet results. */
94
- totalRecords: number;
95
- /** Number of records returned in the facet response. */
96
- count: number;
97
- /** A JObject array or Table containing the desired facets. Only present if the facet is valid. */
98
- data: Record<string, unknown>;
99
- }
100
-
101
- /** Defines values for FacetSortOrder. */
102
- export declare type FacetSortOrder = "asc" | "desc";
103
-
104
- export declare type FacetUnion = Facet | FacetResult | FacetError;
105
-
106
- /**
107
- * Given the last `.value` produced by the `byPage` iterator,
108
- * returns a continuation token that can be used to begin paging from
109
- * that point later.
110
- * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
111
- * @returns The continuation token that can be passed into byPage() during future calls.
112
- */
113
- export declare function getContinuationToken(page: unknown): string | undefined;
114
-
115
- /** Resource Graph REST API operation definition. */
116
- export declare interface Operation {
117
- /** Operation name: {provider}/{resource}/{operation} */
118
- name?: string;
119
- /** Display metadata associated with the operation. */
120
- display?: OperationDisplay;
121
- /** The origin of operations. */
122
- origin?: string;
123
- }
124
-
125
- /** Display metadata associated with the operation. */
126
- export declare interface OperationDisplay {
127
- /** Service provider: Microsoft Resource Graph. */
128
- provider?: string;
129
- /** Resource on which the operation is performed etc. */
130
- resource?: string;
131
- /** Type of operation: get, read, delete, etc. */
132
- operation?: string;
133
- /** Description for the operation. */
134
- description?: string;
135
- }
136
-
137
- /** Result of the request to list Resource Graph operations. It contains a list of operations and a URL link to get the next set of results. */
138
- export declare interface OperationListResult {
139
- /** List of Resource Graph operations supported by the Resource Graph resource provider. */
140
- value?: Operation[];
141
- }
142
-
143
- /** Interface representing a Operations. */
144
- export declare interface Operations {
145
- /**
146
- * Lists all of the available REST API operations.
147
- * @param options The options parameters.
148
- */
149
- list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
150
- }
151
-
152
- /** Optional parameters. */
153
- export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
154
- }
155
-
156
- /** Contains response data for the list operation. */
157
- export declare type OperationsListResponse = OperationListResult;
158
-
159
- /** Describes a query to be executed. */
160
- export declare interface QueryRequest {
161
- /** Azure subscriptions against which to execute the query. */
162
- subscriptions?: string[];
163
- /** Azure management groups against which to execute the query. Example: [ 'mg1', 'mg2' ] */
164
- managementGroups?: string[];
165
- /** The resources query. */
166
- query: string;
167
- /** The query evaluation options */
168
- options?: QueryRequestOptions;
169
- /** An array of facet requests to be computed against the query result. */
170
- facets?: FacetRequest[];
171
- }
172
-
173
- /** The options for query evaluation */
174
- export declare interface QueryRequestOptions {
175
- /** Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. */
176
- skipToken?: string;
177
- /** The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present. */
178
- top?: number;
179
- /** The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present. */
180
- skip?: number;
181
- /** Defines in which format query result returned. */
182
- resultFormat?: ResultFormat;
183
- /** 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. */
184
- allowPartialScopes?: boolean;
185
- /** Defines what level of authorization resources should be returned based on the which subscriptions and management groups are passed as scopes. */
186
- authorizationScopeFilter?: AuthorizationScopeFilter;
187
- }
188
-
189
- /** Query result. */
190
- export declare interface QueryResponse {
191
- /** Number of total records matching the query. */
192
- totalRecords: number;
193
- /** Number of records returned in the current response. In the case of paging, this is the number of records in the current page. */
194
- count: number;
195
- /** Indicates whether the query results are truncated. */
196
- resultTruncated: ResultTruncated;
197
- /** When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. */
198
- skipToken?: string;
199
- /** Query output in JObject array or Table format. */
200
- data: Record<string, unknown>;
201
- /** Query facets. */
202
- facets?: FacetUnion[];
203
- }
204
-
205
- export declare class ResourceGraphClient extends coreClient.ServiceClient {
206
- $host: string;
207
- apiVersion: string;
208
- /**
209
- * Initializes a new instance of the ResourceGraphClient class.
210
- * @param credentials Subscription credentials which uniquely identify client subscription.
211
- * @param options The parameter options
212
- */
213
- constructor(credentials: coreAuth.TokenCredential, options?: ResourceGraphClientOptionalParams);
214
- /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
215
- private addCustomApiVersionPolicy;
216
- /**
217
- * Queries the resources managed by Azure Resource Manager for scopes specified in the request.
218
- * @param query Request specifying query and its options.
219
- * @param options The options parameters.
220
- */
221
- resources(query: QueryRequest, options?: ResourcesOptionalParams): Promise<ResourcesResponse>;
222
- /**
223
- * List all snapshots of a resource for a given time interval.
224
- * @param request Request specifying the query and its options.
225
- * @param options The options parameters.
226
- */
227
- resourcesHistory(request: ResourcesHistoryRequest, options?: ResourcesHistoryOptionalParams): Promise<ResourcesHistoryResponse>;
228
- operations: Operations;
229
- }
230
-
231
- /** Optional parameters. */
232
- export declare interface ResourceGraphClientOptionalParams extends coreClient.ServiceClientOptions {
233
- /** server parameter */
234
- $host?: string;
235
- /** Api Version */
236
- apiVersion?: string;
237
- /** Overrides client endpoint. */
238
- endpoint?: string;
239
- }
240
-
241
- /** Optional parameters. */
242
- export declare interface ResourcesHistoryOptionalParams extends coreClient.OperationOptions {
243
- }
244
-
245
- /** Describes a history request to be executed. */
246
- export declare interface ResourcesHistoryRequest {
247
- /** Azure subscriptions against which to execute the query. */
248
- subscriptions?: string[];
249
- /** The resources query. */
250
- query?: string;
251
- /** The history request evaluation options */
252
- options?: ResourcesHistoryRequestOptions;
253
- /** Azure management groups against which to execute the query. Example: [ 'mg1', 'mg2' ] */
254
- managementGroups?: string[];
255
- }
256
-
257
- /** The options for history request evaluation */
258
- export declare interface ResourcesHistoryRequestOptions {
259
- /** The time interval used to fetch history. */
260
- interval?: DateTimeInterval;
261
- /** The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present. */
262
- top?: number;
263
- /** The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present. */
264
- skip?: number;
265
- /** Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. */
266
- skipToken?: string;
267
- /** Defines in which format query result returned. */
268
- resultFormat?: ResultFormat;
269
- }
270
-
271
- /** Contains response data for the resourcesHistory operation. */
272
- export declare type ResourcesHistoryResponse = Record<string, unknown>;
273
-
274
- /** Optional parameters. */
275
- export declare interface ResourcesOptionalParams extends coreClient.OperationOptions {
276
- }
277
-
278
- /** Contains response data for the resources operation. */
279
- export declare type ResourcesResponse = QueryResponse;
280
-
281
- /** Defines values for ResultFormat. */
282
- export declare type ResultFormat = "table" | "objectArray";
283
-
284
- /** Defines values for ResultTruncated. */
285
- export declare type ResultTruncated = "true" | "false";
286
-
287
- /** Query output in tabular format. */
288
- export declare interface Table {
289
- /** Query result column descriptors. */
290
- columns: Column[];
291
- /** Query result rows. */
292
- rows: Record<string, unknown>[][];
293
- }
294
-
295
- export { }
1
+ import * as coreClient from "@azure/core-client";
2
+ export type FacetUnion = Facet | FacetResult | FacetError;
3
+ /** Describes a query to be executed. */
4
+ export interface QueryRequest {
5
+ /** Azure subscriptions against which to execute the query. */
6
+ subscriptions?: string[];
7
+ /** Azure management groups against which to execute the query. Example: [ 'mg1', 'mg2' ] */
8
+ managementGroups?: string[];
9
+ /** The resources query. */
10
+ query: string;
11
+ /** The query evaluation options */
12
+ options?: QueryRequestOptions;
13
+ /** An array of facet requests to be computed against the query result. */
14
+ facets?: FacetRequest[];
15
+ }
16
+ /** The options for query evaluation */
17
+ export interface QueryRequestOptions {
18
+ /** Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. */
19
+ skipToken?: string;
20
+ /** The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present. */
21
+ top?: number;
22
+ /** The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present. */
23
+ skip?: number;
24
+ /** Defines in which format query result returned. */
25
+ resultFormat?: ResultFormat;
26
+ /** 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. */
27
+ allowPartialScopes?: boolean;
28
+ /** Defines what level of authorization resources should be returned based on the which subscriptions and management groups are passed as scopes. */
29
+ authorizationScopeFilter?: AuthorizationScopeFilter;
30
+ }
31
+ /** A request to compute additional statistics (facets) over the query results. */
32
+ export interface FacetRequest {
33
+ /** The column or list of columns to summarize by */
34
+ expression: string;
35
+ /** The options for facet evaluation */
36
+ options?: FacetRequestOptions;
37
+ }
38
+ /** The options for facet evaluation */
39
+ export interface FacetRequestOptions {
40
+ /** The column name or query expression to sort on. Defaults to count if not present. */
41
+ sortBy?: string;
42
+ /** The sorting order by the selected column (count by default). */
43
+ sortOrder?: FacetSortOrder;
44
+ /** Specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting. */
45
+ filter?: string;
46
+ /** The maximum number of facet rows that should be returned. */
47
+ top?: number;
48
+ }
49
+ /** Query result. */
50
+ export interface QueryResponse {
51
+ /** Number of total records matching the query. */
52
+ totalRecords: number;
53
+ /** Number of records returned in the current response. In the case of paging, this is the number of records in the current page. */
54
+ count: number;
55
+ /** Indicates whether the query results are truncated. */
56
+ resultTruncated: ResultTruncated;
57
+ /** When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. */
58
+ skipToken?: string;
59
+ /** Query output in JObject array or Table format. */
60
+ data: Record<string, unknown>;
61
+ /** Query facets. */
62
+ facets?: FacetUnion[];
63
+ }
64
+ /** A facet containing additional statistics on the response of a query. Can be either FacetResult or FacetError. */
65
+ export interface Facet {
66
+ /** Polymorphic discriminator, which specifies the different types this object can be */
67
+ resultType: "FacetResult" | "FacetError";
68
+ /** Facet expression, same as in the corresponding facet request. */
69
+ expression: string;
70
+ }
71
+ /** An error response from the API. */
72
+ export interface ErrorResponse {
73
+ /** Error information. */
74
+ error: ErrorModel;
75
+ }
76
+ /** Error details. */
77
+ export interface ErrorModel {
78
+ /** Error code identifying the specific error. */
79
+ code: string;
80
+ /** A human readable error message. */
81
+ message: string;
82
+ /** Error details */
83
+ details?: ErrorDetails[];
84
+ }
85
+ /** Error details. */
86
+ export interface ErrorDetails {
87
+ /** Describes unknown properties. The value of an unknown property can be of "any" type. */
88
+ [property: string]: any;
89
+ /** Error code identifying the specific error. */
90
+ code: string;
91
+ /** A human readable error message. */
92
+ message: string;
93
+ }
94
+ /** Result of the request to list Resource Graph operations. It contains a list of operations and a URL link to get the next set of results. */
95
+ export interface OperationListResult {
96
+ /** List of Resource Graph operations supported by the Resource Graph resource provider. */
97
+ value?: Operation[];
98
+ }
99
+ /** Resource Graph REST API operation definition. */
100
+ export interface Operation {
101
+ /** Operation name: {provider}/{resource}/{operation} */
102
+ name?: string;
103
+ /** Display metadata associated with the operation. */
104
+ display?: OperationDisplay;
105
+ /** The origin of operations. */
106
+ origin?: string;
107
+ }
108
+ /** Display metadata associated with the operation. */
109
+ export interface OperationDisplay {
110
+ /** Service provider: Microsoft Resource Graph. */
111
+ provider?: string;
112
+ /** Resource on which the operation is performed etc. */
113
+ resource?: string;
114
+ /** Type of operation: get, read, delete, etc. */
115
+ operation?: string;
116
+ /** Description for the operation. */
117
+ description?: string;
118
+ }
119
+ /** Describes a history request to be executed. */
120
+ export interface ResourcesHistoryRequest {
121
+ /** Azure subscriptions against which to execute the query. */
122
+ subscriptions?: string[];
123
+ /** The resources query. */
124
+ query?: string;
125
+ /** The history request evaluation options */
126
+ options?: ResourcesHistoryRequestOptions;
127
+ /** Azure management groups against which to execute the query. Example: [ 'mg1', 'mg2' ] */
128
+ managementGroups?: string[];
129
+ }
130
+ /** The options for history request evaluation */
131
+ export interface ResourcesHistoryRequestOptions {
132
+ /** The time interval used to fetch history. */
133
+ interval?: DateTimeInterval;
134
+ /** The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present. */
135
+ top?: number;
136
+ /** The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present. */
137
+ skip?: number;
138
+ /** Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. */
139
+ skipToken?: string;
140
+ /** Defines in which format query result returned. */
141
+ resultFormat?: ResultFormat;
142
+ }
143
+ /** An interval in time specifying the date and time for the inclusive start and exclusive end, i.e. `[start, end)`. */
144
+ export interface DateTimeInterval {
145
+ /** A datetime indicating the inclusive/closed start of the time interval, i.e. `[`**`start`**`, end)`. Specifying a `start` that occurs chronologically after `end` will result in an error. */
146
+ start: Date;
147
+ /** A datetime indicating the exclusive/open end of the time interval, i.e. `[start, `**`end`**`)`. Specifying an `end` that occurs chronologically before `start` will result in an error. */
148
+ end: Date;
149
+ }
150
+ /** Query output in tabular format. */
151
+ export interface Table {
152
+ /** Query result column descriptors. */
153
+ columns: Column[];
154
+ /** Query result rows. */
155
+ rows: Record<string, unknown>[][];
156
+ }
157
+ /** Query result column descriptor. */
158
+ export interface Column {
159
+ /** Column name. */
160
+ name: string;
161
+ /** Column data type. */
162
+ type: ColumnDataType;
163
+ }
164
+ /** Successfully executed facet containing additional statistics on the response of a query. */
165
+ export interface FacetResult extends Facet {
166
+ /** Polymorphic discriminator, which specifies the different types this object can be */
167
+ resultType: "FacetResult";
168
+ /** Number of total records in the facet results. */
169
+ totalRecords: number;
170
+ /** Number of records returned in the facet response. */
171
+ count: number;
172
+ /** A JObject array or Table containing the desired facets. Only present if the facet is valid. */
173
+ data: Record<string, unknown>;
174
+ }
175
+ /** A facet whose execution resulted in an error. */
176
+ export interface FacetError extends Facet {
177
+ /** Polymorphic discriminator, which specifies the different types this object can be */
178
+ resultType: "FacetError";
179
+ /** An array containing detected facet errors with details. */
180
+ errors: ErrorDetails[];
181
+ }
182
+ /** Defines values for ResultFormat. */
183
+ export type ResultFormat = "table" | "objectArray";
184
+ /** Defines values for AuthorizationScopeFilter. */
185
+ export type AuthorizationScopeFilter = "AtScopeAndBelow" | "AtScopeAndAbove" | "AtScopeExact" | "AtScopeAboveAndBelow";
186
+ /** Defines values for FacetSortOrder. */
187
+ export type FacetSortOrder = "asc" | "desc";
188
+ /** Defines values for ResultTruncated. */
189
+ export type ResultTruncated = "true" | "false";
190
+ /** Defines values for ColumnDataType. */
191
+ export type ColumnDataType = "string" | "integer" | "number" | "boolean" | "object" | "datetime";
192
+ /** Optional parameters. */
193
+ export interface ResourcesOptionalParams extends coreClient.OperationOptions {
194
+ }
195
+ /** Contains response data for the resources operation. */
196
+ export type ResourcesResponse = QueryResponse;
197
+ /** Optional parameters. */
198
+ export interface ResourcesHistoryOptionalParams extends coreClient.OperationOptions {
199
+ }
200
+ /** Contains response data for the resourcesHistory operation. */
201
+ export type ResourcesHistoryResponse = Record<string, unknown>;
202
+ /** Optional parameters. */
203
+ export interface OperationsListOptionalParams extends coreClient.OperationOptions {
204
+ }
205
+ /** Contains response data for the list operation. */
206
+ export type OperationsListResponse = OperationListResult;
207
+ /** Optional parameters. */
208
+ export interface ResourceGraphClientOptionalParams extends coreClient.ServiceClientOptions {
209
+ /** server parameter */
210
+ $host?: string;
211
+ /** Api Version */
212
+ apiVersion?: string;
213
+ /** Overrides client endpoint. */
214
+ endpoint?: string;
215
+ }
216
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AAEjD,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,WAAW,GAAG,UAAU,CAAC;AAE1D,wCAAwC;AACxC,MAAM,WAAW,YAAY;IAC3B,8DAA8D;IAC9D,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,4FAA4F;IAC5F,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,0EAA0E;IAC1E,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACzB;AAED,uCAAuC;AACvC,MAAM,WAAW,mBAAmB;IAClC,uHAAuH;IACvH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kIAAkI;IAClI,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8IAA8I;IAC9I,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,oLAAoL;IACpL,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,oJAAoJ;IACpJ,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;CACrD;AAED,kFAAkF;AAClF,MAAM,WAAW,YAAY;IAC3B,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAC;IACnB,uCAAuC;IACvC,OAAO,CAAC,EAAE,mBAAmB,CAAC;CAC/B;AAED,uCAAuC;AACvC,MAAM,WAAW,mBAAmB;IAClC,wFAAwF;IACxF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mEAAmE;IACnE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,uIAAuI;IACvI,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,oBAAoB;AACpB,MAAM,WAAW,aAAa;IAC5B,kDAAkD;IAClD,YAAY,EAAE,MAAM,CAAC;IACrB,oIAAoI;IACpI,KAAK,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,eAAe,EAAE,eAAe,CAAC;IACjC,gLAAgL;IAChL,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,oBAAoB;IACpB,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC;CACvB;AAED,oHAAoH;AACpH,MAAM,WAAW,KAAK;IACpB,wFAAwF;IACxF,UAAU,EAAE,aAAa,GAAG,YAAY,CAAC;IACzC,oEAAoE;IACpE,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,sCAAsC;AACtC,MAAM,WAAW,aAAa;IAC5B,yBAAyB;IACzB,KAAK,EAAE,UAAU,CAAC;CACnB;AAED,qBAAqB;AACrB,MAAM,WAAW,UAAU;IACzB,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,oBAAoB;IACpB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED,qBAAqB;AACrB,MAAM,WAAW,YAAY;IAC3B,2FAA2F;IAC3F,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;IACxB,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,+IAA+I;AAC/I,MAAM,WAAW,mBAAmB;IAClC,2FAA2F;IAC3F,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;CACrB;AAED,oDAAoD;AACpD,MAAM,WAAW,SAAS;IACxB,wDAAwD;IACxD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sDAAsD;IACtD,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,sDAAsD;AACtD,MAAM,WAAW,gBAAgB;IAC/B,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,kDAAkD;AAClD,MAAM,WAAW,uBAAuB;IACtC,8DAA8D;IAC9D,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6CAA6C;IAC7C,OAAO,CAAC,EAAE,8BAA8B,CAAC;IACzC,4FAA4F;IAC5F,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED,iDAAiD;AACjD,MAAM,WAAW,8BAA8B;IAC7C,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,kIAAkI;IAClI,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8IAA8I;IAC9I,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uHAAuH;IACvH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,uHAAuH;AACvH,MAAM,WAAW,gBAAgB;IAC/B,gMAAgM;IAChM,KAAK,EAAE,IAAI,CAAC;IACZ,8LAA8L;IAC9L,GAAG,EAAE,IAAI,CAAC;CACX;AAED,sCAAsC;AACtC,MAAM,WAAW,KAAK;IACpB,uCAAuC;IACvC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC;CACnC;AAED,sCAAsC;AACtC,MAAM,WAAW,MAAM;IACrB,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,+FAA+F;AAC/F,MAAM,WAAW,WAAY,SAAQ,KAAK;IACxC,wFAAwF;IACxF,UAAU,EAAE,aAAa,CAAC;IAC1B,oDAAoD;IACpD,YAAY,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,kGAAkG;IAClG,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,oDAAoD;AACpD,MAAM,WAAW,UAAW,SAAQ,KAAK;IACvC,wFAAwF;IACxF,UAAU,EAAE,YAAY,CAAC;IACzB,8DAA8D;IAC9D,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB;AAED,uCAAuC;AACvC,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,aAAa,CAAC;AACnD,mDAAmD;AACnD,MAAM,MAAM,wBAAwB,GAChC,iBAAiB,GACjB,iBAAiB,GACjB,cAAc,GACd,sBAAsB,CAAC;AAC3B,yCAAyC;AACzC,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,CAAC;AAC5C,0CAA0C;AAC1C,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,OAAO,CAAC;AAC/C,yCAAyC;AACzC,MAAM,MAAM,cAAc,GACtB,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,UAAU,CAAC;AAEf,2BAA2B;AAC3B,MAAM,WAAW,uBAAwB,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAE/E,0DAA0D;AAC1D,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC;AAE9C,2BAA2B;AAC3B,MAAM,WAAW,8BACf,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAExC,iEAAiE;AACjE,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE/D,2BAA2B;AAC3B,MAAM,WAAW,4BACf,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAExC,qDAAqD;AACrD,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,CAAC;AAEzD,2BAA2B;AAC3B,MAAM,WAAW,iCACf,SAAQ,UAAU,CAAC,oBAAoB;IACvC,uBAAuB;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ /*
3
+ * Copyright (c) Microsoft Corporation.
4
+ * Licensed under the MIT License.
5
+ *
6
+ * Code generated by Microsoft (R) AutoRest Code Generator.
7
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG","sourcesContent":["/*\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * Code generated by Microsoft (R) AutoRest Code Generator.\n * Changes may cause incorrect behavior and will be lost if the code is regenerated.\n */\n\nimport * as coreClient from \"@azure/core-client\";\n\nexport type FacetUnion = Facet | FacetResult | FacetError;\n\n/** Describes a query to be executed. */\nexport interface QueryRequest {\n /** Azure subscriptions against which to execute the query. */\n subscriptions?: string[];\n /** Azure management groups against which to execute the query. Example: [ 'mg1', 'mg2' ] */\n managementGroups?: string[];\n /** The resources query. */\n query: string;\n /** The query evaluation options */\n options?: QueryRequestOptions;\n /** An array of facet requests to be computed against the query result. */\n facets?: FacetRequest[];\n}\n\n/** The options for query evaluation */\nexport interface QueryRequestOptions {\n /** Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. */\n skipToken?: string;\n /** The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present. */\n top?: number;\n /** The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present. */\n skip?: number;\n /** Defines in which format query result returned. */\n resultFormat?: ResultFormat;\n /** 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. */\n allowPartialScopes?: boolean;\n /** Defines what level of authorization resources should be returned based on the which subscriptions and management groups are passed as scopes. */\n authorizationScopeFilter?: AuthorizationScopeFilter;\n}\n\n/** A request to compute additional statistics (facets) over the query results. */\nexport interface FacetRequest {\n /** The column or list of columns to summarize by */\n expression: string;\n /** The options for facet evaluation */\n options?: FacetRequestOptions;\n}\n\n/** The options for facet evaluation */\nexport interface FacetRequestOptions {\n /** The column name or query expression to sort on. Defaults to count if not present. */\n sortBy?: string;\n /** The sorting order by the selected column (count by default). */\n sortOrder?: FacetSortOrder;\n /** Specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting. */\n filter?: string;\n /** The maximum number of facet rows that should be returned. */\n top?: number;\n}\n\n/** Query result. */\nexport interface QueryResponse {\n /** Number of total records matching the query. */\n totalRecords: number;\n /** Number of records returned in the current response. In the case of paging, this is the number of records in the current page. */\n count: number;\n /** Indicates whether the query results are truncated. */\n resultTruncated: ResultTruncated;\n /** When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. */\n skipToken?: string;\n /** Query output in JObject array or Table format. */\n data: Record<string, unknown>;\n /** Query facets. */\n facets?: FacetUnion[];\n}\n\n/** A facet containing additional statistics on the response of a query. Can be either FacetResult or FacetError. */\nexport interface Facet {\n /** Polymorphic discriminator, which specifies the different types this object can be */\n resultType: \"FacetResult\" | \"FacetError\";\n /** Facet expression, same as in the corresponding facet request. */\n expression: string;\n}\n\n/** An error response from the API. */\nexport interface ErrorResponse {\n /** Error information. */\n error: ErrorModel;\n}\n\n/** Error details. */\nexport interface ErrorModel {\n /** Error code identifying the specific error. */\n code: string;\n /** A human readable error message. */\n message: string;\n /** Error details */\n details?: ErrorDetails[];\n}\n\n/** Error details. */\nexport interface ErrorDetails {\n /** Describes unknown properties. The value of an unknown property can be of \"any\" type. */\n [property: string]: any;\n /** Error code identifying the specific error. */\n code: string;\n /** A human readable error message. */\n message: string;\n}\n\n/** Result of the request to list Resource Graph operations. It contains a list of operations and a URL link to get the next set of results. */\nexport interface OperationListResult {\n /** List of Resource Graph operations supported by the Resource Graph resource provider. */\n value?: Operation[];\n}\n\n/** Resource Graph REST API operation definition. */\nexport interface Operation {\n /** Operation name: {provider}/{resource}/{operation} */\n name?: string;\n /** Display metadata associated with the operation. */\n display?: OperationDisplay;\n /** The origin of operations. */\n origin?: string;\n}\n\n/** Display metadata associated with the operation. */\nexport interface OperationDisplay {\n /** Service provider: Microsoft Resource Graph. */\n provider?: string;\n /** Resource on which the operation is performed etc. */\n resource?: string;\n /** Type of operation: get, read, delete, etc. */\n operation?: string;\n /** Description for the operation. */\n description?: string;\n}\n\n/** Describes a history request to be executed. */\nexport interface ResourcesHistoryRequest {\n /** Azure subscriptions against which to execute the query. */\n subscriptions?: string[];\n /** The resources query. */\n query?: string;\n /** The history request evaluation options */\n options?: ResourcesHistoryRequestOptions;\n /** Azure management groups against which to execute the query. Example: [ 'mg1', 'mg2' ] */\n managementGroups?: string[];\n}\n\n/** The options for history request evaluation */\nexport interface ResourcesHistoryRequestOptions {\n /** The time interval used to fetch history. */\n interval?: DateTimeInterval;\n /** The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present. */\n top?: number;\n /** The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present. */\n skip?: number;\n /** Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. */\n skipToken?: string;\n /** Defines in which format query result returned. */\n resultFormat?: ResultFormat;\n}\n\n/** An interval in time specifying the date and time for the inclusive start and exclusive end, i.e. `[start, end)`. */\nexport interface DateTimeInterval {\n /** A datetime indicating the inclusive/closed start of the time interval, i.e. `[`**`start`**`, end)`. Specifying a `start` that occurs chronologically after `end` will result in an error. */\n start: Date;\n /** A datetime indicating the exclusive/open end of the time interval, i.e. `[start, `**`end`**`)`. Specifying an `end` that occurs chronologically before `start` will result in an error. */\n end: Date;\n}\n\n/** Query output in tabular format. */\nexport interface Table {\n /** Query result column descriptors. */\n columns: Column[];\n /** Query result rows. */\n rows: Record<string, unknown>[][];\n}\n\n/** Query result column descriptor. */\nexport interface Column {\n /** Column name. */\n name: string;\n /** Column data type. */\n type: ColumnDataType;\n}\n\n/** Successfully executed facet containing additional statistics on the response of a query. */\nexport interface FacetResult extends Facet {\n /** Polymorphic discriminator, which specifies the different types this object can be */\n resultType: \"FacetResult\";\n /** Number of total records in the facet results. */\n totalRecords: number;\n /** Number of records returned in the facet response. */\n count: number;\n /** A JObject array or Table containing the desired facets. Only present if the facet is valid. */\n data: Record<string, unknown>;\n}\n\n/** A facet whose execution resulted in an error. */\nexport interface FacetError extends Facet {\n /** Polymorphic discriminator, which specifies the different types this object can be */\n resultType: \"FacetError\";\n /** An array containing detected facet errors with details. */\n errors: ErrorDetails[];\n}\n\n/** Defines values for ResultFormat. */\nexport type ResultFormat = \"table\" | \"objectArray\";\n/** Defines values for AuthorizationScopeFilter. */\nexport type AuthorizationScopeFilter =\n | \"AtScopeAndBelow\"\n | \"AtScopeAndAbove\"\n | \"AtScopeExact\"\n | \"AtScopeAboveAndBelow\";\n/** Defines values for FacetSortOrder. */\nexport type FacetSortOrder = \"asc\" | \"desc\";\n/** Defines values for ResultTruncated. */\nexport type ResultTruncated = \"true\" | \"false\";\n/** Defines values for ColumnDataType. */\nexport type ColumnDataType =\n | \"string\"\n | \"integer\"\n | \"number\"\n | \"boolean\"\n | \"object\"\n | \"datetime\";\n\n/** Optional parameters. */\nexport interface ResourcesOptionalParams extends coreClient.OperationOptions {}\n\n/** Contains response data for the resources operation. */\nexport type ResourcesResponse = QueryResponse;\n\n/** Optional parameters. */\nexport interface ResourcesHistoryOptionalParams\n extends coreClient.OperationOptions {}\n\n/** Contains response data for the resourcesHistory operation. */\nexport type ResourcesHistoryResponse = Record<string, unknown>;\n\n/** Optional parameters. */\nexport interface OperationsListOptionalParams\n extends coreClient.OperationOptions {}\n\n/** Contains response data for the list operation. */\nexport type OperationsListResponse = OperationListResult;\n\n/** Optional parameters. */\nexport interface ResourceGraphClientOptionalParams\n extends coreClient.ServiceClientOptions {\n /** server parameter */\n $host?: string;\n /** Api Version */\n apiVersion?: string;\n /** Overrides client endpoint. */\n endpoint?: string;\n}\n"]}
@@ -0,0 +1,26 @@
1
+ import * as coreClient from "@azure/core-client";
2
+ export declare const QueryRequest: coreClient.CompositeMapper;
3
+ export declare const QueryRequestOptions: coreClient.CompositeMapper;
4
+ export declare const FacetRequest: coreClient.CompositeMapper;
5
+ export declare const FacetRequestOptions: coreClient.CompositeMapper;
6
+ export declare const QueryResponse: coreClient.CompositeMapper;
7
+ export declare const Facet: coreClient.CompositeMapper;
8
+ export declare const ErrorResponse: coreClient.CompositeMapper;
9
+ export declare const ErrorModel: coreClient.CompositeMapper;
10
+ export declare const ErrorDetails: coreClient.CompositeMapper;
11
+ export declare const OperationListResult: coreClient.CompositeMapper;
12
+ export declare const Operation: coreClient.CompositeMapper;
13
+ export declare const OperationDisplay: coreClient.CompositeMapper;
14
+ export declare const ResourcesHistoryRequest: coreClient.CompositeMapper;
15
+ export declare const ResourcesHistoryRequestOptions: coreClient.CompositeMapper;
16
+ export declare const DateTimeInterval: coreClient.CompositeMapper;
17
+ export declare const Table: coreClient.CompositeMapper;
18
+ export declare const Column: coreClient.CompositeMapper;
19
+ export declare const FacetResult: coreClient.CompositeMapper;
20
+ export declare const FacetError: coreClient.CompositeMapper;
21
+ export declare let discriminators: {
22
+ Facet: coreClient.CompositeMapper;
23
+ "Facet.FacetResult": coreClient.CompositeMapper;
24
+ "Facet.FacetError": coreClient.CompositeMapper;
25
+ };
26
+ //# sourceMappingURL=mappers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mappers.d.ts","sourceRoot":"","sources":["../../../src/models/mappers.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AAEjD,eAAO,MAAM,YAAY,EAAE,UAAU,CAAC,eAuDrC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,UAAU,CAAC,eA2D5C,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,UAAU,CAAC,eAqBrC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,UAAU,CAAC,eAqC5C,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,UAAU,CAAC,eAuDtC,CAAC;AAEF,eAAO,MAAM,KAAK,EAAE,UAAU,CAAC,eA0B9B,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,UAAU,CAAC,eActC,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,UAAU,CAAC,eAiCnC,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,UAAU,CAAC,eAsBrC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,UAAU,CAAC,eAmB5C,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,UAAU,CAAC,eA0BlC,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,UAAU,CAAC,eA+BzC,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,UAAU,CAAC,eA0ChD,CAAC;AAEF,eAAO,MAAM,8BAA8B,EAAE,UAAU,CAAC,eA8CvD,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,UAAU,CAAC,eAqBzC,CAAC;AAEF,eAAO,MAAM,KAAK,EAAE,UAAU,CAAC,eAsC9B,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,UAAU,CAAC,eA6B/B,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,UAAU,CAAC,eAiCpC,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,UAAU,CAAC,eAwBnC,CAAC;AAEF,eAAO,IAAI,cAAc;;;;CAIxB,CAAC"}