@azure/arm-commitmentplans 0.1.0 → 2.0.0-beta.1

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 (171) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +21 -0
  3. package/README.md +75 -73
  4. package/dist/index.js +1794 -0
  5. package/dist/index.js.map +1 -0
  6. package/dist/index.min.js +1 -0
  7. package/dist/index.min.js.map +1 -0
  8. package/dist-esm/src/azureMLCommitmentPlansManagementClient.d.ts +22 -0
  9. package/dist-esm/src/azureMLCommitmentPlansManagementClient.d.ts.map +1 -0
  10. package/dist-esm/src/azureMLCommitmentPlansManagementClient.js +55 -0
  11. package/dist-esm/src/azureMLCommitmentPlansManagementClient.js.map +1 -0
  12. package/dist-esm/src/index.d.ts +5 -0
  13. package/dist-esm/src/index.d.ts.map +1 -0
  14. package/dist-esm/src/index.js +12 -0
  15. package/dist-esm/src/index.js.map +1 -0
  16. package/dist-esm/src/models/index.d.ts +522 -0
  17. package/dist-esm/src/models/index.d.ts.map +1 -0
  18. package/dist-esm/src/models/index.js +27 -0
  19. package/dist-esm/src/models/index.js.map +1 -0
  20. package/dist-esm/src/models/mappers.d.ts +24 -0
  21. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  22. package/{esm → dist-esm/src}/models/mappers.js +352 -337
  23. package/dist-esm/src/models/mappers.js.map +1 -0
  24. package/dist-esm/src/models/parameters.d.ts +15 -0
  25. package/dist-esm/src/models/parameters.d.ts.map +1 -0
  26. package/dist-esm/src/models/parameters.js +125 -0
  27. package/dist-esm/src/models/parameters.js.map +1 -0
  28. package/dist-esm/src/operations/commitmentAssociations.d.ts +55 -0
  29. package/dist-esm/src/operations/commitmentAssociations.d.ts.map +1 -0
  30. package/dist-esm/src/operations/commitmentAssociations.js +203 -0
  31. package/dist-esm/src/operations/commitmentAssociations.js.map +1 -0
  32. package/dist-esm/src/operations/commitmentPlans.d.ts +84 -0
  33. package/dist-esm/src/operations/commitmentPlans.d.ts.map +1 -0
  34. package/dist-esm/src/operations/commitmentPlans.js +332 -0
  35. package/dist-esm/src/operations/commitmentPlans.js.map +1 -0
  36. package/{esm → dist-esm/src}/operations/index.d.ts +1 -0
  37. package/dist-esm/src/operations/index.d.ts.map +1 -0
  38. package/{esm → dist-esm/src}/operations/index.js +4 -5
  39. package/dist-esm/src/operations/index.js.map +1 -0
  40. package/dist-esm/src/operations/operations.d.ts +26 -0
  41. package/dist-esm/src/operations/operations.d.ts.map +1 -0
  42. package/dist-esm/src/operations/operations.js +87 -0
  43. package/dist-esm/src/operations/operations.js.map +1 -0
  44. package/dist-esm/src/operations/skus.d.ts +26 -0
  45. package/dist-esm/src/operations/skus.d.ts.map +1 -0
  46. package/dist-esm/src/operations/skus.js +87 -0
  47. package/dist-esm/src/operations/skus.js.map +1 -0
  48. package/dist-esm/src/operations/usageHistory.d.ts +38 -0
  49. package/dist-esm/src/operations/usageHistory.d.ts.map +1 -0
  50. package/dist-esm/src/operations/usageHistory.js +131 -0
  51. package/dist-esm/src/operations/usageHistory.js.map +1 -0
  52. package/dist-esm/src/operationsInterfaces/commitmentAssociations.d.ts +30 -0
  53. package/dist-esm/src/operationsInterfaces/commitmentAssociations.d.ts.map +1 -0
  54. package/dist-esm/src/operationsInterfaces/commitmentAssociations.js +9 -0
  55. package/dist-esm/src/operationsInterfaces/commitmentAssociations.js.map +1 -0
  56. package/dist-esm/src/operationsInterfaces/commitmentPlans.d.ts +48 -0
  57. package/dist-esm/src/operationsInterfaces/commitmentPlans.d.ts.map +1 -0
  58. package/dist-esm/src/operationsInterfaces/commitmentPlans.js +9 -0
  59. package/dist-esm/src/operationsInterfaces/commitmentPlans.js.map +1 -0
  60. package/dist-esm/src/operationsInterfaces/index.d.ts +6 -0
  61. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
  62. package/dist-esm/src/operationsInterfaces/index.js +13 -0
  63. package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
  64. package/dist-esm/src/operationsInterfaces/operations.d.ts +11 -0
  65. package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
  66. package/dist-esm/src/operationsInterfaces/operations.js +9 -0
  67. package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
  68. package/dist-esm/src/operationsInterfaces/skus.d.ts +11 -0
  69. package/dist-esm/src/operationsInterfaces/skus.d.ts.map +1 -0
  70. package/dist-esm/src/operationsInterfaces/skus.js +9 -0
  71. package/dist-esm/src/operationsInterfaces/skus.js.map +1 -0
  72. package/dist-esm/src/operationsInterfaces/usageHistory.d.ts +13 -0
  73. package/dist-esm/src/operationsInterfaces/usageHistory.d.ts.map +1 -0
  74. package/dist-esm/src/operationsInterfaces/usageHistory.js +9 -0
  75. package/dist-esm/src/operationsInterfaces/usageHistory.js.map +1 -0
  76. package/dist-esm/test/sampleTest.d.ts +2 -0
  77. package/dist-esm/test/sampleTest.d.ts.map +1 -0
  78. package/dist-esm/test/sampleTest.js +40 -0
  79. package/dist-esm/test/sampleTest.js.map +1 -0
  80. package/package.json +77 -34
  81. package/review/arm-commitmentplans.api.md +405 -0
  82. package/rollup.config.js +184 -27
  83. package/src/azureMLCommitmentPlansManagementClient.ts +95 -0
  84. package/src/index.ts +12 -0
  85. package/src/models/index.ts +579 -0
  86. package/{lib → src}/models/mappers.ts +354 -336
  87. package/src/models/parameters.ts +147 -0
  88. package/src/operations/commitmentAssociations.ts +281 -0
  89. package/src/operations/commitmentPlans.ts +420 -0
  90. package/{lib → src}/operations/index.ts +4 -5
  91. package/src/operations/operations.ts +95 -0
  92. package/src/operations/skus.ts +94 -0
  93. package/src/operations/usageHistory.ts +183 -0
  94. package/src/operationsInterfaces/commitmentAssociations.ts +62 -0
  95. package/src/operationsInterfaces/commitmentPlans.ts +92 -0
  96. package/src/operationsInterfaces/index.ts +13 -0
  97. package/src/operationsInterfaces/operations.ts +22 -0
  98. package/src/operationsInterfaces/skus.ts +22 -0
  99. package/src/operationsInterfaces/usageHistory.ts +26 -0
  100. package/tsconfig.json +6 -5
  101. package/types/arm-commitmentplans.d.ts +706 -0
  102. package/types/tsdoc-metadata.json +11 -0
  103. package/dist/arm-commitmentplans.js +0 -1649
  104. package/dist/arm-commitmentplans.js.map +0 -1
  105. package/dist/arm-commitmentplans.min.js +0 -1
  106. package/dist/arm-commitmentplans.min.js.map +0 -1
  107. package/esm/azureMLCommitmentPlansManagementClient.d.ts +0 -21
  108. package/esm/azureMLCommitmentPlansManagementClient.d.ts.map +0 -1
  109. package/esm/azureMLCommitmentPlansManagementClient.js +0 -36
  110. package/esm/azureMLCommitmentPlansManagementClient.js.map +0 -1
  111. package/esm/azureMLCommitmentPlansManagementClientContext.d.ts +0 -16
  112. package/esm/azureMLCommitmentPlansManagementClientContext.d.ts.map +0 -1
  113. package/esm/azureMLCommitmentPlansManagementClientContext.js +0 -56
  114. package/esm/azureMLCommitmentPlansManagementClientContext.js.map +0 -1
  115. package/esm/models/commitmentAssociationsMappers.d.ts +0 -2
  116. package/esm/models/commitmentAssociationsMappers.d.ts.map +0 -1
  117. package/esm/models/commitmentAssociationsMappers.js +0 -11
  118. package/esm/models/commitmentAssociationsMappers.js.map +0 -1
  119. package/esm/models/commitmentPlansMappers.d.ts +0 -2
  120. package/esm/models/commitmentPlansMappers.d.ts.map +0 -1
  121. package/esm/models/commitmentPlansMappers.js +0 -11
  122. package/esm/models/commitmentPlansMappers.js.map +0 -1
  123. package/esm/models/index.d.ts +0 -901
  124. package/esm/models/index.d.ts.map +0 -1
  125. package/esm/models/index.js +0 -10
  126. package/esm/models/index.js.map +0 -1
  127. package/esm/models/mappers.d.ts +0 -23
  128. package/esm/models/mappers.d.ts.map +0 -1
  129. package/esm/models/mappers.js.map +0 -1
  130. package/esm/models/parameters.d.ts +0 -10
  131. package/esm/models/parameters.d.ts.map +0 -1
  132. package/esm/models/parameters.js +0 -93
  133. package/esm/models/parameters.js.map +0 -1
  134. package/esm/models/skusMappers.d.ts +0 -2
  135. package/esm/models/skusMappers.d.ts.map +0 -1
  136. package/esm/models/skusMappers.js +0 -11
  137. package/esm/models/skusMappers.js.map +0 -1
  138. package/esm/models/usageHistoryMappers.d.ts +0 -2
  139. package/esm/models/usageHistoryMappers.d.ts.map +0 -1
  140. package/esm/models/usageHistoryMappers.js +0 -11
  141. package/esm/models/usageHistoryMappers.js.map +0 -1
  142. package/esm/operations/commitmentAssociations.d.ts +0 -103
  143. package/esm/operations/commitmentAssociations.d.ts.map +0 -1
  144. package/esm/operations/commitmentAssociations.js +0 -157
  145. package/esm/operations/commitmentAssociations.js.map +0 -1
  146. package/esm/operations/commitmentPlans.d.ts +0 -175
  147. package/esm/operations/commitmentPlans.d.ts.map +0 -1
  148. package/esm/operations/commitmentPlans.js +0 -273
  149. package/esm/operations/commitmentPlans.js.map +0 -1
  150. package/esm/operations/index.d.ts.map +0 -1
  151. package/esm/operations/index.js.map +0 -1
  152. package/esm/operations/skus.d.ts +0 -28
  153. package/esm/operations/skus.d.ts.map +0 -1
  154. package/esm/operations/skus.js +0 -54
  155. package/esm/operations/skus.js.map +0 -1
  156. package/esm/operations/usageHistory.d.ts +0 -52
  157. package/esm/operations/usageHistory.d.ts.map +0 -1
  158. package/esm/operations/usageHistory.js +0 -85
  159. package/esm/operations/usageHistory.js.map +0 -1
  160. package/lib/azureMLCommitmentPlansManagementClient.ts +0 -48
  161. package/lib/azureMLCommitmentPlansManagementClientContext.ts +0 -62
  162. package/lib/models/commitmentAssociationsMappers.ts +0 -24
  163. package/lib/models/commitmentPlansMappers.ts +0 -24
  164. package/lib/models/index.ts +0 -936
  165. package/lib/models/parameters.ts +0 -95
  166. package/lib/models/skusMappers.ts +0 -20
  167. package/lib/models/usageHistoryMappers.ts +0 -16
  168. package/lib/operations/commitmentAssociations.ts +0 -272
  169. package/lib/operations/commitmentPlans.ts +0 -483
  170. package/lib/operations/skus.ts +0 -77
  171. package/lib/operations/usageHistory.ts +0 -137
