@azure/arm-reservations 7.2.1-alpha.20230202.1 → 8.0.0-alpha.20230210.2
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.
- package/CHANGELOG.md +71 -8
- package/LICENSE +1 -1
- package/dist/index.js +942 -224
- package/dist/index.js.map +1 -1
- package/dist/index.min.js +1 -1
- package/dist/index.min.js.map +1 -1
- package/dist-esm/samples-dev/calculateExchangePostSample.js +22 -2
- package/dist-esm/samples-dev/calculateExchangePostSample.js.map +1 -1
- package/dist-esm/samples-dev/calculateRefundPostSample.js +10 -3
- package/dist-esm/samples-dev/calculateRefundPostSample.js.map +1 -1
- package/dist-esm/samples-dev/exchangePostSample.js +9 -2
- package/dist-esm/samples-dev/exchangePostSample.js.map +1 -1
- package/dist-esm/samples-dev/getAppliedReservationListSample.js +9 -2
- package/dist-esm/samples-dev/getAppliedReservationListSample.js.map +1 -1
- package/dist-esm/samples-dev/getCatalogSample.js +26 -5
- package/dist-esm/samples-dev/getCatalogSample.js.map +1 -1
- package/dist-esm/samples-dev/operationListSample.js +9 -2
- package/dist-esm/samples-dev/operationListSample.js.map +1 -1
- package/dist-esm/samples-dev/quotaCreateOrUpdateSample.js +10 -3
- package/dist-esm/samples-dev/quotaCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/quotaGetSample.js +8 -1
- package/dist-esm/samples-dev/quotaGetSample.js.map +1 -1
- package/dist-esm/samples-dev/quotaListSample.js +9 -2
- package/dist-esm/samples-dev/quotaListSample.js.map +1 -1
- package/dist-esm/samples-dev/quotaRequestStatusGetSample.js +10 -3
- package/dist-esm/samples-dev/quotaRequestStatusGetSample.js.map +1 -1
- package/dist-esm/samples-dev/quotaRequestStatusListSample.js +8 -1
- package/dist-esm/samples-dev/quotaRequestStatusListSample.js.map +1 -1
- package/dist-esm/samples-dev/quotaUpdateSample.js +8 -1
- package/dist-esm/samples-dev/quotaUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationArchiveSample.js +9 -2
- package/dist-esm/samples-dev/reservationArchiveSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationAvailableScopesSample.js +11 -4
- package/dist-esm/samples-dev/reservationAvailableScopesSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationGetSample.js +11 -4
- package/dist-esm/samples-dev/reservationGetSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationListAllSample.js +10 -3
- package/dist-esm/samples-dev/reservationListAllSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationListRevisionsSample.js +11 -4
- package/dist-esm/samples-dev/reservationListRevisionsSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationListSample.js +9 -2
- package/dist-esm/samples-dev/reservationListSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationMergeSample.js +9 -2
- package/dist-esm/samples-dev/reservationMergeSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationOrderCalculateSample.js +10 -3
- package/dist-esm/samples-dev/reservationOrderCalculateSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationOrderChangeDirectorySample.js +9 -2
- package/dist-esm/samples-dev/reservationOrderChangeDirectorySample.js.map +1 -1
- package/dist-esm/samples-dev/reservationOrderGetSample.js +12 -5
- package/dist-esm/samples-dev/reservationOrderGetSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationOrderListSample.js +9 -2
- package/dist-esm/samples-dev/reservationOrderListSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationOrderPurchaseSample.js +9 -2
- package/dist-esm/samples-dev/reservationOrderPurchaseSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationSplitSample.js +9 -2
- package/dist-esm/samples-dev/reservationSplitSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationUnarchiveSample.js +11 -4
- package/dist-esm/samples-dev/reservationUnarchiveSample.js.map +1 -1
- package/dist-esm/samples-dev/reservationUpdateSample.js +9 -2
- package/dist-esm/samples-dev/reservationUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/returnPostSample.js +14 -7
- package/dist-esm/samples-dev/returnPostSample.js.map +1 -1
- package/dist-esm/src/azureReservationAPI.d.ts +18 -2
- package/dist-esm/src/azureReservationAPI.d.ts.map +1 -1
- package/dist-esm/src/azureReservationAPI.js +101 -15
- package/dist-esm/src/azureReservationAPI.js.map +1 -1
- package/dist-esm/src/index.d.ts +1 -0
- package/dist-esm/src/index.d.ts.map +1 -1
- package/dist-esm/src/index.js +1 -0
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/models/index.d.ts +372 -101
- package/dist-esm/src/models/index.d.ts.map +1 -1
- package/dist-esm/src/models/index.js +26 -0
- package/dist-esm/src/models/index.js.map +1 -1
- package/dist-esm/src/models/mappers.d.ts +14 -1
- package/dist-esm/src/models/mappers.d.ts.map +1 -1
- package/dist-esm/src/models/mappers.js +510 -70
- package/dist-esm/src/models/mappers.js.map +1 -1
- package/dist-esm/src/models/parameters.d.ts +2 -1
- package/dist-esm/src/models/parameters.d.ts.map +1 -1
- package/dist-esm/src/models/parameters.js +18 -9
- package/dist-esm/src/models/parameters.js.map +1 -1
- package/dist-esm/src/operations/operation.d.ts.map +1 -1
- package/dist-esm/src/operations/operation.js +19 -8
- package/dist-esm/src/operations/operation.js.map +1 -1
- package/dist-esm/src/operations/quota.d.ts.map +1 -1
- package/dist-esm/src/operations/quota.js +19 -8
- package/dist-esm/src/operations/quota.js.map +1 -1
- package/dist-esm/src/operations/quotaRequestStatus.d.ts.map +1 -1
- package/dist-esm/src/operations/quotaRequestStatus.js +19 -13
- package/dist-esm/src/operations/quotaRequestStatus.js.map +1 -1
- package/dist-esm/src/operations/reservation.d.ts +17 -17
- package/dist-esm/src/operations/reservation.d.ts.map +1 -1
- package/dist-esm/src/operations/reservation.js +83 -59
- package/dist-esm/src/operations/reservation.js.map +1 -1
- package/dist-esm/src/operations/reservationOrder.d.ts.map +1 -1
- package/dist-esm/src/operations/reservationOrder.js +20 -9
- package/dist-esm/src/operations/reservationOrder.js.map +1 -1
- package/dist-esm/src/operations/return.d.ts +10 -2
- package/dist-esm/src/operations/return.d.ts.map +1 -1
- package/dist-esm/src/operations/return.js +61 -3
- package/dist-esm/src/operations/return.js.map +1 -1
- package/dist-esm/src/operationsInterfaces/reservation.d.ts +15 -15
- package/dist-esm/src/operationsInterfaces/reservation.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/return.d.ts +10 -2
- package/dist-esm/src/operationsInterfaces/return.d.ts.map +1 -1
- package/dist-esm/src/pagingHelper.d.ts +13 -0
- package/dist-esm/src/pagingHelper.d.ts.map +1 -0
- package/dist-esm/src/pagingHelper.js +32 -0
- package/dist-esm/src/pagingHelper.js.map +1 -0
- package/package.json +6 -4
- package/review/arm-reservations.api.md +194 -94
- package/src/azureReservationAPI.ts +119 -15
- package/src/index.ts +1 -0
- package/src/models/index.ts +397 -107
- package/src/models/mappers.ts +536 -71
- package/src/models/parameters.ts +19 -9
- package/src/operations/operation.ts +21 -9
- package/src/operations/quota.ts +23 -15
- package/src/operations/quotaRequestStatus.ts +23 -20
- package/src/operations/reservation.ts +97 -69
- package/src/operations/reservationOrder.ts +23 -11
- package/src/operations/return.ts +82 -4
- package/src/operationsInterfaces/reservation.ts +15 -15
- package/src/operationsInterfaces/return.ts +16 -2
- package/src/pagingHelper.ts +39 -0
- package/types/arm-reservations.d.ts +432 -109
- package/types/tsdoc-metadata.json +1 -1
|
@@ -4,12 +4,14 @@ import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
|
4
4
|
import { PollerLike } from '@azure/core-lro';
|
|
5
5
|
import { PollOperationState } from '@azure/core-lro';
|
|
6
6
|
|
|
7
|
+
/** Paginated list of applied reservations */
|
|
7
8
|
export declare interface AppliedReservationList {
|
|
8
9
|
value?: string[];
|
|
9
10
|
/** Url to get the next page of reservations */
|
|
10
11
|
nextLink?: string;
|
|
11
12
|
}
|
|
12
13
|
|
|
14
|
+
/** The response for applied reservations api */
|
|
13
15
|
export declare interface AppliedReservations {
|
|
14
16
|
/**
|
|
15
17
|
* Identifier of the applied reservations
|
|
@@ -26,20 +28,38 @@ export declare interface AppliedReservations {
|
|
|
26
28
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
27
29
|
*/
|
|
28
30
|
readonly type?: string;
|
|
31
|
+
/** Paginated list of applied reservations */
|
|
29
32
|
reservationOrderIds?: AppliedReservationList;
|
|
30
33
|
}
|
|
31
34
|
|
|
35
|
+
/** Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup */
|
|
36
|
+
export declare interface AppliedScopeProperties {
|
|
37
|
+
/** Tenant ID where the savings plan should apply benefit. */
|
|
38
|
+
tenantId?: string;
|
|
39
|
+
/** Fully-qualified identifier of the management group where the benefit must be applied. */
|
|
40
|
+
managementGroupId?: string;
|
|
41
|
+
/** Fully-qualified identifier of the subscription. */
|
|
42
|
+
subscriptionId?: string;
|
|
43
|
+
/** Fully-qualified identifier of the resource group. */
|
|
44
|
+
resourceGroupId?: string;
|
|
45
|
+
/** Display name */
|
|
46
|
+
displayName?: string;
|
|
47
|
+
}
|
|
48
|
+
|
|
32
49
|
/**
|
|
33
50
|
* Defines values for AppliedScopeType. \
|
|
34
51
|
* {@link KnownAppliedScopeType} can be used interchangeably with AppliedScopeType,
|
|
35
52
|
* this enum contains the known values that the service supports.
|
|
36
53
|
* ### Known values supported by the service
|
|
37
54
|
* **Single** \
|
|
38
|
-
* **Shared**
|
|
55
|
+
* **Shared** \
|
|
56
|
+
* **ManagementGroup**
|
|
39
57
|
*/
|
|
40
58
|
export declare type AppliedScopeType = string;
|
|
41
59
|
|
|
60
|
+
/** The response of available scope api containing scopes and their eligibilities. */
|
|
42
61
|
export declare interface AvailableScopeProperties {
|
|
62
|
+
/** The scopes checked by the available scope api. */
|
|
43
63
|
properties?: SubscriptionScopeProperties;
|
|
44
64
|
}
|
|
45
65
|
|
|
@@ -67,7 +87,15 @@ export declare class AzureReservationAPI extends coreClient.ServiceClient {
|
|
|
67
87
|
* @param subscriptionId Id of the subscription
|
|
68
88
|
* @param options The options parameters.
|
|
69
89
|
*/
|
|
70
|
-
|
|
90
|
+
listCatalog(subscriptionId: string, options?: GetCatalogOptionalParams): PagedAsyncIterableIterator<Catalog>;
|
|
91
|
+
private getCatalogPagingPage;
|
|
92
|
+
private getCatalogPagingAll;
|
|
93
|
+
/**
|
|
94
|
+
* Get the regions and skus that are available for RI purchase for the specified Azure subscription.
|
|
95
|
+
* @param subscriptionId Id of the subscription
|
|
96
|
+
* @param options The options parameters.
|
|
97
|
+
*/
|
|
98
|
+
private _getCatalog;
|
|
71
99
|
/**
|
|
72
100
|
* Get applicable `Reservation`s that are applied to this subscription or a resource group under this
|
|
73
101
|
* subscription.
|
|
@@ -75,6 +103,13 @@ export declare class AzureReservationAPI extends coreClient.ServiceClient {
|
|
|
75
103
|
* @param options The options parameters.
|
|
76
104
|
*/
|
|
77
105
|
getAppliedReservationList(subscriptionId: string, options?: GetAppliedReservationListOptionalParams): Promise<GetAppliedReservationListResponse>;
|
|
106
|
+
/**
|
|
107
|
+
* GetCatalogNext
|
|
108
|
+
* @param subscriptionId Id of the subscription
|
|
109
|
+
* @param nextLink The nextLink from the previous successful call to the GetCatalog method.
|
|
110
|
+
* @param options The options parameters.
|
|
111
|
+
*/
|
|
112
|
+
private _getCatalogNext;
|
|
78
113
|
reservation: Reservation;
|
|
79
114
|
reservationOrder: ReservationOrder;
|
|
80
115
|
operation: Operation;
|
|
@@ -96,11 +131,23 @@ export declare interface AzureReservationAPIOptionalParams extends coreClient.Se
|
|
|
96
131
|
|
|
97
132
|
/** billing information */
|
|
98
133
|
export declare interface BillingInformation {
|
|
134
|
+
/** Pricing information containing the amount and the currency code */
|
|
99
135
|
billingCurrencyTotalPaidAmount?: Price;
|
|
136
|
+
/** Pricing information containing the amount and the currency code */
|
|
100
137
|
billingCurrencyProratedAmount?: Price;
|
|
138
|
+
/** Pricing information containing the amount and the currency code */
|
|
101
139
|
billingCurrencyRemainingCommitmentAmount?: Price;
|
|
102
140
|
}
|
|
103
141
|
|
|
142
|
+
/**
|
|
143
|
+
* Defines values for BillingPlan. \
|
|
144
|
+
* {@link KnownBillingPlan} can be used interchangeably with BillingPlan,
|
|
145
|
+
* this enum contains the known values that the service supports.
|
|
146
|
+
* ### Known values supported by the service
|
|
147
|
+
* **P1M**
|
|
148
|
+
*/
|
|
149
|
+
export declare type BillingPlan = string;
|
|
150
|
+
|
|
104
151
|
/** Interface representing a CalculateExchange. */
|
|
105
152
|
export declare interface CalculateExchange {
|
|
106
153
|
/**
|
|
@@ -176,6 +223,8 @@ export declare interface CalculateExchangeRequest {
|
|
|
176
223
|
export declare interface CalculateExchangeRequestProperties {
|
|
177
224
|
/** List of reservations that are being purchased in this exchange. */
|
|
178
225
|
reservationsToPurchase?: PurchaseRequest[];
|
|
226
|
+
/** List of savings plans that are being purchased in this exchange. */
|
|
227
|
+
savingsPlansToPurchase?: SavingsPlanPurchaseRequest[];
|
|
179
228
|
/** List of reservations that are being returned in this exchange. */
|
|
180
229
|
reservationsToExchange?: ReservationToReturn[];
|
|
181
230
|
}
|
|
@@ -184,21 +233,29 @@ export declare interface CalculateExchangeRequestProperties {
|
|
|
184
233
|
export declare interface CalculateExchangeResponseProperties {
|
|
185
234
|
/** Exchange session identifier */
|
|
186
235
|
sessionId?: string;
|
|
236
|
+
/** Pricing information containing the amount and the currency code */
|
|
187
237
|
netPayable?: Price;
|
|
238
|
+
/** Pricing information containing the amount and the currency code */
|
|
188
239
|
refundsTotal?: Price;
|
|
240
|
+
/** Pricing information containing the amount and the currency code */
|
|
189
241
|
purchasesTotal?: Price;
|
|
190
242
|
/** Details of the reservations being purchased */
|
|
191
243
|
reservationsToPurchase?: ReservationToPurchaseCalculateExchange[];
|
|
244
|
+
/** Details of the savings plans being purchased */
|
|
245
|
+
savingsPlansToPurchase?: SavingsPlanToPurchaseCalculateExchange[];
|
|
192
246
|
/** Details of the reservations being returned */
|
|
193
247
|
reservationsToExchange?: ReservationToExchange[];
|
|
194
248
|
/** Exchange policy errors */
|
|
195
249
|
policyResult?: ExchangePolicyErrors;
|
|
196
250
|
}
|
|
197
251
|
|
|
252
|
+
/** The response of calculate price for reservation. */
|
|
198
253
|
export declare interface CalculatePriceResponse {
|
|
254
|
+
/** Properties for calculate price response */
|
|
199
255
|
properties?: CalculatePriceResponseProperties;
|
|
200
256
|
}
|
|
201
257
|
|
|
258
|
+
/** Properties for calculate price response */
|
|
202
259
|
export declare interface CalculatePriceResponseProperties {
|
|
203
260
|
/** Currency and amount that customer will be charged in customer's local currency. Tax is not included. */
|
|
204
261
|
billingCurrencyTotal?: CalculatePriceResponsePropertiesBillingCurrencyTotal;
|
|
@@ -214,9 +271,9 @@ export declare interface CalculatePriceResponseProperties {
|
|
|
214
271
|
isBillingPartnerManaged?: boolean;
|
|
215
272
|
/** GUID that represents reservation order that can be placed after calculating price. */
|
|
216
273
|
reservationOrderId?: string;
|
|
217
|
-
/** Title of
|
|
274
|
+
/** Title of sku that is being purchased. */
|
|
218
275
|
skuTitle?: string;
|
|
219
|
-
/** Description of
|
|
276
|
+
/** Description of sku that is being purchased. */
|
|
220
277
|
skuDescription?: string;
|
|
221
278
|
/** Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. */
|
|
222
279
|
pricingCurrencyTotal?: CalculatePriceResponsePropertiesPricingCurrencyTotal;
|
|
@@ -257,12 +314,15 @@ export declare interface CalculateRefundPostOptionalParams extends coreClient.Op
|
|
|
257
314
|
/** Contains response data for the post operation. */
|
|
258
315
|
export declare type CalculateRefundPostResponse = CalculateRefundResponse;
|
|
259
316
|
|
|
317
|
+
/** Request containing information needed for calculating refund. */
|
|
260
318
|
export declare interface CalculateRefundRequest {
|
|
261
319
|
/** Fully qualified identifier of the reservation order being returned */
|
|
262
320
|
id?: string;
|
|
321
|
+
/** Properties needed for calculate refund including the scope and the reservation to be returned. */
|
|
263
322
|
properties?: CalculateRefundRequestProperties;
|
|
264
323
|
}
|
|
265
324
|
|
|
325
|
+
/** Properties needed for calculate refund including the scope and the reservation to be returned. */
|
|
266
326
|
export declare interface CalculateRefundRequestProperties {
|
|
267
327
|
/** The scope of the refund, e.g. Reservation */
|
|
268
328
|
scope?: string;
|
|
@@ -270,24 +330,27 @@ export declare interface CalculateRefundRequestProperties {
|
|
|
270
330
|
reservationToReturn?: ReservationToReturn;
|
|
271
331
|
}
|
|
272
332
|
|
|
333
|
+
/** The response of calculate refund containing refund information of reservation */
|
|
273
334
|
export declare interface CalculateRefundResponse {
|
|
274
335
|
/** Fully qualified identifier of the reservation being returned */
|
|
275
336
|
id?: string;
|
|
337
|
+
/** The refund properties of reservation */
|
|
276
338
|
properties?: RefundResponseProperties;
|
|
277
339
|
}
|
|
278
340
|
|
|
341
|
+
/** Product details of a type of resource. */
|
|
279
342
|
export declare interface Catalog {
|
|
280
343
|
/**
|
|
281
|
-
* The type of resource the
|
|
344
|
+
* The type of resource the sku applies to.
|
|
282
345
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
283
346
|
*/
|
|
284
347
|
readonly resourceType?: string;
|
|
285
348
|
/**
|
|
286
|
-
* The name of
|
|
349
|
+
* The name of sku
|
|
287
350
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
288
351
|
*/
|
|
289
352
|
readonly name?: string;
|
|
290
|
-
/** The billing plan options available for this
|
|
353
|
+
/** The billing plan options available for this sku. */
|
|
291
354
|
billingPlans?: {
|
|
292
355
|
[propertyName: string]: ReservationBillingPlan[];
|
|
293
356
|
};
|
|
@@ -301,19 +364,19 @@ export declare interface Catalog {
|
|
|
301
364
|
/** NOTE: This property will not be serialized. It can only be populated by the server. */
|
|
302
365
|
readonly skuProperties?: SkuProperty[];
|
|
303
366
|
/**
|
|
304
|
-
* Pricing information about the
|
|
367
|
+
* Pricing information about the sku
|
|
305
368
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
306
369
|
*/
|
|
307
370
|
readonly msrp?: CatalogMsrp;
|
|
308
371
|
/** NOTE: This property will not be serialized. It can only be populated by the server. */
|
|
309
372
|
readonly restrictions?: SkuRestriction[];
|
|
310
373
|
/**
|
|
311
|
-
* The tier of this
|
|
374
|
+
* The tier of this sku
|
|
312
375
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
313
376
|
*/
|
|
314
377
|
readonly tier?: string;
|
|
315
378
|
/**
|
|
316
|
-
* The size of this
|
|
379
|
+
* The size of this sku
|
|
317
380
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
318
381
|
*/
|
|
319
382
|
readonly size?: string;
|
|
@@ -321,12 +384,29 @@ export declare interface Catalog {
|
|
|
321
384
|
readonly capabilities?: SkuCapability[];
|
|
322
385
|
}
|
|
323
386
|
|
|
324
|
-
/** Pricing information about the
|
|
387
|
+
/** Pricing information about the sku */
|
|
325
388
|
export declare interface CatalogMsrp {
|
|
326
389
|
/** Amount in pricing currency. Tax not included. */
|
|
327
390
|
p1Y?: Price;
|
|
328
391
|
}
|
|
329
392
|
|
|
393
|
+
/** The list of catalogs and pagination information. */
|
|
394
|
+
export declare interface CatalogsResult {
|
|
395
|
+
/**
|
|
396
|
+
* The list of catalogs.
|
|
397
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
398
|
+
*/
|
|
399
|
+
readonly value?: Catalog[];
|
|
400
|
+
/**
|
|
401
|
+
* The link (url) to the next page of results.
|
|
402
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
403
|
+
*/
|
|
404
|
+
readonly nextLink?: string;
|
|
405
|
+
/** The total amount of catalog items. */
|
|
406
|
+
totalItems?: number;
|
|
407
|
+
}
|
|
408
|
+
|
|
409
|
+
/** Request body for change directory of a reservation. */
|
|
330
410
|
export declare interface ChangeDirectoryRequest {
|
|
331
411
|
/** Tenant id GUID that reservation order is to be transferred to */
|
|
332
412
|
destinationTenantId?: string;
|
|
@@ -351,6 +431,21 @@ export declare interface ChangeDirectoryResult {
|
|
|
351
431
|
error?: string;
|
|
352
432
|
}
|
|
353
433
|
|
|
434
|
+
/** Commitment towards the benefit. */
|
|
435
|
+
export declare interface Commitment extends Price {
|
|
436
|
+
/** Commitment grain. */
|
|
437
|
+
grain?: CommitmentGrain;
|
|
438
|
+
}
|
|
439
|
+
|
|
440
|
+
/**
|
|
441
|
+
* Defines values for CommitmentGrain. \
|
|
442
|
+
* {@link KnownCommitmentGrain} can be used interchangeably with CommitmentGrain,
|
|
443
|
+
* this enum contains the known values that the service supports.
|
|
444
|
+
* ### Known values supported by the service
|
|
445
|
+
* **Hourly**
|
|
446
|
+
*/
|
|
447
|
+
export declare type CommitmentGrain = string;
|
|
448
|
+
|
|
354
449
|
/**
|
|
355
450
|
* Defines values for CreatedByType. \
|
|
356
451
|
* {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
|
|
@@ -432,7 +527,9 @@ export declare interface CurrentQuotaLimitBase {
|
|
|
432
527
|
* **Pending** \
|
|
433
528
|
* **Processing** \
|
|
434
529
|
* **Cancelled** \
|
|
435
|
-
* **Failed**
|
|
530
|
+
* **Failed** \
|
|
531
|
+
* **Warning** \
|
|
532
|
+
* **NoBenefit**
|
|
436
533
|
*/
|
|
437
534
|
export declare type DisplayProvisioningState = string;
|
|
438
535
|
|
|
@@ -455,7 +552,9 @@ export declare interface ErrorDetails {
|
|
|
455
552
|
readonly target?: string;
|
|
456
553
|
}
|
|
457
554
|
|
|
555
|
+
/** Error information */
|
|
458
556
|
export declare interface ErrorModel {
|
|
557
|
+
/** Extended error information including error code and error message */
|
|
459
558
|
error?: ExtendedErrorInfo;
|
|
460
559
|
}
|
|
461
560
|
|
|
@@ -631,18 +730,25 @@ export declare interface ExchangeRequestProperties {
|
|
|
631
730
|
export declare interface ExchangeResponseProperties {
|
|
632
731
|
/** Exchange session identifier */
|
|
633
732
|
sessionId?: string;
|
|
733
|
+
/** Pricing information containing the amount and the currency code */
|
|
634
734
|
netPayable?: Price;
|
|
735
|
+
/** Pricing information containing the amount and the currency code */
|
|
635
736
|
refundsTotal?: Price;
|
|
737
|
+
/** Pricing information containing the amount and the currency code */
|
|
636
738
|
purchasesTotal?: Price;
|
|
637
739
|
/** Details of the reservations being purchased */
|
|
638
740
|
reservationsToPurchase?: ReservationToPurchaseExchange[];
|
|
741
|
+
/** Details of the savings plans being purchased */
|
|
742
|
+
savingsPlansToPurchase?: SavingsPlanToPurchaseExchange[];
|
|
639
743
|
/** Details of the reservations being returned */
|
|
640
744
|
reservationsToExchange?: ReservationToReturnForExchange[];
|
|
641
745
|
/** Exchange policy errors */
|
|
642
746
|
policyResult?: ExchangePolicyErrors;
|
|
643
747
|
}
|
|
644
748
|
|
|
749
|
+
/** Extended error information including error code and error message */
|
|
645
750
|
export declare interface ExtendedErrorInfo {
|
|
751
|
+
/** Error code describing the reason that service is not able to process the incoming request */
|
|
646
752
|
code?: ErrorResponseCode;
|
|
647
753
|
message?: string;
|
|
648
754
|
}
|
|
@@ -660,11 +766,20 @@ export declare interface GetAppliedReservationListOptionalParams extends coreCli
|
|
|
660
766
|
/** Contains response data for the getAppliedReservationList operation. */
|
|
661
767
|
export declare type GetAppliedReservationListResponse = AppliedReservations;
|
|
662
768
|
|
|
769
|
+
/** Optional parameters. */
|
|
770
|
+
export declare interface GetCatalogNextOptionalParams extends coreClient.OperationOptions {
|
|
771
|
+
}
|
|
772
|
+
|
|
773
|
+
/** Contains response data for the getCatalogNext operation. */
|
|
774
|
+
export declare type GetCatalogNextResponse = CatalogsResult;
|
|
775
|
+
|
|
663
776
|
/** Optional parameters. */
|
|
664
777
|
export declare interface GetCatalogOptionalParams extends coreClient.OperationOptions {
|
|
778
|
+
/** May be used to filter by Catalog properties. The filter supports 'eq', 'or', and 'and'. */
|
|
779
|
+
filter?: string;
|
|
665
780
|
/** The type of the resource for which the skus should be provided. */
|
|
666
781
|
reservedResourceType?: string;
|
|
667
|
-
/** Filters the skus based on the location specified in this parameter. This can be an
|
|
782
|
+
/** Filters the skus based on the location specified in this parameter. This can be an Azure region or global */
|
|
668
783
|
location?: string;
|
|
669
784
|
/** Publisher id used to get the third party products */
|
|
670
785
|
publisherId?: string;
|
|
@@ -672,10 +787,23 @@ export declare interface GetCatalogOptionalParams extends coreClient.OperationOp
|
|
|
672
787
|
offerId?: string;
|
|
673
788
|
/** Plan id used to get the third party products */
|
|
674
789
|
planId?: string;
|
|
790
|
+
/** The number of reservations to skip from the list before returning results */
|
|
791
|
+
skip?: number;
|
|
792
|
+
/** To number of reservations to return */
|
|
793
|
+
take?: number;
|
|
675
794
|
}
|
|
676
795
|
|
|
677
796
|
/** Contains response data for the getCatalog operation. */
|
|
678
|
-
export declare type GetCatalogResponse =
|
|
797
|
+
export declare type GetCatalogResponse = CatalogsResult;
|
|
798
|
+
|
|
799
|
+
/**
|
|
800
|
+
* Given the last `.value` produced by the `byPage` iterator,
|
|
801
|
+
* returns a continuation token that can be used to begin paging from
|
|
802
|
+
* that point later.
|
|
803
|
+
* @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
|
|
804
|
+
* @returns The continuation token that can be passed into byPage() during future calls.
|
|
805
|
+
*/
|
|
806
|
+
export declare function getContinuationToken(page: unknown): string | undefined;
|
|
679
807
|
|
|
680
808
|
/**
|
|
681
809
|
* Defines values for InstanceFlexibility. \
|
|
@@ -692,7 +820,15 @@ export declare enum KnownAppliedScopeType {
|
|
|
692
820
|
/** Single */
|
|
693
821
|
Single = "Single",
|
|
694
822
|
/** Shared */
|
|
695
|
-
Shared = "Shared"
|
|
823
|
+
Shared = "Shared",
|
|
824
|
+
/** ManagementGroup */
|
|
825
|
+
ManagementGroup = "ManagementGroup"
|
|
826
|
+
}
|
|
827
|
+
|
|
828
|
+
/** Known values of {@link BillingPlan} that the service accepts. */
|
|
829
|
+
export declare enum KnownBillingPlan {
|
|
830
|
+
/** P1M */
|
|
831
|
+
P1M = "P1M"
|
|
696
832
|
}
|
|
697
833
|
|
|
698
834
|
/** Known values of {@link CalculateExchangeOperationResultStatus} that the service accepts. */
|
|
@@ -707,6 +843,12 @@ export declare enum KnownCalculateExchangeOperationResultStatus {
|
|
|
707
843
|
Pending = "Pending"
|
|
708
844
|
}
|
|
709
845
|
|
|
846
|
+
/** Known values of {@link CommitmentGrain} that the service accepts. */
|
|
847
|
+
export declare enum KnownCommitmentGrain {
|
|
848
|
+
/** Hourly */
|
|
849
|
+
Hourly = "Hourly"
|
|
850
|
+
}
|
|
851
|
+
|
|
710
852
|
/** Known values of {@link CreatedByType} that the service accepts. */
|
|
711
853
|
export declare enum KnownCreatedByType {
|
|
712
854
|
/** User */
|
|
@@ -734,7 +876,11 @@ export declare enum KnownDisplayProvisioningState {
|
|
|
734
876
|
/** Cancelled */
|
|
735
877
|
Cancelled = "Cancelled",
|
|
736
878
|
/** Failed */
|
|
737
|
-
Failed = "Failed"
|
|
879
|
+
Failed = "Failed",
|
|
880
|
+
/** Warning */
|
|
881
|
+
Warning = "Warning",
|
|
882
|
+
/** NoBenefit */
|
|
883
|
+
NoBenefit = "NoBenefit"
|
|
738
884
|
}
|
|
739
885
|
|
|
740
886
|
/** Known values of {@link ErrorResponseCode} that the service accepts. */
|
|
@@ -1111,6 +1257,14 @@ export declare enum KnownResourceType {
|
|
|
1111
1257
|
ServiceSpecific = "serviceSpecific"
|
|
1112
1258
|
}
|
|
1113
1259
|
|
|
1260
|
+
/** Known values of {@link SavingsPlanTerm} that the service accepts. */
|
|
1261
|
+
export declare enum KnownSavingsPlanTerm {
|
|
1262
|
+
/** P1Y */
|
|
1263
|
+
P1Y = "P1Y",
|
|
1264
|
+
/** P3Y */
|
|
1265
|
+
P3Y = "P3Y"
|
|
1266
|
+
}
|
|
1267
|
+
|
|
1114
1268
|
/** Known values of {@link UserFriendlyAppliedScopeType} that the service accepts. */
|
|
1115
1269
|
export declare enum KnownUserFriendlyAppliedScopeType {
|
|
1116
1270
|
/** None */
|
|
@@ -1172,6 +1326,7 @@ export declare enum KnownUserFriendlyRenewState {
|
|
|
1172
1326
|
declare type Location_2 = string;
|
|
1173
1327
|
export { Location_2 as Location }
|
|
1174
1328
|
|
|
1329
|
+
/** The request for reservation merge */
|
|
1175
1330
|
export declare interface MergeRequest {
|
|
1176
1331
|
/** Format of the resource id should be /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} */
|
|
1177
1332
|
sources?: string[];
|
|
@@ -1186,6 +1341,7 @@ export declare interface Operation {
|
|
|
1186
1341
|
list(options?: OperationListOptionalParams): PagedAsyncIterableIterator<OperationResponse>;
|
|
1187
1342
|
}
|
|
1188
1343
|
|
|
1344
|
+
/** Information about an operation */
|
|
1189
1345
|
export declare interface OperationDisplay {
|
|
1190
1346
|
provider?: string;
|
|
1191
1347
|
resource?: string;
|
|
@@ -1193,6 +1349,7 @@ export declare interface OperationDisplay {
|
|
|
1193
1349
|
description?: string;
|
|
1194
1350
|
}
|
|
1195
1351
|
|
|
1352
|
+
/** Paginated list of operations */
|
|
1196
1353
|
export declare interface OperationList {
|
|
1197
1354
|
value?: OperationResponse[];
|
|
1198
1355
|
/** Url to get the next page of items. */
|
|
@@ -1213,6 +1370,7 @@ export declare interface OperationListOptionalParams extends coreClient.Operatio
|
|
|
1213
1370
|
/** Contains response data for the list operation. */
|
|
1214
1371
|
export declare type OperationListResponse = OperationList;
|
|
1215
1372
|
|
|
1373
|
+
/** The response containing operation information */
|
|
1216
1374
|
export declare interface OperationResponse {
|
|
1217
1375
|
/** Name of the operation */
|
|
1218
1376
|
name?: string;
|
|
@@ -1246,21 +1404,27 @@ export declare interface OperationResultError {
|
|
|
1246
1404
|
*/
|
|
1247
1405
|
export declare type OperationStatus = string;
|
|
1248
1406
|
|
|
1407
|
+
/** The request for reservation patch */
|
|
1249
1408
|
export declare interface Patch {
|
|
1250
1409
|
/** Type of the Applied Scope. */
|
|
1251
1410
|
appliedScopeType?: AppliedScopeType;
|
|
1252
1411
|
/** List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. */
|
|
1253
1412
|
appliedScopes?: string[];
|
|
1413
|
+
/** Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup */
|
|
1414
|
+
appliedScopeProperties?: AppliedScopeProperties;
|
|
1254
1415
|
/** Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. */
|
|
1255
1416
|
instanceFlexibility?: InstanceFlexibility;
|
|
1256
|
-
/**
|
|
1417
|
+
/** Display name of the reservation */
|
|
1257
1418
|
name?: string;
|
|
1258
1419
|
/** Setting this to true will automatically purchase a new reservation on the expiration date time. */
|
|
1259
1420
|
renew?: boolean;
|
|
1260
1421
|
renewProperties?: PatchPropertiesRenewProperties;
|
|
1422
|
+
/** This is the date-time when the Azure hybrid benefit needs to be reviewed. */
|
|
1423
|
+
reviewDateTime?: Date;
|
|
1261
1424
|
}
|
|
1262
1425
|
|
|
1263
1426
|
export declare interface PatchPropertiesRenewProperties {
|
|
1427
|
+
/** The request for reservation purchase */
|
|
1264
1428
|
purchaseProperties?: PurchaseRequest;
|
|
1265
1429
|
}
|
|
1266
1430
|
|
|
@@ -1293,6 +1457,7 @@ export declare interface PaymentDetail {
|
|
|
1293
1457
|
*/
|
|
1294
1458
|
export declare type PaymentStatus = string;
|
|
1295
1459
|
|
|
1460
|
+
/** Pricing information containing the amount and the currency code */
|
|
1296
1461
|
export declare interface Price {
|
|
1297
1462
|
/** The ISO 4217 3-letter currency code for the currency used by this purchase record. */
|
|
1298
1463
|
currencyCode?: string;
|
|
@@ -1320,30 +1485,40 @@ export declare interface Price {
|
|
|
1320
1485
|
*/
|
|
1321
1486
|
export declare type ProvisioningState = string;
|
|
1322
1487
|
|
|
1488
|
+
/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
|
|
1489
|
+
export declare interface ProxyResource extends Resource {
|
|
1490
|
+
}
|
|
1491
|
+
|
|
1492
|
+
/** The request for reservation purchase */
|
|
1323
1493
|
export declare interface PurchaseRequest {
|
|
1494
|
+
/** The name of sku */
|
|
1324
1495
|
sku?: SkuName;
|
|
1325
|
-
/** The Azure
|
|
1496
|
+
/** The Azure region where the reserved resource lives. */
|
|
1326
1497
|
location?: string;
|
|
1327
1498
|
/** The type of the resource that is being reserved. */
|
|
1328
1499
|
reservedResourceType?: ReservedResourceType;
|
|
1329
|
-
/** Subscription that will be charged for purchasing
|
|
1500
|
+
/** Subscription that will be charged for purchasing reservation or savings plan */
|
|
1330
1501
|
billingScopeId?: string;
|
|
1331
|
-
/** Represent the term of
|
|
1502
|
+
/** Represent the term of reservation. */
|
|
1332
1503
|
term?: ReservationTerm;
|
|
1333
1504
|
/** Represent the billing plans. */
|
|
1334
1505
|
billingPlan?: ReservationBillingPlan;
|
|
1335
|
-
/** Quantity of the
|
|
1506
|
+
/** Quantity of the skus that are part of the reservation. */
|
|
1336
1507
|
quantity?: number;
|
|
1337
|
-
/** Friendly name of the
|
|
1508
|
+
/** Friendly name of the reservation */
|
|
1338
1509
|
displayName?: string;
|
|
1339
1510
|
/** Type of the Applied Scope. */
|
|
1340
1511
|
appliedScopeType?: AppliedScopeType;
|
|
1341
1512
|
/** List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. */
|
|
1342
1513
|
appliedScopes?: string[];
|
|
1514
|
+
/** Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup */
|
|
1515
|
+
appliedScopeProperties?: AppliedScopeProperties;
|
|
1343
1516
|
/** Setting this to true will automatically purchase a new reservation on the expiration date time. */
|
|
1344
1517
|
renew?: boolean;
|
|
1345
1518
|
/** Properties specific to each reserved resource type. Not required if not applicable. */
|
|
1346
1519
|
reservedResourceProperties?: PurchaseRequestPropertiesReservedResourceProperties;
|
|
1520
|
+
/** This is the date-time when the Azure hybrid benefit needs to be reviewed. */
|
|
1521
|
+
reviewDateTime?: Date;
|
|
1347
1522
|
}
|
|
1348
1523
|
|
|
1349
1524
|
/** Properties specific to each reserved resource type. Not required if not applicable. */
|
|
@@ -1688,16 +1863,6 @@ export declare type QuotaRequestStatusGetResponse = QuotaRequestDetails;
|
|
|
1688
1863
|
|
|
1689
1864
|
/** Optional parameters. */
|
|
1690
1865
|
export declare interface QuotaRequestStatusListNextOptionalParams extends coreClient.OperationOptions {
|
|
1691
|
-
/**
|
|
1692
|
-
* | Field | Supported operators |
|
|
1693
|
-
* |---------------------|------------------------|
|
|
1694
|
-
* |requestSubmitTime | ge, le, eq, gt, lt |
|
|
1695
|
-
*/
|
|
1696
|
-
filter?: string;
|
|
1697
|
-
/** Number of records to return. */
|
|
1698
|
-
top?: number;
|
|
1699
|
-
/** Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element includes a skiptoken parameter that specifies a starting point to use for subsequent calls. */
|
|
1700
|
-
skiptoken?: string;
|
|
1701
1866
|
}
|
|
1702
1867
|
|
|
1703
1868
|
/** Contains response data for the listNext operation. */
|
|
@@ -1789,13 +1954,17 @@ export declare interface RefundBillingInformation {
|
|
|
1789
1954
|
completedTransactions?: number;
|
|
1790
1955
|
/** The number of total transactions in this reservation's payment */
|
|
1791
1956
|
totalTransactions?: number;
|
|
1957
|
+
/** Pricing information containing the amount and the currency code */
|
|
1792
1958
|
billingCurrencyTotalPaidAmount?: Price;
|
|
1959
|
+
/** Pricing information containing the amount and the currency code */
|
|
1793
1960
|
billingCurrencyProratedAmount?: Price;
|
|
1961
|
+
/** Pricing information containing the amount and the currency code */
|
|
1794
1962
|
billingCurrencyRemainingCommitmentAmount?: Price;
|
|
1795
1963
|
}
|
|
1796
1964
|
|
|
1797
1965
|
/** error details */
|
|
1798
1966
|
export declare interface RefundPolicyError {
|
|
1967
|
+
/** Error code describing the reason that service is not able to process the incoming request */
|
|
1799
1968
|
code?: ErrorResponseCode;
|
|
1800
1969
|
message?: string;
|
|
1801
1970
|
}
|
|
@@ -1808,16 +1977,21 @@ export declare interface RefundPolicyResult {
|
|
|
1808
1977
|
|
|
1809
1978
|
/** Refund policy result property */
|
|
1810
1979
|
export declare interface RefundPolicyResultProperty {
|
|
1980
|
+
/** Pricing information containing the amount and the currency code */
|
|
1811
1981
|
consumedRefundsTotal?: Price;
|
|
1982
|
+
/** Pricing information containing the amount and the currency code */
|
|
1812
1983
|
maxRefundLimit?: Price;
|
|
1813
1984
|
/** Refund Policy errors */
|
|
1814
1985
|
policyErrors?: RefundPolicyError[];
|
|
1815
1986
|
}
|
|
1816
1987
|
|
|
1988
|
+
/** Request containing information needed for returning reservation. */
|
|
1817
1989
|
export declare interface RefundRequest {
|
|
1990
|
+
/** Properties needed for refund request including the session id from calculate refund, the scope, the reservation to be returned and the return reason. */
|
|
1818
1991
|
properties?: RefundRequestProperties;
|
|
1819
1992
|
}
|
|
1820
1993
|
|
|
1994
|
+
/** Properties needed for refund request including the session id from calculate refund, the scope, the reservation to be returned and the return reason. */
|
|
1821
1995
|
export declare interface RefundRequestProperties {
|
|
1822
1996
|
/** SessionId that was returned by CalculateRefund API. */
|
|
1823
1997
|
sessionId?: string;
|
|
@@ -1829,18 +2003,23 @@ export declare interface RefundRequestProperties {
|
|
|
1829
2003
|
returnReason?: string;
|
|
1830
2004
|
}
|
|
1831
2005
|
|
|
2006
|
+
/** The response of refund request containing refund information of reservation */
|
|
1832
2007
|
export declare interface RefundResponse {
|
|
1833
2008
|
/** Fully qualified identifier of the reservation being returned */
|
|
1834
2009
|
id?: string;
|
|
2010
|
+
/** The refund properties of reservation */
|
|
1835
2011
|
properties?: RefundResponseProperties;
|
|
1836
2012
|
}
|
|
1837
2013
|
|
|
2014
|
+
/** The refund properties of reservation */
|
|
1838
2015
|
export declare interface RefundResponseProperties {
|
|
1839
2016
|
/** Refund session identifier */
|
|
1840
2017
|
sessionId?: string;
|
|
1841
2018
|
/** Quantity to be returned */
|
|
1842
2019
|
quantity?: number;
|
|
2020
|
+
/** Pricing information containing the amount and the currency code */
|
|
1843
2021
|
billingRefundAmount?: Price;
|
|
2022
|
+
/** Pricing information containing the amount and the currency code */
|
|
1844
2023
|
pricingRefundAmount?: Price;
|
|
1845
2024
|
/** Refund policy result */
|
|
1846
2025
|
policyResult?: RefundPolicyResult;
|
|
@@ -1848,7 +2027,9 @@ export declare interface RefundResponseProperties {
|
|
|
1848
2027
|
billingInformation?: RefundBillingInformation;
|
|
1849
2028
|
}
|
|
1850
2029
|
|
|
2030
|
+
/** The renew properties for a reservation. */
|
|
1851
2031
|
export declare interface RenewPropertiesResponse {
|
|
2032
|
+
/** The request for reservation purchase */
|
|
1852
2033
|
purchaseProperties?: PurchaseRequest;
|
|
1853
2034
|
/** Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. */
|
|
1854
2035
|
pricingCurrencyTotal?: RenewPropertiesResponsePricingCurrencyTotal;
|
|
@@ -1880,11 +2061,11 @@ export declare interface Reservation {
|
|
|
1880
2061
|
list(reservationOrderId: string, options?: ReservationListOptionalParams): PagedAsyncIterableIterator<ReservationResponse>;
|
|
1881
2062
|
/**
|
|
1882
2063
|
* List of all the revisions for the `Reservation`.
|
|
1883
|
-
* @param reservationId Id of the Reservation Item
|
|
1884
2064
|
* @param reservationOrderId Order Id of the reservation
|
|
2065
|
+
* @param reservationId Id of the reservation item
|
|
1885
2066
|
* @param options The options parameters.
|
|
1886
2067
|
*/
|
|
1887
|
-
listRevisions(
|
|
2068
|
+
listRevisions(reservationOrderId: string, reservationId: string, options?: ReservationListRevisionsOptionalParams): PagedAsyncIterableIterator<ReservationResponse>;
|
|
1888
2069
|
/**
|
|
1889
2070
|
* List the reservations and the roll up counts of reservations group by provisioning states that the
|
|
1890
2071
|
* user has access to in the current tenant.
|
|
@@ -1892,20 +2073,20 @@ export declare interface Reservation {
|
|
|
1892
2073
|
*/
|
|
1893
2074
|
listAll(options?: ReservationListAllOptionalParams): PagedAsyncIterableIterator<ReservationResponse>;
|
|
1894
2075
|
/**
|
|
1895
|
-
*
|
|
2076
|
+
* Check whether the scopes from request is valid for `Reservation`.
|
|
1896
2077
|
*
|
|
1897
2078
|
* @param reservationOrderId Order Id of the reservation
|
|
1898
|
-
* @param reservationId Id of the
|
|
1899
|
-
* @param body
|
|
2079
|
+
* @param reservationId Id of the reservation item
|
|
2080
|
+
* @param body Scopes to be checked for eligibility.
|
|
1900
2081
|
* @param options The options parameters.
|
|
1901
2082
|
*/
|
|
1902
2083
|
beginAvailableScopes(reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams): Promise<PollerLike<PollOperationState<ReservationAvailableScopesResponse>, ReservationAvailableScopesResponse>>;
|
|
1903
2084
|
/**
|
|
1904
|
-
*
|
|
2085
|
+
* Check whether the scopes from request is valid for `Reservation`.
|
|
1905
2086
|
*
|
|
1906
2087
|
* @param reservationOrderId Order Id of the reservation
|
|
1907
|
-
* @param reservationId Id of the
|
|
1908
|
-
* @param body
|
|
2088
|
+
* @param reservationId Id of the reservation item
|
|
2089
|
+
* @param body Scopes to be checked for eligibility.
|
|
1909
2090
|
* @param options The options parameters.
|
|
1910
2091
|
*/
|
|
1911
2092
|
beginAvailableScopesAndWait(reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams): Promise<ReservationAvailableScopesResponse>;
|
|
@@ -1941,15 +2122,15 @@ export declare interface Reservation {
|
|
|
1941
2122
|
beginMergeAndWait(reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams): Promise<ReservationMergeResponse>;
|
|
1942
2123
|
/**
|
|
1943
2124
|
* Get specific `Reservation` details.
|
|
1944
|
-
* @param reservationId Id of the Reservation Item
|
|
1945
2125
|
* @param reservationOrderId Order Id of the reservation
|
|
2126
|
+
* @param reservationId Id of the reservation item
|
|
1946
2127
|
* @param options The options parameters.
|
|
1947
2128
|
*/
|
|
1948
|
-
get(
|
|
2129
|
+
get(reservationOrderId: string, reservationId: string, options?: ReservationGetOptionalParams): Promise<ReservationGetResponse>;
|
|
1949
2130
|
/**
|
|
1950
2131
|
* Updates the applied scopes of the `Reservation`.
|
|
1951
2132
|
* @param reservationOrderId Order Id of the reservation
|
|
1952
|
-
* @param reservationId Id of the
|
|
2133
|
+
* @param reservationId Id of the reservation item
|
|
1953
2134
|
* @param parameters Information needed to patch a reservation item
|
|
1954
2135
|
* @param options The options parameters.
|
|
1955
2136
|
*/
|
|
@@ -1957,7 +2138,7 @@ export declare interface Reservation {
|
|
|
1957
2138
|
/**
|
|
1958
2139
|
* Updates the applied scopes of the `Reservation`.
|
|
1959
2140
|
* @param reservationOrderId Order Id of the reservation
|
|
1960
|
-
* @param reservationId Id of the
|
|
2141
|
+
* @param reservationId Id of the reservation item
|
|
1961
2142
|
* @param parameters Information needed to patch a reservation item
|
|
1962
2143
|
* @param options The options parameters.
|
|
1963
2144
|
*/
|
|
@@ -1965,15 +2146,15 @@ export declare interface Reservation {
|
|
|
1965
2146
|
/**
|
|
1966
2147
|
* Archiving a `Reservation` moves it to `Archived` state.
|
|
1967
2148
|
* @param reservationOrderId Order Id of the reservation
|
|
1968
|
-
* @param reservationId Id of the
|
|
2149
|
+
* @param reservationId Id of the reservation item
|
|
1969
2150
|
* @param options The options parameters.
|
|
1970
2151
|
*/
|
|
1971
2152
|
archive(reservationOrderId: string, reservationId: string, options?: ReservationArchiveOptionalParams): Promise<void>;
|
|
1972
2153
|
/**
|
|
1973
|
-
*
|
|
2154
|
+
* Restores a `Reservation` to the state it was before archiving.
|
|
1974
2155
|
*
|
|
1975
2156
|
* @param reservationOrderId Order Id of the reservation
|
|
1976
|
-
* @param reservationId Id of the
|
|
2157
|
+
* @param reservationId Id of the reservation item
|
|
1977
2158
|
* @param options The options parameters.
|
|
1978
2159
|
*/
|
|
1979
2160
|
unarchive(reservationOrderId: string, reservationId: string, options?: ReservationUnarchiveOptionalParams): Promise<void>;
|
|
@@ -2013,6 +2194,7 @@ export declare interface ReservationGetOptionalParams extends coreClient.Operati
|
|
|
2013
2194
|
/** Contains response data for the get operation. */
|
|
2014
2195
|
export declare type ReservationGetResponse = ReservationResponse;
|
|
2015
2196
|
|
|
2197
|
+
/** List of `Reservation`s */
|
|
2016
2198
|
export declare interface ReservationList {
|
|
2017
2199
|
value?: ReservationResponse[];
|
|
2018
2200
|
/** Url to get the next page of reservations. */
|
|
@@ -2021,18 +2203,6 @@ export declare interface ReservationList {
|
|
|
2021
2203
|
|
|
2022
2204
|
/** Optional parameters. */
|
|
2023
2205
|
export declare interface ReservationListAllNextOptionalParams extends coreClient.OperationOptions {
|
|
2024
|
-
/** May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. Reservation properties include sku/name, properties/{appliedScopeType, archived, displayName, displayProvisioningState, effectiveDateTime, expiryDate, provisioningState, quantity, renew, reservedResourceType, term, userFriendlyAppliedScopeType, userFriendlyRenewState} */
|
|
2025
|
-
filter?: string;
|
|
2026
|
-
/** May be used to sort order by reservation properties. */
|
|
2027
|
-
orderby?: string;
|
|
2028
|
-
/** To indicate whether to refresh the roll up counts of the reservations group by provisioning states */
|
|
2029
|
-
refreshSummary?: string;
|
|
2030
|
-
/** The number of reservations to skip from the list before returning results */
|
|
2031
|
-
skiptoken?: number;
|
|
2032
|
-
/** The selected provisioning state */
|
|
2033
|
-
selectedState?: string;
|
|
2034
|
-
/** To number of reservations to return */
|
|
2035
|
-
take?: number;
|
|
2036
2206
|
}
|
|
2037
2207
|
|
|
2038
2208
|
/** Contains response data for the listAllNext operation. */
|
|
@@ -2040,7 +2210,7 @@ export declare type ReservationListAllNextResponse = ReservationsListResult;
|
|
|
2040
2210
|
|
|
2041
2211
|
/** Optional parameters. */
|
|
2042
2212
|
export declare interface ReservationListAllOptionalParams extends coreClient.OperationOptions {
|
|
2043
|
-
/** May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. Reservation properties include sku/name, properties/{appliedScopeType, archived, displayName, displayProvisioningState, effectiveDateTime, expiryDate, provisioningState, quantity, renew, reservedResourceType, term, userFriendlyAppliedScopeType, userFriendlyRenewState} */
|
|
2213
|
+
/** May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. Reservation properties include sku/name, properties/{appliedScopeType, archived, displayName, displayProvisioningState, effectiveDateTime, expiryDate, expiryDateTime, provisioningState, quantity, renew, reservedResourceType, term, userFriendlyAppliedScopeType, userFriendlyRenewState} */
|
|
2044
2214
|
filter?: string;
|
|
2045
2215
|
/** May be used to sort order by reservation properties. */
|
|
2046
2216
|
orderby?: string;
|
|
@@ -2085,6 +2255,14 @@ export declare interface ReservationListRevisionsOptionalParams extends coreClie
|
|
|
2085
2255
|
/** Contains response data for the listRevisions operation. */
|
|
2086
2256
|
export declare type ReservationListRevisionsResponse = ReservationList;
|
|
2087
2257
|
|
|
2258
|
+
/** Defines headers for Reservation_merge operation. */
|
|
2259
|
+
export declare interface ReservationMergeHeaders {
|
|
2260
|
+
/** URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. */
|
|
2261
|
+
location?: string;
|
|
2262
|
+
/** Clients should wait for the Retry-After interval before polling again */
|
|
2263
|
+
retryAfter?: number;
|
|
2264
|
+
}
|
|
2265
|
+
|
|
2088
2266
|
/** Optional parameters. */
|
|
2089
2267
|
export declare interface ReservationMergeOptionalParams extends coreClient.OperationOptions {
|
|
2090
2268
|
/** Delay to wait until next poll, in milliseconds. */
|
|
@@ -2093,10 +2271,11 @@ export declare interface ReservationMergeOptionalParams extends coreClient.Opera
|
|
|
2093
2271
|
resumeFrom?: string;
|
|
2094
2272
|
}
|
|
2095
2273
|
|
|
2274
|
+
/** Properties of reservation merge */
|
|
2096
2275
|
export declare interface ReservationMergeProperties {
|
|
2097
|
-
/** Reservation
|
|
2276
|
+
/** Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} */
|
|
2098
2277
|
mergeDestination?: string;
|
|
2099
|
-
/** Resource
|
|
2278
|
+
/** Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} */
|
|
2100
2279
|
mergeSources?: string[];
|
|
2101
2280
|
}
|
|
2102
2281
|
|
|
@@ -2180,6 +2359,7 @@ export declare interface ReservationOrderGetOptionalParams extends coreClient.Op
|
|
|
2180
2359
|
/** Contains response data for the get operation. */
|
|
2181
2360
|
export declare type ReservationOrderGetResponse = ReservationOrderResponse;
|
|
2182
2361
|
|
|
2362
|
+
/** List of `ReservationOrder`s */
|
|
2183
2363
|
export declare interface ReservationOrderList {
|
|
2184
2364
|
value?: ReservationOrderResponse[];
|
|
2185
2365
|
/** Url to get the next page of reservationOrders. */
|
|
@@ -2200,6 +2380,14 @@ export declare interface ReservationOrderListOptionalParams extends coreClient.O
|
|
|
2200
2380
|
/** Contains response data for the list operation. */
|
|
2201
2381
|
export declare type ReservationOrderListResponse = ReservationOrderList;
|
|
2202
2382
|
|
|
2383
|
+
/** Defines headers for ReservationOrder_purchase operation. */
|
|
2384
|
+
export declare interface ReservationOrderPurchaseHeaders {
|
|
2385
|
+
/** URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. */
|
|
2386
|
+
location?: string;
|
|
2387
|
+
/** Clients should wait for the Retry-After interval before polling again */
|
|
2388
|
+
retryAfter?: number;
|
|
2389
|
+
}
|
|
2390
|
+
|
|
2203
2391
|
/** Optional parameters. */
|
|
2204
2392
|
export declare interface ReservationOrderPurchaseOptionalParams extends coreClient.OperationOptions {
|
|
2205
2393
|
/** Delay to wait until next poll, in milliseconds. */
|
|
@@ -2211,6 +2399,7 @@ export declare interface ReservationOrderPurchaseOptionalParams extends coreClie
|
|
|
2211
2399
|
/** Contains response data for the purchase operation. */
|
|
2212
2400
|
export declare type ReservationOrderPurchaseResponse = ReservationOrderResponse;
|
|
2213
2401
|
|
|
2402
|
+
/** Details of a reservation order being returned. */
|
|
2214
2403
|
export declare interface ReservationOrderResponse {
|
|
2215
2404
|
etag?: number;
|
|
2216
2405
|
/**
|
|
@@ -2239,13 +2428,15 @@ export declare interface ReservationOrderResponse {
|
|
|
2239
2428
|
requestDateTime?: Date;
|
|
2240
2429
|
/** This is the DateTime when the reservation was created. */
|
|
2241
2430
|
createdDateTime?: Date;
|
|
2242
|
-
/** This is the date when the
|
|
2431
|
+
/** This is the date when the reservation will expire. */
|
|
2243
2432
|
expiryDate?: Date;
|
|
2433
|
+
/** This is the date-time when the reservation will expire. */
|
|
2434
|
+
expiryDateTime?: Date;
|
|
2244
2435
|
/** This is the DateTime when the reservation benefit started. */
|
|
2245
2436
|
benefitStartTime?: Date;
|
|
2246
|
-
/** Total Quantity of the
|
|
2437
|
+
/** Total Quantity of the skus purchased in the reservation. */
|
|
2247
2438
|
originalQuantity?: number;
|
|
2248
|
-
/** Represent the term of
|
|
2439
|
+
/** Represent the term of reservation. */
|
|
2249
2440
|
term?: ReservationTerm;
|
|
2250
2441
|
/** Current state of the reservation. */
|
|
2251
2442
|
provisioningState?: ProvisioningState;
|
|
@@ -2254,39 +2445,21 @@ export declare interface ReservationOrderResponse {
|
|
|
2254
2445
|
/** Information describing the type of billing plan for this reservation. */
|
|
2255
2446
|
planInformation?: ReservationOrderBillingPlanInformation;
|
|
2256
2447
|
reservations?: ReservationResponse[];
|
|
2448
|
+
/** This is the date-time when the Azure Hybrid Benefit needs to be reviewed. */
|
|
2449
|
+
reviewDateTime?: Date;
|
|
2257
2450
|
}
|
|
2258
2451
|
|
|
2259
2452
|
/** The definition of the reservation. */
|
|
2260
|
-
export declare interface ReservationResponse {
|
|
2261
|
-
/** The Azure
|
|
2453
|
+
export declare interface ReservationResponse extends ProxyResource {
|
|
2454
|
+
/** The Azure region where the reserved resource lives. */
|
|
2262
2455
|
location?: string;
|
|
2263
2456
|
etag?: number;
|
|
2264
|
-
/**
|
|
2265
|
-
* Identifier of the reservation
|
|
2266
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2267
|
-
*/
|
|
2268
|
-
readonly id?: string;
|
|
2269
|
-
/**
|
|
2270
|
-
* Name of the reservation
|
|
2271
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2272
|
-
*/
|
|
2273
|
-
readonly name?: string;
|
|
2274
2457
|
/** The sku information associated to this reservation */
|
|
2275
2458
|
sku?: SkuName;
|
|
2276
2459
|
/** The properties associated to this reservation */
|
|
2277
2460
|
properties?: ReservationsProperties;
|
|
2278
|
-
/**
|
|
2279
|
-
* Type of resource. "Microsoft.Capacity/reservationOrders/reservations"
|
|
2280
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2281
|
-
*/
|
|
2282
|
-
readonly type?: string;
|
|
2283
2461
|
/** Resource Provider type to be reserved. */
|
|
2284
2462
|
kind?: "Microsoft.Compute";
|
|
2285
|
-
/**
|
|
2286
|
-
* Metadata pertaining to creation and last modification of the resource.
|
|
2287
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2288
|
-
*/
|
|
2289
|
-
readonly systemData?: SystemData;
|
|
2290
2463
|
}
|
|
2291
2464
|
|
|
2292
2465
|
/** The list of reservations and summary of roll out count of reservations in each state. */
|
|
@@ -2305,6 +2478,14 @@ export declare interface ReservationsListResult {
|
|
|
2305
2478
|
summary?: ReservationSummary;
|
|
2306
2479
|
}
|
|
2307
2480
|
|
|
2481
|
+
/** Defines headers for Reservation_split operation. */
|
|
2482
|
+
export declare interface ReservationSplitHeaders {
|
|
2483
|
+
/** URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. */
|
|
2484
|
+
location?: string;
|
|
2485
|
+
/** Clients should wait for the Retry-After interval before polling again */
|
|
2486
|
+
retryAfter?: number;
|
|
2487
|
+
}
|
|
2488
|
+
|
|
2308
2489
|
/** Optional parameters. */
|
|
2309
2490
|
export declare interface ReservationSplitOptionalParams extends coreClient.OperationOptions {
|
|
2310
2491
|
/** Delay to wait until next poll, in milliseconds. */
|
|
@@ -2313,10 +2494,11 @@ export declare interface ReservationSplitOptionalParams extends coreClient.Opera
|
|
|
2313
2494
|
resumeFrom?: string;
|
|
2314
2495
|
}
|
|
2315
2496
|
|
|
2497
|
+
/** Properties of reservation split */
|
|
2316
2498
|
export declare interface ReservationSplitProperties {
|
|
2317
|
-
/** List of destination
|
|
2499
|
+
/** List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} */
|
|
2318
2500
|
splitDestinations?: string[];
|
|
2319
|
-
/** Resource
|
|
2501
|
+
/** Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} */
|
|
2320
2502
|
splitSource?: string;
|
|
2321
2503
|
}
|
|
2322
2504
|
|
|
@@ -2327,7 +2509,7 @@ export declare type ReservationSplitResponse = ReservationResponse[];
|
|
|
2327
2509
|
export declare interface ReservationsProperties {
|
|
2328
2510
|
/** The type of the resource that is being reserved. */
|
|
2329
2511
|
reservedResourceType?: ReservedResourceType;
|
|
2330
|
-
/** Allows reservation discount to be applied across skus within the same
|
|
2512
|
+
/** Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. */
|
|
2331
2513
|
instanceFlexibility?: InstanceFlexibility;
|
|
2332
2514
|
/** Friendly name for user to easily identify the reservation */
|
|
2333
2515
|
displayName?: string;
|
|
@@ -2339,26 +2521,30 @@ export declare interface ReservationsProperties {
|
|
|
2339
2521
|
archived?: boolean;
|
|
2340
2522
|
/** Capabilities of the reservation */
|
|
2341
2523
|
capabilities?: string;
|
|
2342
|
-
/** Quantity of the
|
|
2524
|
+
/** Quantity of the skus that are part of the reservation. */
|
|
2343
2525
|
quantity?: number;
|
|
2344
2526
|
/** Current state of the reservation. */
|
|
2345
2527
|
provisioningState?: ProvisioningState;
|
|
2346
|
-
/** DateTime of the
|
|
2528
|
+
/** DateTime of the reservation starting when this version is effective from. */
|
|
2347
2529
|
effectiveDateTime?: Date;
|
|
2348
2530
|
/** This is the DateTime when the reservation benefit started. */
|
|
2349
2531
|
benefitStartTime?: Date;
|
|
2350
2532
|
/**
|
|
2351
|
-
* DateTime of the last time the
|
|
2533
|
+
* DateTime of the last time the reservation was updated.
|
|
2352
2534
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2353
2535
|
*/
|
|
2354
2536
|
readonly lastUpdatedDateTime?: Date;
|
|
2355
|
-
/** This is the date when the
|
|
2537
|
+
/** This is the date when the reservation will expire. */
|
|
2356
2538
|
expiryDate?: Date;
|
|
2357
|
-
/**
|
|
2539
|
+
/** This is the date-time when the reservation will expire. */
|
|
2540
|
+
expiryDateTime?: Date;
|
|
2541
|
+
/** This is the date-time when the Azure Hybrid Benefit needs to be reviewed. */
|
|
2542
|
+
reviewDateTime?: Date;
|
|
2543
|
+
/** Description of the sku in english. */
|
|
2358
2544
|
skuDescription?: string;
|
|
2359
2545
|
/** The message giving detailed information about the status code. */
|
|
2360
2546
|
extendedStatusInfo?: ExtendedStatusInfo;
|
|
2361
|
-
/** The billing plan options available for this
|
|
2547
|
+
/** The billing plan options available for this sku. */
|
|
2362
2548
|
billingPlan?: ReservationBillingPlan;
|
|
2363
2549
|
/**
|
|
2364
2550
|
* The provisioning state of the reservation for display, e.g. Succeeded
|
|
@@ -2366,15 +2552,23 @@ export declare interface ReservationsProperties {
|
|
|
2366
2552
|
*/
|
|
2367
2553
|
readonly displayProvisioningState?: string;
|
|
2368
2554
|
/**
|
|
2369
|
-
* The provisioning state of the reservation, e.g. Succeeded
|
|
2555
|
+
* The provisioning sub-state of the reservation, e.g. Succeeded
|
|
2370
2556
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2371
2557
|
*/
|
|
2372
2558
|
readonly provisioningSubState?: string;
|
|
2373
|
-
/** This is the date when the
|
|
2559
|
+
/** This is the date when the reservation was purchased. */
|
|
2374
2560
|
purchaseDate?: Date;
|
|
2561
|
+
/** This is the date-time when the reservation was purchased. */
|
|
2562
|
+
purchaseDateTime?: Date;
|
|
2563
|
+
/** Properties of reservation split */
|
|
2375
2564
|
splitProperties?: ReservationSplitProperties;
|
|
2565
|
+
/** Properties of reservation merge */
|
|
2376
2566
|
mergeProperties?: ReservationMergeProperties;
|
|
2377
|
-
/**
|
|
2567
|
+
/** Properties of reservation swap */
|
|
2568
|
+
swapProperties?: ReservationSwapProperties;
|
|
2569
|
+
/** Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup */
|
|
2570
|
+
appliedScopeProperties?: AppliedScopeProperties;
|
|
2571
|
+
/** Subscription that will be charged for purchasing reservation or savings plan */
|
|
2378
2572
|
billingScopeId?: string;
|
|
2379
2573
|
/** Setting this to true will automatically purchase a new reservation on the expiration date time. */
|
|
2380
2574
|
renew?: boolean;
|
|
@@ -2382,8 +2576,9 @@ export declare interface ReservationsProperties {
|
|
|
2382
2576
|
renewSource?: string;
|
|
2383
2577
|
/** Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. */
|
|
2384
2578
|
renewDestination?: string;
|
|
2579
|
+
/** The renew properties for a reservation. */
|
|
2385
2580
|
renewProperties?: RenewPropertiesResponse;
|
|
2386
|
-
/** Represent the term of
|
|
2581
|
+
/** Represent the term of reservation. */
|
|
2387
2582
|
term?: ReservationTerm;
|
|
2388
2583
|
/**
|
|
2389
2584
|
* The applied scope type of the reservation for display, e.g. Shared
|
|
@@ -2405,7 +2600,7 @@ export declare interface ReservationsProperties {
|
|
|
2405
2600
|
/** Reservation utilization */
|
|
2406
2601
|
export declare interface ReservationsPropertiesUtilization {
|
|
2407
2602
|
/**
|
|
2408
|
-
*
|
|
2603
|
+
* last 7 day utilization trend for a reservation
|
|
2409
2604
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2410
2605
|
*/
|
|
2411
2606
|
readonly trend?: string;
|
|
@@ -2468,6 +2663,24 @@ export declare interface ReservationSummary {
|
|
|
2468
2663
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2469
2664
|
*/
|
|
2470
2665
|
readonly processingCount?: number;
|
|
2666
|
+
/**
|
|
2667
|
+
* The number of reservation in Warning state
|
|
2668
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2669
|
+
*/
|
|
2670
|
+
readonly warningCount?: number;
|
|
2671
|
+
/**
|
|
2672
|
+
* The number of reservation in NoBenefit state
|
|
2673
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2674
|
+
*/
|
|
2675
|
+
readonly noBenefitCount?: number;
|
|
2676
|
+
}
|
|
2677
|
+
|
|
2678
|
+
/** Properties of reservation swap */
|
|
2679
|
+
export declare interface ReservationSwapProperties {
|
|
2680
|
+
/** Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} */
|
|
2681
|
+
swapSource?: string;
|
|
2682
|
+
/** Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} */
|
|
2683
|
+
swapDestination?: string;
|
|
2471
2684
|
}
|
|
2472
2685
|
|
|
2473
2686
|
/**
|
|
@@ -2483,10 +2696,11 @@ export declare type ReservationTerm = string;
|
|
|
2483
2696
|
|
|
2484
2697
|
/** Reservation refund details */
|
|
2485
2698
|
export declare interface ReservationToExchange {
|
|
2486
|
-
/** Fully qualified id of the
|
|
2699
|
+
/** Fully qualified id of the reservation being returned. */
|
|
2487
2700
|
reservationId?: string;
|
|
2488
2701
|
/** Quantity to be returned */
|
|
2489
2702
|
quantity?: number;
|
|
2703
|
+
/** Pricing information containing the amount and the currency code */
|
|
2490
2704
|
billingRefundAmount?: Price;
|
|
2491
2705
|
/** billing information */
|
|
2492
2706
|
billingInformation?: BillingInformation;
|
|
@@ -2494,17 +2708,21 @@ export declare interface ReservationToExchange {
|
|
|
2494
2708
|
|
|
2495
2709
|
/** Reservation purchase details */
|
|
2496
2710
|
export declare interface ReservationToPurchaseCalculateExchange {
|
|
2711
|
+
/** The request for reservation purchase */
|
|
2497
2712
|
properties?: PurchaseRequest;
|
|
2713
|
+
/** Pricing information containing the amount and the currency code */
|
|
2498
2714
|
billingCurrencyTotal?: Price;
|
|
2499
2715
|
}
|
|
2500
2716
|
|
|
2501
2717
|
/** Reservation purchase details */
|
|
2502
2718
|
export declare interface ReservationToPurchaseExchange {
|
|
2503
|
-
/** Fully qualified id of the
|
|
2719
|
+
/** Fully qualified id of the reservationOrder being purchased */
|
|
2504
2720
|
reservationOrderId?: string;
|
|
2505
|
-
/** Fully qualified id of the
|
|
2721
|
+
/** Fully qualified id of the reservation being purchased. This value is only guaranteed to be non-null if the purchase is successful. */
|
|
2506
2722
|
reservationId?: string;
|
|
2723
|
+
/** The request for reservation purchase */
|
|
2507
2724
|
properties?: PurchaseRequest;
|
|
2725
|
+
/** Pricing information containing the amount and the currency code */
|
|
2508
2726
|
billingCurrencyTotal?: Price;
|
|
2509
2727
|
/** Status of the individual operation. */
|
|
2510
2728
|
status?: OperationStatus;
|
|
@@ -2512,7 +2730,7 @@ export declare interface ReservationToPurchaseExchange {
|
|
|
2512
2730
|
|
|
2513
2731
|
/** Reservation to return */
|
|
2514
2732
|
export declare interface ReservationToReturn {
|
|
2515
|
-
/** Fully qualified identifier of the
|
|
2733
|
+
/** Fully qualified identifier of the reservation being returned */
|
|
2516
2734
|
reservationId?: string;
|
|
2517
2735
|
/** Quantity to be returned. Must be greater than zero. */
|
|
2518
2736
|
quantity?: number;
|
|
@@ -2520,10 +2738,11 @@ export declare interface ReservationToReturn {
|
|
|
2520
2738
|
|
|
2521
2739
|
/** Reservation refund details */
|
|
2522
2740
|
export declare interface ReservationToReturnForExchange {
|
|
2523
|
-
/** Fully qualified id of the
|
|
2741
|
+
/** Fully qualified id of the reservation being returned. */
|
|
2524
2742
|
reservationId?: string;
|
|
2525
2743
|
/** Quantity to be returned */
|
|
2526
2744
|
quantity?: number;
|
|
2745
|
+
/** Pricing information containing the amount and the currency code */
|
|
2527
2746
|
billingRefundAmount?: Price;
|
|
2528
2747
|
/** billing information */
|
|
2529
2748
|
billingInformation?: BillingInformation;
|
|
@@ -2535,6 +2754,16 @@ export declare interface ReservationToReturnForExchange {
|
|
|
2535
2754
|
export declare interface ReservationUnarchiveOptionalParams extends coreClient.OperationOptions {
|
|
2536
2755
|
}
|
|
2537
2756
|
|
|
2757
|
+
/** Defines headers for Reservation_update operation. */
|
|
2758
|
+
export declare interface ReservationUpdateHeaders {
|
|
2759
|
+
/** URL for checking the ongoing status of the operation. */
|
|
2760
|
+
azureAsyncOperation?: string;
|
|
2761
|
+
/** URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. */
|
|
2762
|
+
location?: string;
|
|
2763
|
+
/** Clients should wait for the Retry-After interval before polling again */
|
|
2764
|
+
retryAfter?: number;
|
|
2765
|
+
}
|
|
2766
|
+
|
|
2538
2767
|
/** Optional parameters. */
|
|
2539
2768
|
export declare interface ReservationUpdateOptionalParams extends coreClient.OperationOptions {
|
|
2540
2769
|
/** Delay to wait until next poll, in milliseconds. */
|
|
@@ -2604,6 +2833,30 @@ export declare interface ReservationUtilizationAggregates {
|
|
|
2604
2833
|
*/
|
|
2605
2834
|
export declare type ReservedResourceType = string;
|
|
2606
2835
|
|
|
2836
|
+
/** Common fields that are returned in the response for all Azure Resource Manager resources */
|
|
2837
|
+
export declare interface Resource {
|
|
2838
|
+
/**
|
|
2839
|
+
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
|
|
2840
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2841
|
+
*/
|
|
2842
|
+
readonly id?: string;
|
|
2843
|
+
/**
|
|
2844
|
+
* The name of the resource
|
|
2845
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2846
|
+
*/
|
|
2847
|
+
readonly name?: string;
|
|
2848
|
+
/**
|
|
2849
|
+
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
|
|
2850
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2851
|
+
*/
|
|
2852
|
+
readonly type?: string;
|
|
2853
|
+
/**
|
|
2854
|
+
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
|
|
2855
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2856
|
+
*/
|
|
2857
|
+
readonly systemData?: SystemData;
|
|
2858
|
+
}
|
|
2859
|
+
|
|
2607
2860
|
/** Resource name provided by the resource provider. Use this property for quotaRequest parameter. */
|
|
2608
2861
|
export declare interface ResourceName {
|
|
2609
2862
|
/** Resource name. */
|
|
@@ -2631,12 +2884,19 @@ export declare type ResourceType = string;
|
|
|
2631
2884
|
/** Interface representing a Return. */
|
|
2632
2885
|
export declare interface Return {
|
|
2633
2886
|
/**
|
|
2634
|
-
* Return a reservation.
|
|
2887
|
+
* Return a reservation and get refund information.
|
|
2635
2888
|
* @param reservationOrderId Order Id of the reservation
|
|
2636
2889
|
* @param body Information needed for returning reservation.
|
|
2637
2890
|
* @param options The options parameters.
|
|
2638
2891
|
*/
|
|
2639
|
-
|
|
2892
|
+
beginPost(reservationOrderId: string, body: RefundRequest, options?: ReturnPostOptionalParams): Promise<PollerLike<PollOperationState<ReturnPostResponse>, ReturnPostResponse>>;
|
|
2893
|
+
/**
|
|
2894
|
+
* Return a reservation and get refund information.
|
|
2895
|
+
* @param reservationOrderId Order Id of the reservation
|
|
2896
|
+
* @param body Information needed for returning reservation.
|
|
2897
|
+
* @param options The options parameters.
|
|
2898
|
+
*/
|
|
2899
|
+
beginPostAndWait(reservationOrderId: string, body: RefundRequest, options?: ReturnPostOptionalParams): Promise<ReturnPostResponse>;
|
|
2640
2900
|
}
|
|
2641
2901
|
|
|
2642
2902
|
/** Defines headers for Return_post operation. */
|
|
@@ -2646,11 +2906,68 @@ export declare interface ReturnPostHeaders {
|
|
|
2646
2906
|
|
|
2647
2907
|
/** Optional parameters. */
|
|
2648
2908
|
export declare interface ReturnPostOptionalParams extends coreClient.OperationOptions {
|
|
2909
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
2910
|
+
updateIntervalInMs?: number;
|
|
2911
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
2912
|
+
resumeFrom?: string;
|
|
2649
2913
|
}
|
|
2650
2914
|
|
|
2651
2915
|
/** Contains response data for the post operation. */
|
|
2652
2916
|
export declare type ReturnPostResponse = ReturnPostHeaders & RefundResponse;
|
|
2653
2917
|
|
|
2918
|
+
/** Request body for savings plan purchase */
|
|
2919
|
+
export declare interface SavingsPlanPurchaseRequest {
|
|
2920
|
+
/** The name of sku */
|
|
2921
|
+
sku?: SkuName;
|
|
2922
|
+
/** Friendly name of the savings plan */
|
|
2923
|
+
displayName?: string;
|
|
2924
|
+
/** Subscription that will be charged for purchasing reservation or savings plan */
|
|
2925
|
+
billingScopeId?: string;
|
|
2926
|
+
/** Represent savings plan term in ISO 8601 format. */
|
|
2927
|
+
term?: SavingsPlanTerm;
|
|
2928
|
+
/** Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. */
|
|
2929
|
+
billingPlan?: BillingPlan;
|
|
2930
|
+
/** Type of the Applied Scope. */
|
|
2931
|
+
appliedScopeType?: AppliedScopeType;
|
|
2932
|
+
/** Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup */
|
|
2933
|
+
appliedScopeProperties?: AppliedScopeProperties;
|
|
2934
|
+
/** Commitment towards the benefit. */
|
|
2935
|
+
commitment?: Commitment;
|
|
2936
|
+
}
|
|
2937
|
+
|
|
2938
|
+
/**
|
|
2939
|
+
* Defines values for SavingsPlanTerm. \
|
|
2940
|
+
* {@link KnownSavingsPlanTerm} can be used interchangeably with SavingsPlanTerm,
|
|
2941
|
+
* this enum contains the known values that the service supports.
|
|
2942
|
+
* ### Known values supported by the service
|
|
2943
|
+
* **P1Y** \
|
|
2944
|
+
* **P3Y**
|
|
2945
|
+
*/
|
|
2946
|
+
export declare type SavingsPlanTerm = string;
|
|
2947
|
+
|
|
2948
|
+
/** Savings plan purchase details */
|
|
2949
|
+
export declare interface SavingsPlanToPurchaseCalculateExchange {
|
|
2950
|
+
/** Request body for savings plan purchase */
|
|
2951
|
+
properties?: SavingsPlanPurchaseRequest;
|
|
2952
|
+
/** Pricing information containing the amount and the currency code */
|
|
2953
|
+
billingCurrencyTotal?: Price;
|
|
2954
|
+
}
|
|
2955
|
+
|
|
2956
|
+
/** Savings plan purchase details */
|
|
2957
|
+
export declare interface SavingsPlanToPurchaseExchange {
|
|
2958
|
+
/** Fully qualified id of the savings plan order being purchased */
|
|
2959
|
+
savingsPlanOrderId?: string;
|
|
2960
|
+
/** Fully qualified id of the savings plan being purchased. This value is only guaranteed to be non-null if the purchase is successful. */
|
|
2961
|
+
savingsPlanId?: string;
|
|
2962
|
+
/** Request body for savings plan purchase */
|
|
2963
|
+
properties?: SavingsPlanPurchaseRequest;
|
|
2964
|
+
/** Pricing information containing the amount and the currency code */
|
|
2965
|
+
billingCurrencyTotal?: Price;
|
|
2966
|
+
/** Status of the individual operation. */
|
|
2967
|
+
status?: OperationStatus;
|
|
2968
|
+
}
|
|
2969
|
+
|
|
2970
|
+
/** The scope and whether it is valid. */
|
|
2654
2971
|
export declare interface ScopeProperties {
|
|
2655
2972
|
scope?: string;
|
|
2656
2973
|
valid?: boolean;
|
|
@@ -2683,6 +3000,7 @@ export declare interface ServiceErrorDetail {
|
|
|
2683
3000
|
readonly message?: string;
|
|
2684
3001
|
}
|
|
2685
3002
|
|
|
3003
|
+
/** Capability of a sku. */
|
|
2686
3004
|
export declare interface SkuCapability {
|
|
2687
3005
|
/** An invariant to describe the feature. */
|
|
2688
3006
|
name?: string;
|
|
@@ -2690,10 +3008,12 @@ export declare interface SkuCapability {
|
|
|
2690
3008
|
value?: string;
|
|
2691
3009
|
}
|
|
2692
3010
|
|
|
3011
|
+
/** The name of sku */
|
|
2693
3012
|
export declare interface SkuName {
|
|
2694
3013
|
name?: string;
|
|
2695
3014
|
}
|
|
2696
3015
|
|
|
3016
|
+
/** Property of a sku. */
|
|
2697
3017
|
export declare interface SkuProperty {
|
|
2698
3018
|
/** An invariant to describe the feature. */
|
|
2699
3019
|
name?: string;
|
|
@@ -2701,15 +3021,17 @@ export declare interface SkuProperty {
|
|
|
2701
3021
|
value?: string;
|
|
2702
3022
|
}
|
|
2703
3023
|
|
|
3024
|
+
/** Restriction of a sku. */
|
|
2704
3025
|
export declare interface SkuRestriction {
|
|
2705
3026
|
/** The type of restrictions. */
|
|
2706
3027
|
type?: string;
|
|
2707
|
-
/** The value of restrictions. If the restriction type is set to location. This would be different locations where the
|
|
3028
|
+
/** The value of restrictions. If the restriction type is set to location. This would be different locations where the sku is restricted. */
|
|
2708
3029
|
values?: string[];
|
|
2709
3030
|
/** The reason for restriction. */
|
|
2710
3031
|
reasonCode?: string;
|
|
2711
3032
|
}
|
|
2712
3033
|
|
|
3034
|
+
/** The request for reservation split */
|
|
2713
3035
|
export declare interface SplitRequest {
|
|
2714
3036
|
/** List of the quantities in the new reservations to create. */
|
|
2715
3037
|
quantities?: number[];
|
|
@@ -2747,6 +3069,7 @@ export declare interface SubRequest {
|
|
|
2747
3069
|
readonly subRequestId?: string;
|
|
2748
3070
|
}
|
|
2749
3071
|
|
|
3072
|
+
/** The scopes checked by the available scope api. */
|
|
2750
3073
|
export declare interface SubscriptionScopeProperties {
|
|
2751
3074
|
scopes?: ScopeProperties[];
|
|
2752
3075
|
}
|