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