@@ -1,936 +0,0 @@
1
- /*
2
- * Copyright (c) Microsoft Corporation. All rights reserved.
3
- * Licensed under the MIT License. See License.txt in the project root for
4
- * license information.
5
- *
6
- * Code generated by Microsoft (R) AutoRest Code Generator.
7
- * Changes may cause incorrect behavior and will be lost if the code is
8
- * regenerated.
9
- */
10
-
11
- import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js";
12
- import * as msRest from "@azure/ms-rest-js";
13
-
14
- export { BaseResource, CloudError };
15
-
16
-
17
- /**
18
- * @interface
19
- * An interface representing SkuCapacity.
20
- * Describes scaling information of a SKU.
21
- *
22
- */
23
- export interface SkuCapacity {
24
- /**
25
- * @member {number} [minimum] The minimum capacity.
26
- * **NOTE: This property will not be serialized. It can only be populated by
27
- * the server.**
28
- */
29
- readonly minimum?: number;
30
- /**
31
- * @member {number} [maximum] The maximum capacity that can be set.
32
- * **NOTE: This property will not be serialized. It can only be populated by
33
- * the server.**
34
- */
35
- readonly maximum?: number;
36
- /**
37
- * @member {number} [default] The default capacity.
38
- * **NOTE: This property will not be serialized. It can only be populated by
39
- * the server.**
40
- */
41
- readonly default?: number;
42
- /**
43
- * @member {SkuCapacityScaleType} [scaleType] The scale type applicable to
44
- * the sku. Possible values include: 'Automatic', 'Manual', 'None'
45
- * **NOTE: This property will not be serialized. It can only be populated by
46
- * the server.**
47
- */
48
- readonly scaleType?: SkuCapacityScaleType;
49
- }
50
-
51
- /**
52
- * @interface
53
- * An interface representing SkuCapability.
54
- * Describes The SKU capabilites object.
55
- *
56
- */
57
- export interface SkuCapability {
58
- /**
59
- * @member {string} [name] The capability name.
60
- * **NOTE: This property will not be serialized. It can only be populated by
61
- * the server.**
62
- */
63
- readonly name?: string;
64
- /**
65
- * @member {string} [value] The capability value.
66
- * **NOTE: This property will not be serialized. It can only be populated by
67
- * the server.**
68
- */
69
- readonly value?: string;
70
- }
71
-
72
- /**
73
- * @interface
74
- * An interface representing SkuCost.
75
- * Describes metadata for SKU cost info.
76
- *
77
- */
78
- export interface SkuCost {
79
- /**
80
- * @member {string} [meterID] The meter used for this part of a SKU's cost.
81
- * **NOTE: This property will not be serialized. It can only be populated by
82
- * the server.**
83
- */
84
- readonly meterID?: string;
85
- /**
86
- * @member {number} [quantity] The multiplier for the meter ID.
87
- * **NOTE: This property will not be serialized. It can only be populated by
88
- * the server.**
89
- */
90
- readonly quantity?: number;
91
- /**
92
- * @member {string} [extendedUnit] The overall duration represented by the
93
- * quantity.
94
- * **NOTE: This property will not be serialized. It can only be populated by
95
- * the server.**
96
- */
97
- readonly extendedUnit?: string;
98
- }
99
-
100
- /**
101
- * @interface
102
- * An interface representing SkuRestrictions.
103
- * Describes restrictions which would prevent a SKU from being used.
104
- *
105
- */
106
- export interface SkuRestrictions {
107
- /**
108
- * @member {ResourceSkuRestrictionsType} [type] The type of restrictions.
109
- * Possible values include: 'location', 'zone'
110
- * **NOTE: This property will not be serialized. It can only be populated by
111
- * the server.**
112
- */
113
- readonly type?: ResourceSkuRestrictionsType;
114
- /**
115
- * @member {string[]} [values] The value of restrictions. If the restriction
116
- * type is set to location. This would be different locations where the SKU
117
- * is restricted.
118
- * **NOTE: This property will not be serialized. It can only be populated by
119
- * the server.**
120
- */
121
- readonly values?: string[];
122
- /**
123
- * @member {ResourceSkuRestrictionsReasonCode} [reasonCode] The reason for
124
- * restriction. Possible values include: 'QuotaId',
125
- * 'NotAvailableForSubscription'
126
- * **NOTE: This property will not be serialized. It can only be populated by
127
- * the server.**
128
- */
129
- readonly reasonCode?: ResourceSkuRestrictionsReasonCode;
130
- }
131
-
132
- /**
133
- * @interface
134
- * An interface representing CatalogSku.
135
- * Details of a commitment plan SKU.
136
- *
137
- */
138
- export interface CatalogSku {
139
- /**
140
- * @member {string} [resourceType] Resource type name
141
- * **NOTE: This property will not be serialized. It can only be populated by
142
- * the server.**
143
- */
144
- readonly resourceType?: string;
145
- /**
146
- * @member {string} [name] SKU name
147
- * **NOTE: This property will not be serialized. It can only be populated by
148
- * the server.**
149
- */
150
- readonly name?: string;
151
- /**
152
- * @member {string} [tier] SKU tier
153
- * **NOTE: This property will not be serialized. It can only be populated by
154
- * the server.**
155
- */
156
- readonly tier?: string;
157
- /**
158
- * @member {string[]} [locations] Regions where the SKU is available.
159
- * **NOTE: This property will not be serialized. It can only be populated by
160
- * the server.**
161
- */
162
- readonly locations?: string[];
163
- /**
164
- * @member {SkuCapacity} [capacity] SKU scaling information
165
- * **NOTE: This property will not be serialized. It can only be populated by
166
- * the server.**
167
- */
168
- readonly capacity?: SkuCapacity;
169
- /**
170
- * @member {SkuCapability[]} [capabilities] The capability information for
171
- * the specified SKU.
172
- * **NOTE: This property will not be serialized. It can only be populated by
173
- * the server.**
174
- */
175
- readonly capabilities?: SkuCapability[];
176
- /**
177
- * @member {SkuCost[]} [costs] The cost information for the specified SKU.
178
- * **NOTE: This property will not be serialized. It can only be populated by
179
- * the server.**
180
- */
181
- readonly costs?: SkuCost[];
182
- /**
183
- * @member {SkuRestrictions[]} [restrictions] Restrictions which would
184
- * prevent a SKU from being used. This is empty if there are no restrictions.
185
- * **NOTE: This property will not be serialized. It can only be populated by
186
- * the server.**
187
- */
188
- readonly restrictions?: SkuRestrictions[];
189
- }
190
-
191
- /**
192
- * @interface
193
- * An interface representing Resource.
194
- * Common properties of an ARM resource.
195
- *
196
- * @extends BaseResource
197
- */
198
- export interface Resource extends BaseResource {
199
- /**
200
- * @member {string} [id] Resource Id.
201
- * **NOTE: This property will not be serialized. It can only be populated by
202
- * the server.**
203
- */
204
- readonly id?: string;
205
- /**
206
- * @member {string} [name] Resource name.
207
- * **NOTE: This property will not be serialized. It can only be populated by
208
- * the server.**
209
- */
210
- readonly name?: string;
211
- /**
212
- * @member {string} location Resource location.
213
- */
214
- location: string;
215
- /**
216
- * @member {string} [type] Resource type.
217
- * **NOTE: This property will not be serialized. It can only be populated by
218
- * the server.**
219
- */
220
- readonly type?: string;
221
- /**
222
- * @member {{ [propertyName: string]: string }} [tags] User-defined tags for
223
- * the resource.
224
- */
225
- tags?: { [propertyName: string]: string };
226
- }
227
-
228
- /**
229
- * @interface
230
- * An interface representing CommitmentAssociationProperties.
231
- * Properties of an Azure ML commitment association.
232
- *
233
- */
234
- export interface CommitmentAssociationProperties {
235
- /**
236
- * @member {string} [associatedResourceId] The ID of the resource this
237
- * association points to, such as the ARM ID of an Azure ML web service.
238
- * **NOTE: This property will not be serialized. It can only be populated by
239
- * the server.**
240
- */
241
- readonly associatedResourceId?: string;
242
- /**
243
- * @member {string} [commitmentPlanId] The ARM ID of the parent Azure ML
244
- * commitment plan.
245
- * **NOTE: This property will not be serialized. It can only be populated by
246
- * the server.**
247
- */
248
- readonly commitmentPlanId?: string;
249
- /**
250
- * @member {Date} [creationDate] The date at which this commitment
251
- * association was created, in ISO 8601 format.
252
- * **NOTE: This property will not be serialized. It can only be populated by
253
- * the server.**
254
- */
255
- readonly creationDate?: Date;
256
- }
257
-
258
- /**
259
- * @interface
260
- * An interface representing CommitmentAssociation.
261
- * Represents the association between a commitment plan and some other
262
- * resource, such as a Machine Learning web service.
263
- *
264
- * @extends Resource
265
- */
266
- export interface CommitmentAssociation extends Resource {
267
- /**
268
- * @member {string} [etag] An entity tag used to enforce optimistic
269
- * concurrency.
270
- */
271
- etag?: string;
272
- /**
273
- * @member {CommitmentAssociationProperties} [properties] The properties of
274
- * the commitment association resource.
275
- */
276
- properties?: CommitmentAssociationProperties;
277
- }
278
-
279
- /**
280
- * @interface
281
- * An interface representing ResourceSku.
282
- * The SKU of a resource.
283
- *
284
- */
285
- export interface ResourceSku {
286
- /**
287
- * @member {number} [capacity] The scale-out capacity of the resource. 1 is
288
- * 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment
289
- * plan resource.
290
- */
291
- capacity?: number;
292
- /**
293
- * @member {string} [name] The SKU name. Along with tier, uniquely identifies
294
- * the SKU.
295
- */
296
- name?: string;
297
- /**
298
- * @member {string} [tier] The SKU tier. Along with name, uniquely identifies
299
- * the SKU.
300
- */
301
- tier?: string;
302
- }
303
-
304
- /**
305
- * @interface
306
- * An interface representing MoveCommitmentAssociationRequest.
307
- * Specifies the destination Azure ML commitment plan for a move operation.
308
- *
309
- */
310
- export interface MoveCommitmentAssociationRequest {
311
- /**
312
- * @member {string} [destinationPlanId] The ARM ID of the commitment plan to
313
- * re-parent the commitment association to.
314
- */
315
- destinationPlanId?: string;
316
- }
317
-
318
- /**
319
- * @interface
320
- * An interface representing CommitmentPlanPatchPayload.
321
- * The properties of a commitment plan which may be updated via PATCH.
322
- *
323
- */
324
- export interface CommitmentPlanPatchPayload {
325
- /**
326
- * @member {{ [propertyName: string]: string }} [tags] User-defined tags for
327
- * the commitment plan.
328
- */
329
- tags?: { [propertyName: string]: string };
330
- /**
331
- * @member {ResourceSku} [sku] The commitment plan SKU.
332
- */
333
- sku?: ResourceSku;
334
- }
335
-
336
- /**
337
- * @interface
338
- * An interface representing PlanQuantity.
339
- * Represents the quantity a commitment plan provides of a metered resource.
340
- *
341
- */
342
- export interface PlanQuantity {
343
- /**
344
- * @member {number} [allowance] The quantity added to the commitment plan at
345
- * an interval specified by its allowance frequency.
346
- * **NOTE: This property will not be serialized. It can only be populated by
347
- * the server.**
348
- */
349
- readonly allowance?: number;
350
- /**
351
- * @member {number} [amount] The quantity available to the plan the last time
352
- * usage was calculated.
353
- * **NOTE: This property will not be serialized. It can only be populated by
354
- * the server.**
355
- */
356
- readonly amount?: number;
357
- /**
358
- * @member {string} [includedQuantityMeter] The Azure meter for usage against
359
- * included quantities.
360
- * **NOTE: This property will not be serialized. It can only be populated by
361
- * the server.**
362
- */
363
- readonly includedQuantityMeter?: string;
364
- /**
365
- * @member {string} [overageMeter] The Azure meter for usage which exceeds
366
- * included quantities.
367
- * **NOTE: This property will not be serialized. It can only be populated by
368
- * the server.**
369
- */
370
- readonly overageMeter?: string;
371
- }
372
-
373
- /**
374
- * @interface
375
- * An interface representing CommitmentPlanProperties.
376
- * Properties of an Azure ML commitment plan.
377
- *
378
- */
379
- export interface CommitmentPlanProperties {
380
- /**
381
- * @member {boolean} [chargeForOverage] Indicates whether usage beyond the
382
- * commitment plan's included quantities will be charged.
383
- * **NOTE: This property will not be serialized. It can only be populated by
384
- * the server.**
385
- */
386
- readonly chargeForOverage?: boolean;
387
- /**
388
- * @member {boolean} [chargeForPlan] Indicates whether the commitment plan
389
- * will incur a charge.
390
- * **NOTE: This property will not be serialized. It can only be populated by
391
- * the server.**
392
- */
393
- readonly chargeForPlan?: boolean;
394
- /**
395
- * @member {Date} [creationDate] The date at which this commitment plan was
396
- * created, in ISO 8601 format.
397
- * **NOTE: This property will not be serialized. It can only be populated by
398
- * the server.**
399
- */
400
- readonly creationDate?: Date;
401
- /**
402
- * @member {{ [propertyName: string]: PlanQuantity }} [includedQuantities]
403
- * The included resource quantities this plan gives you.
404
- * **NOTE: This property will not be serialized. It can only be populated by
405
- * the server.**
406
- */
407
- readonly includedQuantities?: { [propertyName: string]: PlanQuantity };
408
- /**
409
- * @member {number} [maxAssociationLimit] The maximum number of commitment
410
- * associations that can be children of this commitment plan.
411
- * **NOTE: This property will not be serialized. It can only be populated by
412
- * the server.**
413
- */
414
- readonly maxAssociationLimit?: number;
415
- /**
416
- * @member {number} [maxCapacityLimit] The maximum scale-out capacity for
417
- * this commitment plan.
418
- * **NOTE: This property will not be serialized. It can only be populated by
419
- * the server.**
420
- */
421
- readonly maxCapacityLimit?: number;
422
- /**
423
- * @member {number} [minCapacityLimit] The minimum scale-out capacity for
424
- * this commitment plan.
425
- * **NOTE: This property will not be serialized. It can only be populated by
426
- * the server.**
427
- */
428
- readonly minCapacityLimit?: number;
429
- /**
430
- * @member {string} [planMeter] The Azure meter which will be used to charge
431
- * for this commitment plan.
432
- * **NOTE: This property will not be serialized. It can only be populated by
433
- * the server.**
434
- */
435
- readonly planMeter?: string;
436
- /**
437
- * @member {number} [refillFrequencyInDays] The frequency at which this
438
- * commitment plan's included quantities are refilled.
439
- * **NOTE: This property will not be serialized. It can only be populated by
440
- * the server.**
441
- */
442
- readonly refillFrequencyInDays?: number;
443
- /**
444
- * @member {boolean} [suspendPlanOnOverage] Indicates whether this commitment
445
- * plan will be moved into a suspended state if usage goes beyond the
446
- * commitment plan's included quantities.
447
- * **NOTE: This property will not be serialized. It can only be populated by
448
- * the server.**
449
- */
450
- readonly suspendPlanOnOverage?: boolean;
451
- }
452
-
453
- /**
454
- * @interface
455
- * An interface representing CommitmentPlan.
456
- * An Azure ML commitment plan resource.
457
- *
458
- * @extends Resource
459
- */
460
- export interface CommitmentPlan extends Resource {
461
- /**
462
- * @member {string} [etag] An entity tag used to enforce optimistic
463
- * concurrency.
464
- */
465
- etag?: string;
466
- /**
467
- * @member {CommitmentPlanProperties} [properties] The commitment plan
468
- * properties.
469
- * **NOTE: This property will not be serialized. It can only be populated by
470
- * the server.**
471
- */
472
- readonly properties?: CommitmentPlanProperties;
473
- /**
474
- * @member {ResourceSku} [sku] The commitment plan SKU.
475
- */
476
- sku?: ResourceSku;
477
- }
478
-
479
- /**
480
- * @interface
481
- * An interface representing PlanUsageHistory.
482
- * Represents historical information about usage of the Azure resources
483
- * associated with a commitment plan.
484
- *
485
- */
486
- export interface PlanUsageHistory {
487
- /**
488
- * @member {{ [propertyName: string]: number }} [planDeletionOverage] Overage
489
- * incurred as a result of deleting a commitment plan.
490
- */
491
- planDeletionOverage?: { [propertyName: string]: number };
492
- /**
493
- * @member {{ [propertyName: string]: number }} [planMigrationOverage]
494
- * Overage incurred as a result of migrating a commitment plan from one SKU
495
- * to another.
496
- */
497
- planMigrationOverage?: { [propertyName: string]: number };
498
- /**
499
- * @member {{ [propertyName: string]: number }} [planQuantitiesAfterUsage]
500
- * Included quantities remaining after usage against the commitment plan's
501
- * associated resources was calculated.
502
- */
503
- planQuantitiesAfterUsage?: { [propertyName: string]: number };
504
- /**
505
- * @member {{ [propertyName: string]: number }} [planQuantitiesBeforeUsage]
506
- * Included quantities remaining before usage against the commitment plan's
507
- * associated resources was calculated.
508
- */
509
- planQuantitiesBeforeUsage?: { [propertyName: string]: number };
510
- /**
511
- * @member {{ [propertyName: string]: number }} [planUsageOverage] Usage
512
- * against the commitment plan's associated resources which was not covered
513
- * by included quantities and is therefore overage.
514
- */
515
- planUsageOverage?: { [propertyName: string]: number };
516
- /**
517
- * @member {{ [propertyName: string]: number }} [usage] Usage against the
518
- * commitment plan's associated resources.
519
- */
520
- usage?: { [propertyName: string]: number };
521
- /**
522
- * @member {Date} [usageDate] The date of usage, in ISO 8601 format.
523
- */
524
- usageDate?: Date;
525
- }
526
-
527
- /**
528
- * @interface
529
- * An interface representing CommitmentAssociationsListOptionalParams.
530
- * Optional Parameters.
531
- *
532
- * @extends RequestOptionsBase
533
- */
534
- export interface CommitmentAssociationsListOptionalParams extends msRest.RequestOptionsBase {
535
- /**
536
- * @member {string} [skipToken] Continuation token for pagination.
537
- */
538
- skipToken?: string;
539
- }
540
-
541
- /**
542
- * @interface
543
- * An interface representing CommitmentPlansListOptionalParams.
544
- * Optional Parameters.
545
- *
546
- * @extends RequestOptionsBase
547
- */
548
- export interface CommitmentPlansListOptionalParams extends msRest.RequestOptionsBase {
549
- /**
550
- * @member {string} [skipToken] Continuation token for pagination.
551
- */
552
- skipToken?: string;
553
- }
554
-
555
- /**
556
- * @interface
557
- * An interface representing CommitmentPlansListInResourceGroupOptionalParams.
558
- * Optional Parameters.
559
- *
560
- * @extends RequestOptionsBase
561
- */
562
- export interface CommitmentPlansListInResourceGroupOptionalParams extends msRest.RequestOptionsBase {
563
- /**
564
- * @member {string} [skipToken] Continuation token for pagination.
565
- */
566
- skipToken?: string;
567
- }
568
-
569
- /**
570
- * @interface
571
- * An interface representing UsageHistoryListOptionalParams.
572
- * Optional Parameters.
573
- *
574
- * @extends RequestOptionsBase
575
- */
576
- export interface UsageHistoryListOptionalParams extends msRest.RequestOptionsBase {
577
- /**
578
- * @member {string} [skipToken] Continuation token for pagination.
579
- */
580
- skipToken?: string;
581
- }
582
-
583
- /**
584
- * @interface
585
- * An interface representing AzureMLCommitmentPlansManagementClientOptions.
586
- * @extends AzureServiceClientOptions
587
- */
588
- export interface AzureMLCommitmentPlansManagementClientOptions extends AzureServiceClientOptions {
589
- /**
590
- * @member {string} [baseUri]
591
- */
592
- baseUri?: string;
593
- }
594
-
595
-
596
- /**
597
- * @interface
598
- * An interface representing the SkuListResult.
599
- * The list of commitment plan SKUs.
600
- *
601
- * @extends Array<CatalogSku>
602
- */
603
- export interface SkuListResult extends Array<CatalogSku> {
604
- }
605
-
606
- /**
607
- * @interface
608
- * An interface representing the CommitmentAssociationListResult.
609
- * A page of commitment association resources.
610
- *
611
- * @extends Array<CommitmentAssociation>
612
- */
613
- export interface CommitmentAssociationListResult extends Array<CommitmentAssociation> {
614
- /**
615
- * @member {string} [nextLink] A URI to retrieve the next page of results.
616
- */
617
- nextLink?: string;
618
- }
619
-
620
- /**
621
- * @interface
622
- * An interface representing the CommitmentPlanListResult.
623
- * A page of commitment plan resources.
624
- *
625
- * @extends Array<CommitmentPlan>
626
- */
627
- export interface CommitmentPlanListResult extends Array<CommitmentPlan> {
628
- /**
629
- * @member {string} [nextLink] A URI to retrieve the next page of results.
630
- */
631
- nextLink?: string;
632
- }
633
-
634
- /**
635
- * @interface
636
- * An interface representing the PlanUsageHistoryListResult.
637
- * A page of usage history.
638
- *
639
- * @extends Array<PlanUsageHistory>
640
- */
641
- export interface PlanUsageHistoryListResult extends Array<PlanUsageHistory> {
642
- /**
643
- * @member {string} [nextLink] A URI to retrieve the next page of results.
644
- */
645
- nextLink?: string;
646
- }
647
-
648
- /**
649
- * Defines values for SkuCapacityScaleType.
650
- * Possible values include: 'Automatic', 'Manual', 'None'
651
- * @readonly
652
- * @enum {string}
653
- */
654
- export type SkuCapacityScaleType = 'Automatic' | 'Manual' | 'None';
655
-
656
- /**
657
- * Defines values for ResourceSkuRestrictionsType.
658
- * Possible values include: 'location', 'zone'
659
- * @readonly
660
- * @enum {string}
661
- */
662
- export type ResourceSkuRestrictionsType = 'location' | 'zone';
663
-
664
- /**
665
- * Defines values for ResourceSkuRestrictionsReasonCode.
666
- * Possible values include: 'QuotaId', 'NotAvailableForSubscription'
667
- * @readonly
668
- * @enum {string}
669
- */
670
- export type ResourceSkuRestrictionsReasonCode = 'QuotaId' | 'NotAvailableForSubscription';
671
-
672
- /**
673
- * Contains response data for the list operation.
674
- */
675
- export type SkusListResponse = SkuListResult & {
676
- /**
677
- * The underlying HTTP response.
678
- */
679
- _response: msRest.HttpResponse & {
680
- /**
681
- * The response body as text (string format)
682
- */
683
- bodyAsText: string;
684
- /**
685
- * The response body as parsed JSON or XML
686
- */
687
- parsedBody: SkuListResult;
688
- };
689
- };
690
-
691
- /**
692
- * Contains response data for the get operation.
693
- */
694
- export type CommitmentAssociationsGetResponse = CommitmentAssociation & {
695
- /**
696
- * The underlying HTTP response.
697
- */
698
- _response: msRest.HttpResponse & {
699
- /**
700
- * The response body as text (string format)
701
- */
702
- bodyAsText: string;
703
- /**
704
- * The response body as parsed JSON or XML
705
- */
706
- parsedBody: CommitmentAssociation;
707
- };
708
- };
709
-
710
- /**
711
- * Contains response data for the list operation.
712
- */
713
- export type CommitmentAssociationsListResponse = CommitmentAssociationListResult & {
714
- /**
715
- * The underlying HTTP response.
716
- */
717
- _response: msRest.HttpResponse & {
718
- /**
719
- * The response body as text (string format)
720
- */
721
- bodyAsText: string;
722
- /**
723
- * The response body as parsed JSON or XML
724
- */
725
- parsedBody: CommitmentAssociationListResult;
726
- };
727
- };
728
-
729
- /**
730
- * Contains response data for the move operation.
731
- */
732
- export type CommitmentAssociationsMoveResponse = CommitmentAssociation & {
733
- /**
734
- * The underlying HTTP response.
735
- */
736
- _response: msRest.HttpResponse & {
737
- /**
738
- * The response body as text (string format)
739
- */
740
- bodyAsText: string;
741
- /**
742
- * The response body as parsed JSON or XML
743
- */
744
- parsedBody: CommitmentAssociation;
745
- };
746
- };
747
-
748
- /**
749
- * Contains response data for the listNext operation.
750
- */
751
- export type CommitmentAssociationsListNextResponse = CommitmentAssociationListResult & {
752
- /**
753
- * The underlying HTTP response.
754
- */
755
- _response: msRest.HttpResponse & {
756
- /**
757
- * The response body as text (string format)
758
- */
759
- bodyAsText: string;
760
- /**
761
- * The response body as parsed JSON or XML
762
- */
763
- parsedBody: CommitmentAssociationListResult;
764
- };
765
- };
766
-
767
- /**
768
- * Contains response data for the get operation.
769
- */
770
- export type CommitmentPlansGetResponse = CommitmentPlan & {
771
- /**
772
- * The underlying HTTP response.
773
- */
774
- _response: msRest.HttpResponse & {
775
- /**
776
- * The response body as text (string format)
777
- */
778
- bodyAsText: string;
779
- /**
780
- * The response body as parsed JSON or XML
781
- */
782
- parsedBody: CommitmentPlan;
783
- };
784
- };
785
-
786
- /**
787
- * Contains response data for the createOrUpdate operation.
788
- */
789
- export type CommitmentPlansCreateOrUpdateResponse = CommitmentPlan & {
790
- /**
791
- * The underlying HTTP response.
792
- */
793
- _response: msRest.HttpResponse & {
794
- /**
795
- * The response body as text (string format)
796
- */
797
- bodyAsText: string;
798
- /**
799
- * The response body as parsed JSON or XML
800
- */
801
- parsedBody: CommitmentPlan;
802
- };
803
- };
804
-
805
- /**
806
- * Contains response data for the patch operation.
807
- */
808
- export type CommitmentPlansPatchResponse = CommitmentPlan & {
809
- /**
810
- * The underlying HTTP response.
811
- */
812
- _response: msRest.HttpResponse & {
813
- /**
814
- * The response body as text (string format)
815
- */
816
- bodyAsText: string;
817
- /**
818
- * The response body as parsed JSON or XML
819
- */
820
- parsedBody: CommitmentPlan;
821
- };
822
- };
823
-
824
- /**
825
- * Contains response data for the list operation.
826
- */
827
- export type CommitmentPlansListResponse = CommitmentPlanListResult & {
828
- /**
829
- * The underlying HTTP response.
830
- */
831
- _response: msRest.HttpResponse & {
832
- /**
833
- * The response body as text (string format)
834
- */
835
- bodyAsText: string;
836
- /**
837
- * The response body as parsed JSON or XML
838
- */
839
- parsedBody: CommitmentPlanListResult;
840
- };
841
- };
842
-
843
- /**
844
- * Contains response data for the listInResourceGroup operation.
845
- */
846
- export type CommitmentPlansListInResourceGroupResponse = CommitmentPlanListResult & {
847
- /**
848
- * The underlying HTTP response.
849
- */
850
- _response: msRest.HttpResponse & {
851
- /**
852
- * The response body as text (string format)
853
- */
854
- bodyAsText: string;
855
- /**
856
- * The response body as parsed JSON or XML
857
- */
858
- parsedBody: CommitmentPlanListResult;
859
- };
860
- };
861
-
862
- /**
863
- * Contains response data for the listNext operation.
864
- */
865
- export type CommitmentPlansListNextResponse = CommitmentPlanListResult & {
866
- /**
867
- * The underlying HTTP response.
868
- */
869
- _response: msRest.HttpResponse & {
870
- /**
871
- * The response body as text (string format)
872
- */
873
- bodyAsText: string;
874
- /**
875
- * The response body as parsed JSON or XML
876
- */
877
- parsedBody: CommitmentPlanListResult;
878
- };
879
- };
880
-
881
- /**
882
- * Contains response data for the listInResourceGroupNext operation.
883
- */
884
- export type CommitmentPlansListInResourceGroupNextResponse = CommitmentPlanListResult & {
885
- /**
886
- * The underlying HTTP response.
887
- */
888
- _response: msRest.HttpResponse & {
889
- /**
890
- * The response body as text (string format)
891
- */
892
- bodyAsText: string;
893
- /**
894
- * The response body as parsed JSON or XML
895
- */
896
- parsedBody: CommitmentPlanListResult;
897
- };
898
- };
899
-
900
- /**
901
- * Contains response data for the list operation.
902
- */
903
- export type UsageHistoryListResponse = PlanUsageHistoryListResult & {
904
- /**
905
- * The underlying HTTP response.
906
- */
907
- _response: msRest.HttpResponse & {
908
- /**
909
- * The response body as text (string format)
910
- */
911
- bodyAsText: string;
912
- /**
913
- * The response body as parsed JSON or XML
914
- */
915
- parsedBody: PlanUsageHistoryListResult;
916
- };
917
- };
918
-
919
- /**
920
- * Contains response data for the listNext operation.
921
- */
922
- export type UsageHistoryListNextResponse = PlanUsageHistoryListResult & {
923
- /**
924
- * The underlying HTTP response.
925
- */
926
- _response: msRest.HttpResponse & {
927
- /**
928
- * The response body as text (string format)
929
- */
930
- bodyAsText: string;
931
- /**
932
- * The response body as parsed JSON or XML
933
- */
934
- parsedBody: PlanUsageHistoryListResult;
935
- };
936
- };