@azure/arm-reservations 9.0.1-alpha.20250620.1 → 9.0.1-alpha.20250718.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 (2) hide show
  1. package/package.json +1 -1
  2. package/review/{arm-reservations.api.md → arm-reservations-node.api.md} +1675 -1675
package/review/{arm-reservations.api.md → arm-reservations-node.api.md} RENAMED
@@ -1,1675 +1,1675 @@
1
- ## API Report File for "@azure/arm-reservations"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import * as coreAuth from '@azure/core-auth';
8
- import * as coreClient from '@azure/core-client';
9
- import { OperationState } from '@azure/core-lro';
10
- import { PagedAsyncIterableIterator } from '@azure/core-paging';
11
- import { SimplePollerLike } from '@azure/core-lro';
12
-
13
- // @public
14
- export interface AppliedReservationList {
15
- nextLink?: string;
16
- // (undocumented)
17
- value?: string[];
18
- }
19
-
20
- // @public
21
- export interface AppliedReservations {
22
- readonly id?: string;
23
- readonly name?: string;
24
- reservationOrderIds?: AppliedReservationList;
25
- readonly type?: string;
26
- }
27
-
28
- // @public
29
- export interface AppliedScopeProperties {
30
- displayName?: string;
31
- managementGroupId?: string;
32
- resourceGroupId?: string;
33
- subscriptionId?: string;
34
- tenantId?: string;
35
- }
36
-
37
- // @public
38
- export type AppliedScopeType = string;
39
-
40
- // @public
41
- export interface AvailableScopeProperties {
42
- properties?: SubscriptionScopeProperties;
43
- }
44
-
45
- // @public
46
- export interface AvailableScopeRequest {
47
- properties?: AvailableScopeRequestProperties;
48
- }
49
-
50
- // @public
51
- export interface AvailableScopeRequestProperties {
52
- // (undocumented)
53
- scopes?: string[];
54
- }
55
-
56
- // @public (undocumented)
57
- export class AzureReservationAPI extends coreClient.ServiceClient {
58
- // (undocumented)
59
- $host: string;
60
- constructor(credentials: coreAuth.TokenCredential, options?: AzureReservationAPIOptionalParams);
61
- // (undocumented)
62
- calculateExchange: CalculateExchange;
63
- // (undocumented)
64
- calculateRefund: CalculateRefund;
65
- // (undocumented)
66
- exchange: Exchange;
67
- getAppliedReservationList(subscriptionId: string, options?: GetAppliedReservationListOptionalParams): Promise<GetAppliedReservationListResponse>;
68
- listCatalog(subscriptionId: string, options?: GetCatalogOptionalParams): PagedAsyncIterableIterator<Catalog>;
69
- // (undocumented)
70
- operation: Operation;
71
- // (undocumented)
72
- quota: Quota;
73
- // (undocumented)
74
- quotaRequestStatus: QuotaRequestStatus;
75
- // (undocumented)
76
- reservation: Reservation;
77
- // (undocumented)
78
- reservationOrder: ReservationOrder;
79
- // (undocumented)
80
- return: Return;
81
- }
82
-
83
- // @public
84
- export interface AzureReservationAPIOptionalParams extends coreClient.ServiceClientOptions {
85
- $host?: string;
86
- endpoint?: string;
87
- }
88
-
89
- // @public
90
- export interface BillingInformation {
91
- billingCurrencyProratedAmount?: Price;
92
- billingCurrencyRemainingCommitmentAmount?: Price;
93
- billingCurrencyTotalPaidAmount?: Price;
94
- }
95
-
96
- // @public
97
- export type BillingPlan = string;
98
-
99
- // @public
100
- export interface CalculateExchange {
101
- beginPost(body: CalculateExchangeRequest, options?: CalculateExchangePostOptionalParams): Promise<SimplePollerLike<OperationState<CalculateExchangePostResponse>, CalculateExchangePostResponse>>;
102
- beginPostAndWait(body: CalculateExchangeRequest, options?: CalculateExchangePostOptionalParams): Promise<CalculateExchangePostResponse>;
103
- }
104
-
105
- // @public
106
- export interface CalculateExchangeOperationResultResponse {
107
- error?: OperationResultError;
108
- id?: string;
109
- name?: string;
110
- properties?: CalculateExchangeResponseProperties;
111
- status?: CalculateExchangeOperationResultStatus;
112
- }
113
-
114
- // @public
115
- export type CalculateExchangeOperationResultStatus = string;
116
-
117
- // @public
118
- export interface CalculateExchangePostHeaders {
119
- azureAsyncOperation?: string;
120
- location?: string;
121
- retryAfter?: number;
122
- }
123
-
124
- // @public
125
- export interface CalculateExchangePostOptionalParams extends coreClient.OperationOptions {
126
- resumeFrom?: string;
127
- updateIntervalInMs?: number;
128
- }
129
-
130
- // @public
131
- export type CalculateExchangePostResponse = CalculateExchangeOperationResultResponse;
132
-
133
- // @public
134
- export interface CalculateExchangeRequest {
135
- properties?: CalculateExchangeRequestProperties;
136
- }
137
-
138
- // @public
139
- export interface CalculateExchangeRequestProperties {
140
- reservationsToExchange?: ReservationToReturn[];
141
- reservationsToPurchase?: PurchaseRequest[];
142
- savingsPlansToPurchase?: SavingsPlanPurchaseRequest[];
143
- }
144
-
145
- // @public
146
- export interface CalculateExchangeResponseProperties {
147
- netPayable?: Price;
148
- policyResult?: ExchangePolicyErrors;
149
- purchasesTotal?: Price;
150
- refundsTotal?: Price;
151
- reservationsToExchange?: ReservationToExchange[];
152
- reservationsToPurchase?: ReservationToPurchaseCalculateExchange[];
153
- savingsPlansToPurchase?: SavingsPlanToPurchaseCalculateExchange[];
154
- sessionId?: string;
155
- }
156
-
157
- // @public
158
- export interface CalculatePriceResponse {
159
- properties?: CalculatePriceResponseProperties;
160
- }
161
-
162
- // @public
163
- export interface CalculatePriceResponseProperties {
164
- billingCurrencyTotal?: CalculatePriceResponsePropertiesBillingCurrencyTotal;
165
- grandTotal?: number;
166
- isBillingPartnerManaged?: boolean;
167
- isTaxIncluded?: boolean;
168
- netTotal?: number;
169
- // (undocumented)
170
- paymentSchedule?: PaymentDetail[];
171
- pricingCurrencyTotal?: CalculatePriceResponsePropertiesPricingCurrencyTotal;
172
- reservationOrderId?: string;
173
- skuDescription?: string;
174
- skuTitle?: string;
175
- taxTotal?: number;
176
- }
177
-
178
- // @public
179
- export interface CalculatePriceResponsePropertiesBillingCurrencyTotal {
180
- amount?: number;
181
- currencyCode?: string;
182
- }
183
-
184
- // @public
185
- export interface CalculatePriceResponsePropertiesPricingCurrencyTotal {
186
- // (undocumented)
187
- amount?: number;
188
- currencyCode?: string;
189
- }
190
-
191
- // @public
192
- export interface CalculateRefund {
193
- post(reservationOrderId: string, body: CalculateRefundRequest, options?: CalculateRefundPostOptionalParams): Promise<CalculateRefundPostResponse>;
194
- }
195
-
196
- // @public
197
- export interface CalculateRefundPostOptionalParams extends coreClient.OperationOptions {
198
- }
199
-
200
- // @public
201
- export type CalculateRefundPostResponse = CalculateRefundResponse;
202
-
203
- // @public
204
- export interface CalculateRefundRequest {
205
- id?: string;
206
- properties?: CalculateRefundRequestProperties;
207
- }
208
-
209
- // @public
210
- export interface CalculateRefundRequestProperties {
211
- reservationToReturn?: ReservationToReturn;
212
- scope?: string;
213
- }
214
-
215
- // @public
216
- export interface CalculateRefundResponse {
217
- id?: string;
218
- properties?: RefundResponseProperties;
219
- }
220
-
221
- // @public
222
- export interface Catalog {
223
- billingPlans?: {
224
- [propertyName: string]: ReservationBillingPlan[];
225
- };
226
- readonly capabilities?: SkuCapability[];
227
- readonly locations?: string[];
228
- readonly msrp?: CatalogMsrp;
229
- readonly name?: string;
230
- readonly resourceType?: string;
231
- readonly restrictions?: SkuRestriction[];
232
- readonly size?: string;
233
- readonly skuProperties?: SkuProperty[];
234
- readonly terms?: ReservationTerm[];
235
- readonly tier?: string;
236
- }
237
-
238
- // @public
239
- export interface CatalogMsrp {
240
- p1Y?: Price;
241
- p3Y?: Price;
242
- p5Y?: Price;
243
- }
244
-
245
- // @public
246
- export interface CatalogsResult {
247
- readonly nextLink?: string;
248
- totalItems?: number;
249
- readonly value?: Catalog[];
250
- }
251
-
252
- // @public
253
- export interface ChangeDirectoryRequest {
254
- destinationTenantId?: string;
255
- }
256
-
257
- // @public
258
- export interface ChangeDirectoryResponse {
259
- reservationOrder?: ChangeDirectoryResult;
260
- // (undocumented)
261
- reservations?: ChangeDirectoryResult[];
262
- }
263
-
264
- // @public
265
- export interface ChangeDirectoryResult {
266
- error?: string;
267
- id?: string;
268
- isSucceeded?: boolean;
269
- name?: string;
270
- }
271
-
272
- // @public
273
- export interface Commitment extends Price {
274
- grain?: CommitmentGrain;
275
- }
276
-
277
- // @public
278
- export type CommitmentGrain = string;
279
-
280
- // @public
281
- export type CreatedByType = string;
282
-
283
- // @public
284
- export interface CreateGenericQuotaRequestParameters {
285
- value?: CurrentQuotaLimitBase[];
286
- }
287
-
288
- // @public
289
- export interface CurrentQuotaLimit {
290
- readonly id?: string;
291
- readonly message?: string;
292
- readonly name?: string;
293
- properties?: QuotaProperties;
294
- readonly provisioningState?: QuotaRequestState;
295
- readonly type?: string;
296
- }
297
-
298
- // @public
299
- export interface CurrentQuotaLimitBase {
300
- readonly id?: string;
301
- readonly name?: string;
302
- properties?: QuotaProperties;
303
- readonly type?: string;
304
- }
305
-
306
- // @public
307
- export type DisplayProvisioningState = string;
308
-
309
- // @public
310
- export interface ErrorDetails {
311
- readonly code?: string;
312
- readonly message?: string;
313
- readonly target?: string;
314
- }
315
-
316
- // @public
317
- export interface ErrorModel {
318
- error?: ExtendedErrorInfo;
319
- }
320
-
321
- // @public
322
- export interface ErrorResponse {
323
- error?: ErrorDetails;
324
- }
325
-
326
- // @public
327
- export type ErrorResponseCode = string;
328
-
329
- // @public
330
- export interface ExceptionResponse {
331
- error?: ServiceError;
332
- }
333
-
334
- // @public
335
- export interface Exchange {
336
- beginPost(body: ExchangeRequest, options?: ExchangePostOptionalParams): Promise<SimplePollerLike<OperationState<ExchangePostResponse>, ExchangePostResponse>>;
337
- beginPostAndWait(body: ExchangeRequest, options?: ExchangePostOptionalParams): Promise<ExchangePostResponse>;
338
- }
339
-
340
- // @public
341
- export interface ExchangeOperationResultResponse {
342
- error?: OperationResultError;
343
- id?: string;
344
- name?: string;
345
- properties?: ExchangeResponseProperties;
346
- status?: ExchangeOperationResultStatus;
347
- }
348
-
349
- // @public
350
- export type ExchangeOperationResultStatus = string;
351
-
352
- // @public
353
- export interface ExchangePolicyError {
354
- // (undocumented)
355
- code?: string;
356
- // (undocumented)
357
- message?: string;
358
- }
359
-
360
- // @public
361
- export interface ExchangePolicyErrors {
362
- policyErrors?: ExchangePolicyError[];
363
- }
364
-
365
- // @public
366
- export interface ExchangePostHeaders {
367
- azureAsyncOperation?: string;
368
- location?: string;
369
- retryAfter?: number;
370
- }
371
-
372
- // @public
373
- export interface ExchangePostOptionalParams extends coreClient.OperationOptions {
374
- resumeFrom?: string;
375
- updateIntervalInMs?: number;
376
- }
377
-
378
- // @public
379
- export type ExchangePostResponse = ExchangeOperationResultResponse;
380
-
381
- // @public
382
- export interface ExchangeRequest {
383
- properties?: ExchangeRequestProperties;
384
- }
385
-
386
- // @public
387
- export interface ExchangeRequestProperties {
388
- sessionId?: string;
389
- }
390
-
391
- // @public
392
- export interface ExchangeResponseProperties {
393
- netPayable?: Price;
394
- policyResult?: ExchangePolicyErrors;
395
- purchasesTotal?: Price;
396
- refundsTotal?: Price;
397
- reservationsToExchange?: ReservationToReturnForExchange[];
398
- reservationsToPurchase?: ReservationToPurchaseExchange[];
399
- savingsPlansToPurchase?: SavingsPlanToPurchaseExchange[];
400
- sessionId?: string;
401
- }
402
-
403
- // @public
404
- export interface ExtendedErrorInfo {
405
- code?: ErrorResponseCode;
406
- // (undocumented)
407
- message?: string;
408
- }
409
-
410
- // @public (undocumented)
411
- export interface ExtendedStatusInfo {
412
- message?: string;
413
- // (undocumented)
414
- statusCode?: ReservationStatusCode;
415
- }
416
-
417
- // @public
418
- export interface GetAppliedReservationListOptionalParams extends coreClient.OperationOptions {
419
- }
420
-
421
- // @public
422
- export type GetAppliedReservationListResponse = AppliedReservations;
423
-
424
- // @public
425
- export interface GetCatalogNextOptionalParams extends coreClient.OperationOptions {
426
- }
427
-
428
- // @public
429
- export type GetCatalogNextResponse = CatalogsResult;
430
-
431
- // @public
432
- export interface GetCatalogOptionalParams extends coreClient.OperationOptions {
433
- filter?: string;
434
- location?: string;
435
- offerId?: string;
436
- planId?: string;
437
- publisherId?: string;
438
- reservedResourceType?: string;
439
- skip?: number;
440
- take?: number;
441
- }
442
-
443
- // @public
444
- export type GetCatalogResponse = CatalogsResult;
445
-
446
- // @public
447
- export function getContinuationToken(page: unknown): string | undefined;
448
-
449
- // @public
450
- export type InstanceFlexibility = string;
451
-
452
- // @public
453
- export enum KnownAppliedScopeType {
454
- ManagementGroup = "ManagementGroup",
455
- Shared = "Shared",
456
- Single = "Single"
457
- }
458
-
459
- // @public
460
- export enum KnownBillingPlan {
461
- P1M = "P1M"
462
- }
463
-
464
- // @public
465
- export enum KnownCalculateExchangeOperationResultStatus {
466
- Cancelled = "Cancelled",
467
- Failed = "Failed",
468
- Pending = "Pending",
469
- Succeeded = "Succeeded"
470
- }
471
-
472
- // @public
473
- export enum KnownCommitmentGrain {
474
- Hourly = "Hourly"
475
- }
476
-
477
- // @public
478
- export enum KnownCreatedByType {
479
- Application = "Application",
480
- Key = "Key",
481
- ManagedIdentity = "ManagedIdentity",
482
- User = "User"
483
- }
484
-
485
- // @public
486
- export enum KnownDisplayProvisioningState {
487
- Cancelled = "Cancelled",
488
- Expired = "Expired",
489
- Expiring = "Expiring",
490
- Failed = "Failed",
491
- NoBenefit = "NoBenefit",
492
- Pending = "Pending",
493
- Processing = "Processing",
494
- Succeeded = "Succeeded",
495
- Warning = "Warning"
496
- }
497
-
498
- // @public
499
- export enum KnownErrorResponseCode {
500
- ActivateQuoteFailed = "ActivateQuoteFailed",
501
- AppliedScopesNotAssociatedWithCommerceAccount = "AppliedScopesNotAssociatedWithCommerceAccount",
502
- AppliedScopesSameAsExisting = "AppliedScopesSameAsExisting",
503
- AuthorizationFailed = "AuthorizationFailed",
504
- BadRequest = "BadRequest",
505
- BillingCustomerInputError = "BillingCustomerInputError",
506
- BillingError = "BillingError",
507
- BillingPaymentInstrumentHardError = "BillingPaymentInstrumentHardError",
508
- BillingPaymentInstrumentSoftError = "BillingPaymentInstrumentSoftError",
509
- BillingScopeIdCannotBeChanged = "BillingScopeIdCannotBeChanged",
510
- BillingTransientError = "BillingTransientError",
511
- CalculatePriceFailed = "CalculatePriceFailed",
512
- CapacityUpdateScopesFailed = "CapacityUpdateScopesFailed",
513
- ClientCertificateThumbprintNotSet = "ClientCertificateThumbprintNotSet",
514
- CreateQuoteFailed = "CreateQuoteFailed",
515
- Forbidden = "Forbidden",
516
- FulfillmentConfigurationError = "FulfillmentConfigurationError",
517
- FulfillmentError = "FulfillmentError",
518
- FulfillmentOutOfStockError = "FulfillmentOutOfStockError",
519
- FulfillmentTransientError = "FulfillmentTransientError",
520
- HttpMethodNotSupported = "HttpMethodNotSupported",
521
- InternalServerError = "InternalServerError",
522
- InvalidAccessToken = "InvalidAccessToken",
523
- InvalidFulfillmentRequestParameters = "InvalidFulfillmentRequestParameters",
524
- InvalidHealthCheckType = "InvalidHealthCheckType",
525
- InvalidLocationId = "InvalidLocationId",
526
- InvalidRefundQuantity = "InvalidRefundQuantity",
527
- InvalidRequestContent = "InvalidRequestContent",
528
- InvalidRequestUri = "InvalidRequestUri",
529
- InvalidReservationId = "InvalidReservationId",
530
- InvalidReservationOrderId = "InvalidReservationOrderId",
531
- InvalidSingleAppliedScopesCount = "InvalidSingleAppliedScopesCount",
532
- InvalidSubscriptionId = "InvalidSubscriptionId",
533
- InvalidTenantId = "InvalidTenantId",
534
- MissingAppliedScopesForSingle = "MissingAppliedScopesForSingle",
535
- MissingTenantId = "MissingTenantId",
536
- NonsupportedAccountId = "NonsupportedAccountId",
537
- NotSpecified = "NotSpecified",
538
- NotSupportedCountry = "NotSupportedCountry",
539
- NoValidReservationsToReRate = "NoValidReservationsToReRate",
540
- OperationCannotBePerformedInCurrentState = "OperationCannotBePerformedInCurrentState",
541
- OperationFailed = "OperationFailed",
542
- PatchValuesSameAsExisting = "PatchValuesSameAsExisting",
543
- PaymentInstrumentNotFound = "PaymentInstrumentNotFound",
544
- PurchaseError = "PurchaseError",
545
- RefundLimitExceeded = "RefundLimitExceeded",
546
- ReRateOnlyAllowedForEA = "ReRateOnlyAllowedForEA",
547
- ReservationIdNotInReservationOrder = "ReservationIdNotInReservationOrder",
548
- ReservationOrderCreationFailed = "ReservationOrderCreationFailed",
549
- ReservationOrderIdAlreadyExists = "ReservationOrderIdAlreadyExists",
550
- ReservationOrderNotEnabled = "ReservationOrderNotEnabled",
551
- ReservationOrderNotFound = "ReservationOrderNotFound",
552
- RiskCheckFailed = "RiskCheckFailed",
553
- RoleAssignmentCreationFailed = "RoleAssignmentCreationFailed",
554
- SelfServiceRefundNotSupported = "SelfServiceRefundNotSupported",
555
- ServerTimeout = "ServerTimeout",
556
- UnauthenticatedRequestsThrottled = "UnauthenticatedRequestsThrottled",
557
- UnsupportedReservationTerm = "UnsupportedReservationTerm"
558
- }
559
-
560
- // @public
561
- export enum KnownExchangeOperationResultStatus {
562
- Cancelled = "Cancelled",
563
- Failed = "Failed",
564
- PendingPurchases = "PendingPurchases",
565
- PendingRefunds = "PendingRefunds",
566
- Succeeded = "Succeeded"
567
- }
568
-
569
- // @public
570
- export enum KnownInstanceFlexibility {
571
- Off = "Off",
572
- On = "On"
573
- }
574
-
575
- // @public
576
- export enum KnownLocation {
577
- Australiaeast = "australiaeast",
578
- Australiasoutheast = "australiasoutheast",
579
- Brazilsouth = "brazilsouth",
580
- Canadacentral = "canadacentral",
581
- Canadaeast = "canadaeast",
582
- Centralindia = "centralindia",
583
- Centralus = "centralus",
584
- Eastasia = "eastasia",
585
- Eastus = "eastus",
586
- Eastus2 = "eastus2",
587
- Japaneast = "japaneast",
588
- Japanwest = "japanwest",
589
- Northcentralus = "northcentralus",
590
- Northeurope = "northeurope",
591
- Southcentralus = "southcentralus",
592
- Southeastasia = "southeastasia",
593
- Southindia = "southindia",
594
- Uksouth = "uksouth",
595
- Ukwest = "ukwest",
596
- Westcentralus = "westcentralus",
597
- Westeurope = "westeurope",
598
- Westindia = "westindia",
599
- Westus = "westus",
600
- Westus2 = "westus2"
601
- }
602
-
603
- // @public
604
- export enum KnownOperationStatus {
605
- Cancelled = "Cancelled",
606
- Failed = "Failed",
607
- Pending = "Pending",
608
- Succeeded = "Succeeded"
609
- }
610
-
611
- // @public
612
- export enum KnownPaymentStatus {
613
- Cancelled = "Cancelled",
614
- Failed = "Failed",
615
- Scheduled = "Scheduled",
616
- Succeeded = "Succeeded"
617
- }
618
-
619
- // @public
620
- export enum KnownProvisioningState {
621
- BillingFailed = "BillingFailed",
622
- Cancelled = "Cancelled",
623
- ConfirmedBilling = "ConfirmedBilling",
624
- ConfirmedResourceHold = "ConfirmedResourceHold",
625
- Created = "Created",
626
- Creating = "Creating",
627
- Expired = "Expired",
628
- Failed = "Failed",
629
- Merged = "Merged",
630
- PendingBilling = "PendingBilling",
631
- PendingResourceHold = "PendingResourceHold",
632
- Split = "Split",
633
- Succeeded = "Succeeded"
634
- }
635
-
636
- // @public
637
- export enum KnownQuotaRequestState {
638
- Accepted = "Accepted",
639
- Failed = "Failed",
640
- InProgress = "InProgress",
641
- Invalid = "Invalid",
642
- Succeeded = "Succeeded"
643
- }
644
-
645
- // @public
646
- export enum KnownReservationBillingPlan {
647
- Monthly = "Monthly",
648
- Upfront = "Upfront"
649
- }
650
-
651
- // @public
652
- export enum KnownReservationStatusCode {
653
- Active = "Active",
654
- Expired = "Expired",
655
- Merged = "Merged",
656
- None = "None",
657
- PaymentInstrumentError = "PaymentInstrumentError",
658
- Pending = "Pending",
659
- Processing = "Processing",
660
- PurchaseError = "PurchaseError",
661
- Split = "Split",
662
- Succeeded = "Succeeded"
663
- }
664
-
665
- // @public
666
- export enum KnownReservationTerm {
667
- P1Y = "P1Y",
668
- P3Y = "P3Y",
669
- P5Y = "P5Y"
670
- }
671
-
672
- // @public
673
- export enum KnownReservedResourceType {
674
- AppService = "AppService",
675
- AVS = "AVS",
676
- AzureDataExplorer = "AzureDataExplorer",
677
- AzureFiles = "AzureFiles",
678
- BlockBlob = "BlockBlob",
679
- CosmosDb = "CosmosDb",
680
- Databricks = "Databricks",
681
- DataFactory = "DataFactory",
682
- DedicatedHost = "DedicatedHost",
683
- ManagedDisk = "ManagedDisk",
684
- MariaDb = "MariaDb",
685
- MySql = "MySql",
686
- NetAppStorage = "NetAppStorage",
687
- PostgreSql = "PostgreSql",
688
- RedHat = "RedHat",
689
- RedHatOsa = "RedHatOsa",
690
- RedisCache = "RedisCache",
691
- SapHana = "SapHana",
692
- SqlAzureHybridBenefit = "SqlAzureHybridBenefit",
693
- SqlDatabases = "SqlDatabases",
694
- SqlDataWarehouse = "SqlDataWarehouse",
695
- SqlEdge = "SqlEdge",
696
- SuseLinux = "SuseLinux",
697
- VirtualMachines = "VirtualMachines",
698
- VirtualMachineSoftware = "VirtualMachineSoftware",
699
- VMwareCloudSimple = "VMwareCloudSimple"
700
- }
701
-
702
- // @public
703
- export enum KnownResourceType {
704
- Dedicated = "dedicated",
705
- LowPriority = "lowPriority",
706
- ServiceSpecific = "serviceSpecific",
707
- Shared = "shared",
708
- Standard = "standard"
709
- }
710
-
711
- // @public
712
- export enum KnownSavingsPlanTerm {
713
- P1Y = "P1Y",
714
- P3Y = "P3Y"
715
- }
716
-
717
- // @public
718
- export enum KnownUserFriendlyAppliedScopeType {
719
- ManagementGroup = "ManagementGroup",
720
- None = "None",
721
- ResourceGroup = "ResourceGroup",
722
- Shared = "Shared",
723
- Single = "Single"
724
- }
725
-
726
- // @public
727
- export enum KnownUserFriendlyRenewState {
728
- NotApplicable = "NotApplicable",
729
- NotRenewed = "NotRenewed",
730
- Off = "Off",
731
- On = "On",
732
- Renewed = "Renewed"
733
- }
734
-
735
- // @public
736
- export type Location = string;
737
-
738
- // @public
739
- export interface MergeRequest {
740
- sources?: string[];
741
- }
742
-
743
- // @public
744
- export interface Operation {
745
- list(options?: OperationListOptionalParams): PagedAsyncIterableIterator<OperationResponse>;
746
- }
747
-
748
- // @public
749
- export interface OperationDisplay {
750
- // (undocumented)
751
- description?: string;
752
- // (undocumented)
753
- operation?: string;
754
- // (undocumented)
755
- provider?: string;
756
- // (undocumented)
757
- resource?: string;
758
- }
759
-
760
- // @public
761
- export interface OperationList {
762
- nextLink?: string;
763
- // (undocumented)
764
- value?: OperationResponse[];
765
- }
766
-
767
- // @public
768
- export interface OperationListNextOptionalParams extends coreClient.OperationOptions {
769
- }
770
-
771
- // @public
772
- export type OperationListNextResponse = OperationList;
773
-
774
- // @public
775
- export interface OperationListOptionalParams extends coreClient.OperationOptions {
776
- }
777
-
778
- // @public
779
- export type OperationListResponse = OperationList;
780
-
781
- // @public
782
- export interface OperationResponse {
783
- display?: OperationDisplay;
784
- isDataAction?: boolean;
785
- name?: string;
786
- origin?: string;
787
- properties?: Record<string, unknown>;
788
- }
789
-
790
- // @public
791
- export interface OperationResultError {
792
- code?: string;
793
- message?: string;
794
- }
795
-
796
- // @public
797
- export type OperationStatus = string;
798
-
799
- // @public
800
- export interface Patch {
801
- appliedScopeProperties?: AppliedScopeProperties;
802
- appliedScopes?: string[];
803
- appliedScopeType?: AppliedScopeType;
804
- instanceFlexibility?: InstanceFlexibility;
805
- name?: string;
806
- renew?: boolean;
807
- // (undocumented)
808
- renewProperties?: PatchPropertiesRenewProperties;
809
- reviewDateTime?: Date;
810
- }
811
-
812
- // @public (undocumented)
813
- export interface PatchPropertiesRenewProperties {
814
- purchaseProperties?: PurchaseRequest;
815
- }
816
-
817
- // @public
818
- export interface PaymentDetail {
819
- billingAccount?: string;
820
- billingCurrencyTotal?: Price;
821
- dueDate?: Date;
822
- // (undocumented)
823
- extendedStatusInfo?: ExtendedStatusInfo;
824
- paymentDate?: Date;
825
- pricingCurrencyTotal?: Price;
826
- status?: PaymentStatus;
827
- }
828
-
829
- // @public
830
- export type PaymentStatus = string;
831
-
832
- // @public
833
- export interface Price {
834
- // (undocumented)
835
- amount?: number;
836
- currencyCode?: string;
837
- }
838
-
839
- // @public
840
- export type ProvisioningState = string;
841
-
842
- // @public
843
- export interface ProxyResource extends Resource {
844
- }
845
-
846
- // @public
847
- export interface PurchaseRequest {
848
- appliedScopeProperties?: AppliedScopeProperties;
849
- appliedScopes?: string[];
850
- appliedScopeType?: AppliedScopeType;
851
- billingPlan?: ReservationBillingPlan;
852
- billingScopeId?: string;
853
- displayName?: string;
854
- location?: string;
855
- quantity?: number;
856
- renew?: boolean;
857
- reservedResourceProperties?: PurchaseRequestPropertiesReservedResourceProperties;
858
- reservedResourceType?: ReservedResourceType;
859
- reviewDateTime?: Date;
860
- sku?: SkuName;
861
- term?: ReservationTerm;
862
- }
863
-
864
- // @public
865
- export interface PurchaseRequestPropertiesReservedResourceProperties {
866
- instanceFlexibility?: InstanceFlexibility;
867
- }
868
-
869
- // @public
870
- export interface Quota {
871
- beginCreateOrUpdate(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<QuotaCreateOrUpdateResponse>, QuotaCreateOrUpdateResponse>>;
872
- beginCreateOrUpdateAndWait(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaCreateOrUpdateOptionalParams): Promise<QuotaCreateOrUpdateResponse>;
873
- beginUpdate(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaUpdateOptionalParams): Promise<SimplePollerLike<OperationState<QuotaUpdateResponse>, QuotaUpdateResponse>>;
874
- beginUpdateAndWait(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaUpdateOptionalParams): Promise<QuotaUpdateResponse>;
875
- get(subscriptionId: string, providerId: string, location: string, resourceName: string, options?: QuotaGetOptionalParams): Promise<QuotaGetResponse>;
876
- list(subscriptionId: string, providerId: string, location: string, options?: QuotaListOptionalParams): PagedAsyncIterableIterator<CurrentQuotaLimitBase>;
877
- }
878
-
879
- // @public
880
- export interface QuotaCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
881
- resumeFrom?: string;
882
- updateIntervalInMs?: number;
883
- }
884
-
885
- // @public
886
- export type QuotaCreateOrUpdateResponse = CurrentQuotaLimitBase;
887
-
888
- // @public
889
- export interface QuotaGetHeaders {
890
- eTag?: string;
891
- }
892
-
893
- // @public
894
- export interface QuotaGetOptionalParams extends coreClient.OperationOptions {
895
- }
896
-
897
- // @public
898
- export type QuotaGetResponse = QuotaGetHeaders & CurrentQuotaLimitBase;
899
-
900
- // @public
901
- export interface QuotaLimits {
902
- nextLink?: string;
903
- value?: CurrentQuotaLimitBase[];
904
- }
905
-
906
- // @public
907
- export interface QuotaLimitsResponse {
908
- nextLink?: string;
909
- value?: CurrentQuotaLimit[];
910
- }
911
-
912
- // @public
913
- export interface QuotaListHeaders {
914
- eTag?: string;
915
- }
916
-
917
- // @public
918
- export interface QuotaListNextHeaders {
919
- eTag?: string;
920
- }
921
-
922
- // @public
923
- export interface QuotaListNextOptionalParams extends coreClient.OperationOptions {
924
- }
925
-
926
- // @public
927
- export type QuotaListNextResponse = QuotaListNextHeaders & QuotaLimits;
928
-
929
- // @public
930
- export interface QuotaListOptionalParams extends coreClient.OperationOptions {
931
- }
932
-
933
- // @public
934
- export type QuotaListResponse = QuotaListHeaders & QuotaLimits;
935
-
936
- // @public
937
- export interface QuotaProperties {
938
- readonly currentValue?: number;
939
- limit?: number;
940
- name?: ResourceName;
941
- properties?: Record<string, unknown>;
942
- readonly quotaPeriod?: string;
943
- resourceType?: ResourceType;
944
- unit?: string;
945
- }
946
-
947
- // @public
948
- export interface QuotaRequestDetails {
949
- readonly id?: string;
950
- readonly message?: string;
951
- readonly name?: string;
952
- provisioningState?: QuotaRequestState;
953
- readonly requestSubmitTime?: Date;
954
- readonly type?: string;
955
- value?: SubRequest[];
956
- }
957
-
958
- // @public
959
- export interface QuotaRequestDetailsList {
960
- nextLink?: string;
961
- value?: QuotaRequestDetails[];
962
- }
963
-
964
- // @public
965
- export interface QuotaRequestOneResourceSubmitResponse {
966
- readonly id?: string;
967
- readonly idPropertiesId?: string;
968
- readonly message?: string;
969
- readonly name?: string;
970
- readonly namePropertiesName?: string;
971
- properties?: QuotaProperties;
972
- readonly provisioningState?: QuotaRequestState;
973
- readonly requestSubmitTime?: Date;
974
- readonly type?: string;
975
- readonly typePropertiesType?: string;
976
- }
977
-
978
- // @public
979
- export interface QuotaRequestProperties {
980
- readonly message?: string;
981
- provisioningState?: QuotaRequestState;
982
- readonly requestSubmitTime?: Date;
983
- value?: SubRequest[];
984
- }
985
-
986
- // @public
987
- export type QuotaRequestState = string;
988
-
989
- // @public
990
- export interface QuotaRequestStatus {
991
- get(subscriptionId: string, providerId: string, location: string, id: string, options?: QuotaRequestStatusGetOptionalParams): Promise<QuotaRequestStatusGetResponse>;
992
- list(subscriptionId: string, providerId: string, location: string, options?: QuotaRequestStatusListOptionalParams): PagedAsyncIterableIterator<QuotaRequestDetails>;
993
- }
994
-
995
- // @public
996
- export interface QuotaRequestStatusGetOptionalParams extends coreClient.OperationOptions {
997
- }
998
-
999
- // @public
1000
- export type QuotaRequestStatusGetResponse = QuotaRequestDetails;
1001
-
1002
- // @public
1003
- export interface QuotaRequestStatusListNextOptionalParams extends coreClient.OperationOptions {
1004
- }
1005
-
1006
- // @public
1007
- export type QuotaRequestStatusListNextResponse = QuotaRequestDetailsList;
1008
-
1009
- // @public
1010
- export interface QuotaRequestStatusListOptionalParams extends coreClient.OperationOptions {
1011
- filter?: string;
1012
- skiptoken?: string;
1013
- top?: number;
1014
- }
1015
-
1016
- // @public
1017
- export type QuotaRequestStatusListResponse = QuotaRequestDetailsList;
1018
-
1019
- // @public
1020
- export interface QuotaRequestSubmitResponse {
1021
- readonly id?: string;
1022
- readonly name?: string;
1023
- properties?: QuotaRequestProperties;
1024
- readonly type?: string;
1025
- }
1026
-
1027
- // @public
1028
- export interface QuotaRequestSubmitResponse201 {
1029
- readonly id?: string;
1030
- readonly message?: string;
1031
- readonly name?: string;
1032
- readonly provisioningState?: QuotaRequestState;
1033
- readonly type?: string;
1034
- }
1035
-
1036
- // @public
1037
- export interface QuotaUpdateOptionalParams extends coreClient.OperationOptions {
1038
- resumeFrom?: string;
1039
- updateIntervalInMs?: number;
1040
- }
1041
-
1042
- // @public
1043
- export type QuotaUpdateResponse = CurrentQuotaLimitBase;
1044
-
1045
- // @public
1046
- export interface RefundBillingInformation {
1047
- billingCurrencyProratedAmount?: Price;
1048
- billingCurrencyRemainingCommitmentAmount?: Price;
1049
- billingCurrencyTotalPaidAmount?: Price;
1050
- billingPlan?: ReservationBillingPlan;
1051
- completedTransactions?: number;
1052
- totalTransactions?: number;
1053
- }
1054
-
1055
- // @public
1056
- export interface RefundPolicyError {
1057
- code?: ErrorResponseCode;
1058
- // (undocumented)
1059
- message?: string;
1060
- }
1061
-
1062
- // @public
1063
- export interface RefundPolicyResult {
1064
- properties?: RefundPolicyResultProperty;
1065
- }
1066
-
1067
- // @public
1068
- export interface RefundPolicyResultProperty {
1069
- consumedRefundsTotal?: Price;
1070
- maxRefundLimit?: Price;
1071
- policyErrors?: RefundPolicyError[];
1072
- }
1073
-
1074
- // @public
1075
- export interface RefundRequest {
1076
- properties?: RefundRequestProperties;
1077
- }
1078
-
1079
- // @public
1080
- export interface RefundRequestProperties {
1081
- reservationToReturn?: ReservationToReturn;
1082
- returnReason?: string;
1083
- scope?: string;
1084
- sessionId?: string;
1085
- }
1086
-
1087
- // @public
1088
- export interface RefundResponse {
1089
- id?: string;
1090
- properties?: RefundResponseProperties;
1091
- }
1092
-
1093
- // @public
1094
- export interface RefundResponseProperties {
1095
- billingInformation?: RefundBillingInformation;
1096
- billingRefundAmount?: Price;
1097
- policyResult?: RefundPolicyResult;
1098
- pricingRefundAmount?: Price;
1099
- quantity?: number;
1100
- sessionId?: string;
1101
- }
1102
-
1103
- // @public
1104
- export interface RenewPropertiesResponse {
1105
- billingCurrencyTotal?: RenewPropertiesResponseBillingCurrencyTotal;
1106
- pricingCurrencyTotal?: RenewPropertiesResponsePricingCurrencyTotal;
1107
- purchaseProperties?: PurchaseRequest;
1108
- }
1109
-
1110
- // @public
1111
- export interface RenewPropertiesResponseBillingCurrencyTotal {
1112
- // (undocumented)
1113
- amount?: number;
1114
- currencyCode?: string;
1115
- }
1116
-
1117
- // @public
1118
- export interface RenewPropertiesResponsePricingCurrencyTotal {
1119
- // (undocumented)
1120
- amount?: number;
1121
- currencyCode?: string;
1122
- }
1123
-
1124
- // @public
1125
- export interface Reservation {
1126
- archive(reservationOrderId: string, reservationId: string, options?: ReservationArchiveOptionalParams): Promise<void>;
1127
- beginAvailableScopes(reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams): Promise<SimplePollerLike<OperationState<ReservationAvailableScopesResponse>, ReservationAvailableScopesResponse>>;
1128
- beginAvailableScopesAndWait(reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams): Promise<ReservationAvailableScopesResponse>;
1129
- beginMerge(reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams): Promise<SimplePollerLike<OperationState<ReservationMergeResponse>, ReservationMergeResponse>>;
1130
- beginMergeAndWait(reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams): Promise<ReservationMergeResponse>;
1131
- beginSplit(reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams): Promise<SimplePollerLike<OperationState<ReservationSplitResponse>, ReservationSplitResponse>>;
1132
- beginSplitAndWait(reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams): Promise<ReservationSplitResponse>;
1133
- beginUpdate(reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ReservationUpdateResponse>, ReservationUpdateResponse>>;
1134
- beginUpdateAndWait(reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams): Promise<ReservationUpdateResponse>;
1135
- get(reservationOrderId: string, reservationId: string, options?: ReservationGetOptionalParams): Promise<ReservationGetResponse>;
1136
- list(reservationOrderId: string, options?: ReservationListOptionalParams): PagedAsyncIterableIterator<ReservationResponse>;
1137
- listAll(options?: ReservationListAllOptionalParams): PagedAsyncIterableIterator<ReservationResponse>;
1138
- listRevisions(reservationOrderId: string, reservationId: string, options?: ReservationListRevisionsOptionalParams): PagedAsyncIterableIterator<ReservationResponse>;
1139
- unarchive(reservationOrderId: string, reservationId: string, options?: ReservationUnarchiveOptionalParams): Promise<void>;
1140
- }
1141
-
1142
- // @public
1143
- export interface ReservationArchiveOptionalParams extends coreClient.OperationOptions {
1144
- }
1145
-
1146
- // @public
1147
- export interface ReservationAvailableScopesOptionalParams extends coreClient.OperationOptions {
1148
- resumeFrom?: string;
1149
- updateIntervalInMs?: number;
1150
- }
1151
-
1152
- // @public
1153
- export type ReservationAvailableScopesResponse = AvailableScopeProperties;
1154
-
1155
- // @public
1156
- export type ReservationBillingPlan = string;
1157
-
1158
- // @public
1159
- export interface ReservationGetOptionalParams extends coreClient.OperationOptions {
1160
- expand?: string;
1161
- }
1162
-
1163
- // @public
1164
- export type ReservationGetResponse = ReservationResponse;
1165
-
1166
- // @public
1167
- export interface ReservationList {
1168
- nextLink?: string;
1169
- // (undocumented)
1170
- value?: ReservationResponse[];
1171
- }
1172
-
1173
- // @public
1174
- export interface ReservationListAllNextOptionalParams extends coreClient.OperationOptions {
1175
- }
1176
-
1177
- // @public
1178
- export type ReservationListAllNextResponse = ReservationsListResult;
1179
-
1180
- // @public
1181
- export interface ReservationListAllOptionalParams extends coreClient.OperationOptions {
1182
- filter?: string;
1183
- orderby?: string;
1184
- refreshSummary?: string;
1185
- selectedState?: string;
1186
- skiptoken?: number;
1187
- take?: number;
1188
- }
1189
-
1190
- // @public
1191
- export type ReservationListAllResponse = ReservationsListResult;
1192
-
1193
- // @public
1194
- export interface ReservationListNextOptionalParams extends coreClient.OperationOptions {
1195
- }
1196
-
1197
- // @public
1198
- export type ReservationListNextResponse = ReservationList;
1199
-
1200
- // @public
1201
- export interface ReservationListOptionalParams extends coreClient.OperationOptions {
1202
- }
1203
-
1204
- // @public
1205
- export type ReservationListResponse = ReservationList;
1206
-
1207
- // @public
1208
- export interface ReservationListRevisionsNextOptionalParams extends coreClient.OperationOptions {
1209
- }
1210
-
1211
- // @public
1212
- export type ReservationListRevisionsNextResponse = ReservationList;
1213
-
1214
- // @public
1215
- export interface ReservationListRevisionsOptionalParams extends coreClient.OperationOptions {
1216
- }
1217
-
1218
- // @public
1219
- export type ReservationListRevisionsResponse = ReservationList;
1220
-
1221
- // @public
1222
- export interface ReservationMergeHeaders {
1223
- location?: string;
1224
- retryAfter?: number;
1225
- }
1226
-
1227
- // @public
1228
- export interface ReservationMergeOptionalParams extends coreClient.OperationOptions {
1229
- resumeFrom?: string;
1230
- updateIntervalInMs?: number;
1231
- }
1232
-
1233
- // @public
1234
- export interface ReservationMergeProperties {
1235
- mergeDestination?: string;
1236
- mergeSources?: string[];
1237
- }
1238
-
1239
- // @public
1240
- export type ReservationMergeResponse = ReservationResponse[];
1241
-
1242
- // @public
1243
- export interface ReservationOrder {
1244
- beginPurchase(reservationOrderId: string, body: PurchaseRequest, options?: ReservationOrderPurchaseOptionalParams): Promise<SimplePollerLike<OperationState<ReservationOrderPurchaseResponse>, ReservationOrderPurchaseResponse>>;
1245
- beginPurchaseAndWait(reservationOrderId: string, body: PurchaseRequest, options?: ReservationOrderPurchaseOptionalParams): Promise<ReservationOrderPurchaseResponse>;
1246
- calculate(body: PurchaseRequest, options?: ReservationOrderCalculateOptionalParams): Promise<ReservationOrderCalculateResponse>;
1247
- changeDirectory(reservationOrderId: string, body: ChangeDirectoryRequest, options?: ReservationOrderChangeDirectoryOptionalParams): Promise<ReservationOrderChangeDirectoryResponse>;
1248
- get(reservationOrderId: string, options?: ReservationOrderGetOptionalParams): Promise<ReservationOrderGetResponse>;
1249
- list(options?: ReservationOrderListOptionalParams): PagedAsyncIterableIterator<ReservationOrderResponse>;
1250
- }
1251
-
1252
- // @public
1253
- export interface ReservationOrderBillingPlanInformation {
1254
- nextPaymentDueDate?: Date;
1255
- pricingCurrencyTotal?: Price;
1256
- startDate?: Date;
1257
- // (undocumented)
1258
- transactions?: PaymentDetail[];
1259
- }
1260
-
1261
- // @public
1262
- export interface ReservationOrderCalculateOptionalParams extends coreClient.OperationOptions {
1263
- }
1264
-
1265
- // @public
1266
- export type ReservationOrderCalculateResponse = CalculatePriceResponse;
1267
-
1268
- // @public
1269
- export interface ReservationOrderChangeDirectoryOptionalParams extends coreClient.OperationOptions {
1270
- }
1271
-
1272
- // @public
1273
- export type ReservationOrderChangeDirectoryResponse = ChangeDirectoryResponse;
1274
-
1275
- // @public
1276
- export interface ReservationOrderGetOptionalParams extends coreClient.OperationOptions {
1277
- expand?: string;
1278
- }
1279
-
1280
- // @public
1281
- export type ReservationOrderGetResponse = ReservationOrderResponse;
1282
-
1283
- // @public
1284
- export interface ReservationOrderList {
1285
- nextLink?: string;
1286
- // (undocumented)
1287
- value?: ReservationOrderResponse[];
1288
- }
1289
-
1290
- // @public
1291
- export interface ReservationOrderListNextOptionalParams extends coreClient.OperationOptions {
1292
- }
1293
-
1294
- // @public
1295
- export type ReservationOrderListNextResponse = ReservationOrderList;
1296
-
1297
- // @public
1298
- export interface ReservationOrderListOptionalParams extends coreClient.OperationOptions {
1299
- }
1300
-
1301
- // @public
1302
- export type ReservationOrderListResponse = ReservationOrderList;
1303
-
1304
- // @public
1305
- export interface ReservationOrderPurchaseHeaders {
1306
- location?: string;
1307
- retryAfter?: number;
1308
- }
1309
-
1310
- // @public
1311
- export interface ReservationOrderPurchaseOptionalParams extends coreClient.OperationOptions {
1312
- resumeFrom?: string;
1313
- updateIntervalInMs?: number;
1314
- }
1315
-
1316
- // @public
1317
- export type ReservationOrderPurchaseResponse = ReservationOrderResponse;
1318
-
1319
- // @public
1320
- export interface ReservationOrderResponse {
1321
- benefitStartTime?: Date;
1322
- billingPlan?: ReservationBillingPlan;
1323
- createdDateTime?: Date;
1324
- displayName?: string;
1325
- // (undocumented)
1326
- etag?: number;
1327
- expiryDate?: Date;
1328
- expiryDateTime?: Date;
1329
- readonly id?: string;
1330
- readonly name?: string;
1331
- originalQuantity?: number;
1332
- planInformation?: ReservationOrderBillingPlanInformation;
1333
- provisioningState?: ProvisioningState;
1334
- requestDateTime?: Date;
1335
- // (undocumented)
1336
- reservations?: ReservationResponse[];
1337
- reviewDateTime?: Date;
1338
- readonly systemData?: SystemData;
1339
- term?: ReservationTerm;
1340
- readonly type?: string;
1341
- }
1342
-
1343
- // @public
1344
- export interface ReservationResponse extends ProxyResource {
1345
- // (undocumented)
1346
- etag?: number;
1347
- kind?: "Microsoft.Compute";
1348
- location?: string;
1349
- properties?: ReservationsProperties;
1350
- sku?: SkuName;
1351
- }
1352
-
1353
- // @public
1354
- export interface ReservationsListResult {
1355
- readonly nextLink?: string;
1356
- summary?: ReservationSummary;
1357
- readonly value?: ReservationResponse[];
1358
- }
1359
-
1360
- // @public
1361
- export interface ReservationSplitHeaders {
1362
- location?: string;
1363
- retryAfter?: number;
1364
- }
1365
-
1366
- // @public
1367
- export interface ReservationSplitOptionalParams extends coreClient.OperationOptions {
1368
- resumeFrom?: string;
1369
- updateIntervalInMs?: number;
1370
- }
1371
-
1372
- // @public
1373
- export interface ReservationSplitProperties {
1374
- splitDestinations?: string[];
1375
- splitSource?: string;
1376
- }
1377
-
1378
- // @public
1379
- export type ReservationSplitResponse = ReservationResponse[];
1380
-
1381
- // @public
1382
- export interface ReservationsProperties {
1383
- appliedScopeProperties?: AppliedScopeProperties;
1384
- appliedScopes?: string[];
1385
- appliedScopeType?: AppliedScopeType;
1386
- archived?: boolean;
1387
- benefitStartTime?: Date;
1388
- billingPlan?: ReservationBillingPlan;
1389
- billingScopeId?: string;
1390
- capabilities?: string;
1391
- displayName?: string;
1392
- readonly displayProvisioningState?: string;
1393
- effectiveDateTime?: Date;
1394
- expiryDate?: Date;
1395
- expiryDateTime?: Date;
1396
- extendedStatusInfo?: ExtendedStatusInfo;
1397
- instanceFlexibility?: InstanceFlexibility;
1398
- readonly lastUpdatedDateTime?: Date;
1399
- mergeProperties?: ReservationMergeProperties;
1400
- provisioningState?: ProvisioningState;
1401
- readonly provisioningSubState?: string;
1402
- purchaseDate?: Date;
1403
- purchaseDateTime?: Date;
1404
- quantity?: number;
1405
- renew?: boolean;
1406
- renewDestination?: string;
1407
- renewProperties?: RenewPropertiesResponse;
1408
- renewSource?: string;
1409
- reservedResourceType?: ReservedResourceType;
1410
- reviewDateTime?: Date;
1411
- skuDescription?: string;
1412
- splitProperties?: ReservationSplitProperties;
1413
- swapProperties?: ReservationSwapProperties;
1414
- term?: ReservationTerm;
1415
- readonly userFriendlyAppliedScopeType?: string;
1416
- readonly userFriendlyRenewState?: string;
1417
- readonly utilization?: ReservationsPropertiesUtilization;
1418
- }
1419
-
1420
- // @public
1421
- export interface ReservationsPropertiesUtilization {
1422
- aggregates?: ReservationUtilizationAggregates[];
1423
- readonly trend?: string;
1424
- }
1425
-
1426
- // @public
1427
- export type ReservationStatusCode = string;
1428
-
1429
- // @public
1430
- export interface ReservationSummary {
1431
- readonly cancelledCount?: number;
1432
- readonly expiredCount?: number;
1433
- readonly expiringCount?: number;
1434
- readonly failedCount?: number;
1435
- readonly noBenefitCount?: number;
1436
- readonly pendingCount?: number;
1437
- readonly processingCount?: number;
1438
- readonly succeededCount?: number;
1439
- readonly warningCount?: number;
1440
- }
1441
-
1442
- // @public
1443
- export interface ReservationSwapProperties {
1444
- swapDestination?: string;
1445
- swapSource?: string;
1446
- }
1447
-
1448
- // @public
1449
- export type ReservationTerm = string;
1450
-
1451
- // @public
1452
- export interface ReservationToExchange {
1453
- billingInformation?: BillingInformation;
1454
- billingRefundAmount?: Price;
1455
- quantity?: number;
1456
- reservationId?: string;
1457
- }
1458
-
1459
- // @public
1460
- export interface ReservationToPurchaseCalculateExchange {
1461
- billingCurrencyTotal?: Price;
1462
- properties?: PurchaseRequest;
1463
- }
1464
-
1465
- // @public
1466
- export interface ReservationToPurchaseExchange {
1467
- billingCurrencyTotal?: Price;
1468
- properties?: PurchaseRequest;
1469
- reservationId?: string;
1470
- reservationOrderId?: string;
1471
- status?: OperationStatus;
1472
- }
1473
-
1474
- // @public
1475
- export interface ReservationToReturn {
1476
- quantity?: number;
1477
- reservationId?: string;
1478
- }
1479
-
1480
- // @public
1481
- export interface ReservationToReturnForExchange {
1482
- billingInformation?: BillingInformation;
1483
- billingRefundAmount?: Price;
1484
- quantity?: number;
1485
- reservationId?: string;
1486
- status?: OperationStatus;
1487
- }
1488
-
1489
- // @public
1490
- export interface ReservationUnarchiveOptionalParams extends coreClient.OperationOptions {
1491
- }
1492
-
1493
- // @public
1494
- export interface ReservationUpdateHeaders {
1495
- azureAsyncOperation?: string;
1496
- location?: string;
1497
- retryAfter?: number;
1498
- }
1499
-
1500
- // @public
1501
- export interface ReservationUpdateOptionalParams extends coreClient.OperationOptions {
1502
- resumeFrom?: string;
1503
- updateIntervalInMs?: number;
1504
- }
1505
-
1506
- // @public
1507
- export type ReservationUpdateResponse = ReservationResponse;
1508
-
1509
- // @public
1510
- export interface ReservationUtilizationAggregates {
1511
- readonly grain?: number;
1512
- readonly grainUnit?: string;
1513
- readonly value?: number;
1514
- readonly valueUnit?: string;
1515
- }
1516
-
1517
- // @public
1518
- export type ReservedResourceType = string;
1519
-
1520
- // @public
1521
- export interface Resource {
1522
- readonly id?: string;
1523
- readonly name?: string;
1524
- readonly systemData?: SystemData;
1525
- readonly type?: string;
1526
- }
1527
-
1528
- // @public
1529
- export interface ResourceName {
1530
- readonly localizedValue?: string;
1531
- value?: string;
1532
- }
1533
-
1534
- // @public
1535
- export type ResourceType = string;
1536
-
1537
- // @public
1538
- export interface Return {
1539
- beginPost(reservationOrderId: string, body: RefundRequest, options?: ReturnPostOptionalParams): Promise<SimplePollerLike<OperationState<ReturnPostResponse>, ReturnPostResponse>>;
1540
- beginPostAndWait(reservationOrderId: string, body: RefundRequest, options?: ReturnPostOptionalParams): Promise<ReturnPostResponse>;
1541
- }
1542
-
1543
- // @public
1544
- export interface ReturnPostHeaders {
1545
- // (undocumented)
1546
- location?: string;
1547
- }
1548
-
1549
- // @public
1550
- export interface ReturnPostOptionalParams extends coreClient.OperationOptions {
1551
- resumeFrom?: string;
1552
- updateIntervalInMs?: number;
1553
- }
1554
-
1555
- // @public
1556
- export type ReturnPostResponse = ReservationOrderResponse;
1557
-
1558
- // @public
1559
- export interface SavingsPlanPurchaseRequest {
1560
- appliedScopeProperties?: AppliedScopeProperties;
1561
- appliedScopeType?: AppliedScopeType;
1562
- billingPlan?: BillingPlan;
1563
- billingScopeId?: string;
1564
- commitment?: Commitment;
1565
- displayName?: string;
1566
- sku?: SkuName;
1567
- term?: SavingsPlanTerm;
1568
- }
1569
-
1570
- // @public
1571
- export type SavingsPlanTerm = string;
1572
-
1573
- // @public
1574
- export interface SavingsPlanToPurchaseCalculateExchange {
1575
- billingCurrencyTotal?: Price;
1576
- properties?: SavingsPlanPurchaseRequest;
1577
- }
1578
-
1579
- // @public
1580
- export interface SavingsPlanToPurchaseExchange {
1581
- billingCurrencyTotal?: Price;
1582
- properties?: SavingsPlanPurchaseRequest;
1583
- savingsPlanId?: string;
1584
- savingsPlanOrderId?: string;
1585
- status?: OperationStatus;
1586
- }
1587
-
1588
- // @public
1589
- export interface ScopeProperties {
1590
- // (undocumented)
1591
- scope?: string;
1592
- // (undocumented)
1593
- valid?: boolean;
1594
- }
1595
-
1596
- // @public
1597
- export interface ServiceError {
1598
- code?: string;
1599
- readonly details?: ServiceErrorDetail[];
1600
- message?: string;
1601
- }
1602
-
1603
- // @public
1604
- export interface ServiceErrorDetail {
1605
- readonly code?: string;
1606
- readonly message?: string;
1607
- }
1608
-
1609
- // @public
1610
- export interface SkuCapability {
1611
- name?: string;
1612
- value?: string;
1613
- }
1614
-
1615
- // @public
1616
- export interface SkuName {
1617
- // (undocumented)
1618
- name?: string;
1619
- }
1620
-
1621
- // @public
1622
- export interface SkuProperty {
1623
- name?: string;
1624
- value?: string;
1625
- }
1626
-
1627
- // @public
1628
- export interface SkuRestriction {
1629
- reasonCode?: string;
1630
- type?: string;
1631
- values?: string[];
1632
- }
1633
-
1634
- // @public
1635
- export interface SplitRequest {
1636
- quantities?: number[];
1637
- reservationId?: string;
1638
- }
1639
-
1640
- // @public
1641
- export interface SubRequest {
1642
- readonly limit?: number;
1643
- readonly message?: string;
1644
- name?: ResourceName;
1645
- provisioningState?: QuotaRequestState;
1646
- readonly resourceType?: string;
1647
- readonly subRequestId?: string;
1648
- unit?: string;
1649
- }
1650
-
1651
- // @public
1652
- export interface SubscriptionScopeProperties {
1653
- // (undocumented)
1654
- scopes?: ScopeProperties[];
1655
- }
1656
-
1657
- // @public
1658
- export interface SystemData {
1659
- createdAt?: Date;
1660
- createdBy?: string;
1661
- createdByType?: CreatedByType;
1662
- lastModifiedAt?: Date;
1663
- lastModifiedBy?: string;
1664
- lastModifiedByType?: CreatedByType;
1665
- }
1666
-
1667
- // @public
1668
- export type UserFriendlyAppliedScopeType = string;
1669
-
1670
- // @public
1671
- export type UserFriendlyRenewState = string;
1672
-
1673
- // (No @packageDocumentation comment for this package)
1674
-
1675
- ```
1
+ ## API Report File for "@azure/arm-reservations"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import * as coreAuth from '@azure/core-auth';
8
+ import * as coreClient from '@azure/core-client';
9
+ import { OperationState } from '@azure/core-lro';
10
+ import { PagedAsyncIterableIterator } from '@azure/core-paging';
11
+ import { SimplePollerLike } from '@azure/core-lro';
12
+
13
+ // @public
14
+ export interface AppliedReservationList {
15
+ nextLink?: string;
16
+ // (undocumented)
17
+ value?: string[];
18
+ }
19
+
20
+ // @public
21
+ export interface AppliedReservations {
22
+ readonly id?: string;
23
+ readonly name?: string;
24
+ reservationOrderIds?: AppliedReservationList;
25
+ readonly type?: string;
26
+ }
27
+
28
+ // @public
29
+ export interface AppliedScopeProperties {
30
+ displayName?: string;
31
+ managementGroupId?: string;
32
+ resourceGroupId?: string;
33
+ subscriptionId?: string;
34
+ tenantId?: string;
35
+ }
36
+
37
+ // @public
38
+ export type AppliedScopeType = string;
39
+
40
+ // @public
41
+ export interface AvailableScopeProperties {
42
+ properties?: SubscriptionScopeProperties;
43
+ }
44
+
45
+ // @public
46
+ export interface AvailableScopeRequest {
47
+ properties?: AvailableScopeRequestProperties;
48
+ }
49
+
50
+ // @public
51
+ export interface AvailableScopeRequestProperties {
52
+ // (undocumented)
53
+ scopes?: string[];
54
+ }
55
+
56
+ // @public (undocumented)
57
+ export class AzureReservationAPI extends coreClient.ServiceClient {
58
+ // (undocumented)
59
+ $host: string;
60
+ constructor(credentials: coreAuth.TokenCredential, options?: AzureReservationAPIOptionalParams);
61
+ // (undocumented)
62
+ calculateExchange: CalculateExchange;
63
+ // (undocumented)
64
+ calculateRefund: CalculateRefund;
65
+ // (undocumented)
66
+ exchange: Exchange;
67
+ getAppliedReservationList(subscriptionId: string, options?: GetAppliedReservationListOptionalParams): Promise<GetAppliedReservationListResponse>;
68
+ listCatalog(subscriptionId: string, options?: GetCatalogOptionalParams): PagedAsyncIterableIterator<Catalog>;
69
+ // (undocumented)
70
+ operation: Operation;
71
+ // (undocumented)
72
+ quota: Quota;
73
+ // (undocumented)
74
+ quotaRequestStatus: QuotaRequestStatus;
75
+ // (undocumented)
76
+ reservation: Reservation;
77
+ // (undocumented)
78
+ reservationOrder: ReservationOrder;
79
+ // (undocumented)
80
+ return: Return;
81
+ }
82
+
83
+ // @public
84
+ export interface AzureReservationAPIOptionalParams extends coreClient.ServiceClientOptions {
85
+ $host?: string;
86
+ endpoint?: string;
87
+ }
88
+
89
+ // @public
90
+ export interface BillingInformation {
91
+ billingCurrencyProratedAmount?: Price;
92
+ billingCurrencyRemainingCommitmentAmount?: Price;
93
+ billingCurrencyTotalPaidAmount?: Price;
94
+ }
95
+
96
+ // @public
97
+ export type BillingPlan = string;
98
+
99
+ // @public
100
+ export interface CalculateExchange {
101
+ beginPost(body: CalculateExchangeRequest, options?: CalculateExchangePostOptionalParams): Promise<SimplePollerLike<OperationState<CalculateExchangePostResponse>, CalculateExchangePostResponse>>;
102
+ beginPostAndWait(body: CalculateExchangeRequest, options?: CalculateExchangePostOptionalParams): Promise<CalculateExchangePostResponse>;
103
+ }
104
+
105
+ // @public
106
+ export interface CalculateExchangeOperationResultResponse {
107
+ error?: OperationResultError;
108
+ id?: string;
109
+ name?: string;
110
+ properties?: CalculateExchangeResponseProperties;
111
+ status?: CalculateExchangeOperationResultStatus;
112
+ }
113
+
114
+ // @public
115
+ export type CalculateExchangeOperationResultStatus = string;
116
+
117
+ // @public
118
+ export interface CalculateExchangePostHeaders {
119
+ azureAsyncOperation?: string;
120
+ location?: string;
121
+ retryAfter?: number;
122
+ }
123
+
124
+ // @public
125
+ export interface CalculateExchangePostOptionalParams extends coreClient.OperationOptions {
126
+ resumeFrom?: string;
127
+ updateIntervalInMs?: number;
128
+ }
129
+
130
+ // @public
131
+ export type CalculateExchangePostResponse = CalculateExchangeOperationResultResponse;
132
+
133
+ // @public
134
+ export interface CalculateExchangeRequest {
135
+ properties?: CalculateExchangeRequestProperties;
136
+ }
137
+
138
+ // @public
139
+ export interface CalculateExchangeRequestProperties {
140
+ reservationsToExchange?: ReservationToReturn[];
141
+ reservationsToPurchase?: PurchaseRequest[];
142
+ savingsPlansToPurchase?: SavingsPlanPurchaseRequest[];
143
+ }
144
+
145
+ // @public
146
+ export interface CalculateExchangeResponseProperties {
147
+ netPayable?: Price;
148
+ policyResult?: ExchangePolicyErrors;
149
+ purchasesTotal?: Price;
150
+ refundsTotal?: Price;
151
+ reservationsToExchange?: ReservationToExchange[];
152
+ reservationsToPurchase?: ReservationToPurchaseCalculateExchange[];
153
+ savingsPlansToPurchase?: SavingsPlanToPurchaseCalculateExchange[];
154
+ sessionId?: string;
155
+ }
156
+
157
+ // @public
158
+ export interface CalculatePriceResponse {
159
+ properties?: CalculatePriceResponseProperties;
160
+ }
161
+
162
+ // @public
163
+ export interface CalculatePriceResponseProperties {
164
+ billingCurrencyTotal?: CalculatePriceResponsePropertiesBillingCurrencyTotal;
165
+ grandTotal?: number;
166
+ isBillingPartnerManaged?: boolean;
167
+ isTaxIncluded?: boolean;
168
+ netTotal?: number;
169
+ // (undocumented)
170
+ paymentSchedule?: PaymentDetail[];
171
+ pricingCurrencyTotal?: CalculatePriceResponsePropertiesPricingCurrencyTotal;
172
+ reservationOrderId?: string;
173
+ skuDescription?: string;
174
+ skuTitle?: string;
175
+ taxTotal?: number;
176
+ }
177
+
178
+ // @public
179
+ export interface CalculatePriceResponsePropertiesBillingCurrencyTotal {
180
+ amount?: number;
181
+ currencyCode?: string;
182
+ }
183
+
184
+ // @public
185
+ export interface CalculatePriceResponsePropertiesPricingCurrencyTotal {
186
+ // (undocumented)
187
+ amount?: number;
188
+ currencyCode?: string;
189
+ }
190
+
191
+ // @public
192
+ export interface CalculateRefund {
193
+ post(reservationOrderId: string, body: CalculateRefundRequest, options?: CalculateRefundPostOptionalParams): Promise<CalculateRefundPostResponse>;
194
+ }
195
+
196
+ // @public
197
+ export interface CalculateRefundPostOptionalParams extends coreClient.OperationOptions {
198
+ }
199
+
200
+ // @public
201
+ export type CalculateRefundPostResponse = CalculateRefundResponse;
202
+
203
+ // @public
204
+ export interface CalculateRefundRequest {
205
+ id?: string;
206
+ properties?: CalculateRefundRequestProperties;
207
+ }
208
+
209
+ // @public
210
+ export interface CalculateRefundRequestProperties {
211
+ reservationToReturn?: ReservationToReturn;
212
+ scope?: string;
213
+ }
214
+
215
+ // @public
216
+ export interface CalculateRefundResponse {
217
+ id?: string;
218
+ properties?: RefundResponseProperties;
219
+ }
220
+
221
+ // @public
222
+ export interface Catalog {
223
+ billingPlans?: {
224
+ [propertyName: string]: ReservationBillingPlan[];
225
+ };
226
+ readonly capabilities?: SkuCapability[];
227
+ readonly locations?: string[];
228
+ readonly msrp?: CatalogMsrp;
229
+ readonly name?: string;
230
+ readonly resourceType?: string;
231
+ readonly restrictions?: SkuRestriction[];
232
+ readonly size?: string;
233
+ readonly skuProperties?: SkuProperty[];
234
+ readonly terms?: ReservationTerm[];
235
+ readonly tier?: string;
236
+ }
237
+
238
+ // @public
239
+ export interface CatalogMsrp {
240
+ p1Y?: Price;
241
+ p3Y?: Price;
242
+ p5Y?: Price;
243
+ }
244
+
245
+ // @public
246
+ export interface CatalogsResult {
247
+ readonly nextLink?: string;
248
+ totalItems?: number;
249
+ readonly value?: Catalog[];
250
+ }
251
+
252
+ // @public
253
+ export interface ChangeDirectoryRequest {
254
+ destinationTenantId?: string;
255
+ }
256
+
257
+ // @public
258
+ export interface ChangeDirectoryResponse {
259
+ reservationOrder?: ChangeDirectoryResult;
260
+ // (undocumented)
261
+ reservations?: ChangeDirectoryResult[];
262
+ }
263
+
264
+ // @public
265
+ export interface ChangeDirectoryResult {
266
+ error?: string;
267
+ id?: string;
268
+ isSucceeded?: boolean;
269
+ name?: string;
270
+ }
271
+
272
+ // @public
273
+ export interface Commitment extends Price {
274
+ grain?: CommitmentGrain;
275
+ }
276
+
277
+ // @public
278
+ export type CommitmentGrain = string;
279
+
280
+ // @public
281
+ export type CreatedByType = string;
282
+
283
+ // @public
284
+ export interface CreateGenericQuotaRequestParameters {
285
+ value?: CurrentQuotaLimitBase[];
286
+ }
287
+
288
+ // @public
289
+ export interface CurrentQuotaLimit {
290
+ readonly id?: string;
291
+ readonly message?: string;
292
+ readonly name?: string;
293
+ properties?: QuotaProperties;
294
+ readonly provisioningState?: QuotaRequestState;
295
+ readonly type?: string;
296
+ }
297
+
298
+ // @public
299
+ export interface CurrentQuotaLimitBase {
300
+ readonly id?: string;
301
+ readonly name?: string;
302
+ properties?: QuotaProperties;
303
+ readonly type?: string;
304
+ }
305
+
306
+ // @public
307
+ export type DisplayProvisioningState = string;
308
+
309
+ // @public
310
+ export interface ErrorDetails {
311
+ readonly code?: string;
312
+ readonly message?: string;
313
+ readonly target?: string;
314
+ }
315
+
316
+ // @public
317
+ export interface ErrorModel {
318
+ error?: ExtendedErrorInfo;
319
+ }
320
+
321
+ // @public
322
+ export interface ErrorResponse {
323
+ error?: ErrorDetails;
324
+ }
325
+
326
+ // @public
327
+ export type ErrorResponseCode = string;
328
+
329
+ // @public
330
+ export interface ExceptionResponse {
331
+ error?: ServiceError;
332
+ }
333
+
334
+ // @public
335
+ export interface Exchange {
336
+ beginPost(body: ExchangeRequest, options?: ExchangePostOptionalParams): Promise<SimplePollerLike<OperationState<ExchangePostResponse>, ExchangePostResponse>>;
337
+ beginPostAndWait(body: ExchangeRequest, options?: ExchangePostOptionalParams): Promise<ExchangePostResponse>;
338
+ }
339
+
340
+ // @public
341
+ export interface ExchangeOperationResultResponse {
342
+ error?: OperationResultError;
343
+ id?: string;
344
+ name?: string;
345
+ properties?: ExchangeResponseProperties;
346
+ status?: ExchangeOperationResultStatus;
347
+ }
348
+
349
+ // @public
350
+ export type ExchangeOperationResultStatus = string;
351
+
352
+ // @public
353
+ export interface ExchangePolicyError {
354
+ // (undocumented)
355
+ code?: string;
356
+ // (undocumented)
357
+ message?: string;
358
+ }
359
+
360
+ // @public
361
+ export interface ExchangePolicyErrors {
362
+ policyErrors?: ExchangePolicyError[];
363
+ }
364
+
365
+ // @public
366
+ export interface ExchangePostHeaders {
367
+ azureAsyncOperation?: string;
368
+ location?: string;
369
+ retryAfter?: number;
370
+ }
371
+
372
+ // @public
373
+ export interface ExchangePostOptionalParams extends coreClient.OperationOptions {
374
+ resumeFrom?: string;
375
+ updateIntervalInMs?: number;
376
+ }
377
+
378
+ // @public
379
+ export type ExchangePostResponse = ExchangeOperationResultResponse;
380
+
381
+ // @public
382
+ export interface ExchangeRequest {
383
+ properties?: ExchangeRequestProperties;
384
+ }
385
+
386
+ // @public
387
+ export interface ExchangeRequestProperties {
388
+ sessionId?: string;
389
+ }
390
+
391
+ // @public
392
+ export interface ExchangeResponseProperties {
393
+ netPayable?: Price;
394
+ policyResult?: ExchangePolicyErrors;
395
+ purchasesTotal?: Price;
396
+ refundsTotal?: Price;
397
+ reservationsToExchange?: ReservationToReturnForExchange[];
398
+ reservationsToPurchase?: ReservationToPurchaseExchange[];
399
+ savingsPlansToPurchase?: SavingsPlanToPurchaseExchange[];
400
+ sessionId?: string;
401
+ }
402
+
403
+ // @public
404
+ export interface ExtendedErrorInfo {
405
+ code?: ErrorResponseCode;
406
+ // (undocumented)
407
+ message?: string;
408
+ }
409
+
410
+ // @public (undocumented)
411
+ export interface ExtendedStatusInfo {
412
+ message?: string;
413
+ // (undocumented)
414
+ statusCode?: ReservationStatusCode;
415
+ }
416
+
417
+ // @public
418
+ export interface GetAppliedReservationListOptionalParams extends coreClient.OperationOptions {
419
+ }
420
+
421
+ // @public
422
+ export type GetAppliedReservationListResponse = AppliedReservations;
423
+
424
+ // @public
425
+ export interface GetCatalogNextOptionalParams extends coreClient.OperationOptions {
426
+ }
427
+
428
+ // @public
429
+ export type GetCatalogNextResponse = CatalogsResult;
430
+
431
+ // @public
432
+ export interface GetCatalogOptionalParams extends coreClient.OperationOptions {
433
+ filter?: string;
434
+ location?: string;
435
+ offerId?: string;
436
+ planId?: string;
437
+ publisherId?: string;
438
+ reservedResourceType?: string;
439
+ skip?: number;
440
+ take?: number;
441
+ }
442
+
443
+ // @public
444
+ export type GetCatalogResponse = CatalogsResult;
445
+
446
+ // @public
447
+ export function getContinuationToken(page: unknown): string | undefined;
448
+
449
+ // @public
450
+ export type InstanceFlexibility = string;
451
+
452
+ // @public
453
+ export enum KnownAppliedScopeType {
454
+ ManagementGroup = "ManagementGroup",
455
+ Shared = "Shared",
456
+ Single = "Single"
457
+ }
458
+
459
+ // @public
460
+ export enum KnownBillingPlan {
461
+ P1M = "P1M"
462
+ }
463
+
464
+ // @public
465
+ export enum KnownCalculateExchangeOperationResultStatus {
466
+ Cancelled = "Cancelled",
467
+ Failed = "Failed",
468
+ Pending = "Pending",
469
+ Succeeded = "Succeeded"
470
+ }
471
+
472
+ // @public
473
+ export enum KnownCommitmentGrain {
474
+ Hourly = "Hourly"
475
+ }
476
+
477
+ // @public
478
+ export enum KnownCreatedByType {
479
+ Application = "Application",
480
+ Key = "Key",
481
+ ManagedIdentity = "ManagedIdentity",
482
+ User = "User"
483
+ }
484
+
485
+ // @public
486
+ export enum KnownDisplayProvisioningState {
487
+ Cancelled = "Cancelled",
488
+ Expired = "Expired",
489
+ Expiring = "Expiring",
490
+ Failed = "Failed",
491
+ NoBenefit = "NoBenefit",
492
+ Pending = "Pending",
493
+ Processing = "Processing",
494
+ Succeeded = "Succeeded",
495
+ Warning = "Warning"
496
+ }
497
+
498
+ // @public
499
+ export enum KnownErrorResponseCode {
500
+ ActivateQuoteFailed = "ActivateQuoteFailed",
501
+ AppliedScopesNotAssociatedWithCommerceAccount = "AppliedScopesNotAssociatedWithCommerceAccount",
502
+ AppliedScopesSameAsExisting = "AppliedScopesSameAsExisting",
503
+ AuthorizationFailed = "AuthorizationFailed",
504
+ BadRequest = "BadRequest",
505
+ BillingCustomerInputError = "BillingCustomerInputError",
506
+ BillingError = "BillingError",
507
+ BillingPaymentInstrumentHardError = "BillingPaymentInstrumentHardError",
508
+ BillingPaymentInstrumentSoftError = "BillingPaymentInstrumentSoftError",
509
+ BillingScopeIdCannotBeChanged = "BillingScopeIdCannotBeChanged",
510
+ BillingTransientError = "BillingTransientError",
511
+ CalculatePriceFailed = "CalculatePriceFailed",
512
+ CapacityUpdateScopesFailed = "CapacityUpdateScopesFailed",
513
+ ClientCertificateThumbprintNotSet = "ClientCertificateThumbprintNotSet",
514
+ CreateQuoteFailed = "CreateQuoteFailed",
515
+ Forbidden = "Forbidden",
516
+ FulfillmentConfigurationError = "FulfillmentConfigurationError",
517
+ FulfillmentError = "FulfillmentError",
518
+ FulfillmentOutOfStockError = "FulfillmentOutOfStockError",
519
+ FulfillmentTransientError = "FulfillmentTransientError",
520
+ HttpMethodNotSupported = "HttpMethodNotSupported",
521
+ InternalServerError = "InternalServerError",
522
+ InvalidAccessToken = "InvalidAccessToken",
523
+ InvalidFulfillmentRequestParameters = "InvalidFulfillmentRequestParameters",
524
+ InvalidHealthCheckType = "InvalidHealthCheckType",
525
+ InvalidLocationId = "InvalidLocationId",
526
+ InvalidRefundQuantity = "InvalidRefundQuantity",
527
+ InvalidRequestContent = "InvalidRequestContent",
528
+ InvalidRequestUri = "InvalidRequestUri",
529
+ InvalidReservationId = "InvalidReservationId",
530
+ InvalidReservationOrderId = "InvalidReservationOrderId",
531
+ InvalidSingleAppliedScopesCount = "InvalidSingleAppliedScopesCount",
532
+ InvalidSubscriptionId = "InvalidSubscriptionId",
533
+ InvalidTenantId = "InvalidTenantId",
534
+ MissingAppliedScopesForSingle = "MissingAppliedScopesForSingle",
535
+ MissingTenantId = "MissingTenantId",
536
+ NonsupportedAccountId = "NonsupportedAccountId",
537
+ NotSpecified = "NotSpecified",
538
+ NotSupportedCountry = "NotSupportedCountry",
539
+ NoValidReservationsToReRate = "NoValidReservationsToReRate",
540
+ OperationCannotBePerformedInCurrentState = "OperationCannotBePerformedInCurrentState",
541
+ OperationFailed = "OperationFailed",
542
+ PatchValuesSameAsExisting = "PatchValuesSameAsExisting",
543
+ PaymentInstrumentNotFound = "PaymentInstrumentNotFound",
544
+ PurchaseError = "PurchaseError",
545
+ RefundLimitExceeded = "RefundLimitExceeded",
546
+ ReRateOnlyAllowedForEA = "ReRateOnlyAllowedForEA",
547
+ ReservationIdNotInReservationOrder = "ReservationIdNotInReservationOrder",
548
+ ReservationOrderCreationFailed = "ReservationOrderCreationFailed",
549
+ ReservationOrderIdAlreadyExists = "ReservationOrderIdAlreadyExists",
550
+ ReservationOrderNotEnabled = "ReservationOrderNotEnabled",
551
+ ReservationOrderNotFound = "ReservationOrderNotFound",
552
+ RiskCheckFailed = "RiskCheckFailed",
553
+ RoleAssignmentCreationFailed = "RoleAssignmentCreationFailed",
554
+ SelfServiceRefundNotSupported = "SelfServiceRefundNotSupported",
555
+ ServerTimeout = "ServerTimeout",
556
+ UnauthenticatedRequestsThrottled = "UnauthenticatedRequestsThrottled",
557
+ UnsupportedReservationTerm = "UnsupportedReservationTerm"
558
+ }
559
+
560
+ // @public
561
+ export enum KnownExchangeOperationResultStatus {
562
+ Cancelled = "Cancelled",
563
+ Failed = "Failed",
564
+ PendingPurchases = "PendingPurchases",
565
+ PendingRefunds = "PendingRefunds",
566
+ Succeeded = "Succeeded"
567
+ }
568
+
569
+ // @public
570
+ export enum KnownInstanceFlexibility {
571
+ Off = "Off",
572
+ On = "On"
573
+ }
574
+
575
+ // @public
576
+ export enum KnownLocation {
577
+ Australiaeast = "australiaeast",
578
+ Australiasoutheast = "australiasoutheast",
579
+ Brazilsouth = "brazilsouth",
580
+ Canadacentral = "canadacentral",
581
+ Canadaeast = "canadaeast",
582
+ Centralindia = "centralindia",
583
+ Centralus = "centralus",
584
+ Eastasia = "eastasia",
585
+ Eastus = "eastus",
586
+ Eastus2 = "eastus2",
587
+ Japaneast = "japaneast",
588
+ Japanwest = "japanwest",
589
+ Northcentralus = "northcentralus",
590
+ Northeurope = "northeurope",
591
+ Southcentralus = "southcentralus",
592
+ Southeastasia = "southeastasia",
593
+ Southindia = "southindia",
594
+ Uksouth = "uksouth",
595
+ Ukwest = "ukwest",
596
+ Westcentralus = "westcentralus",
597
+ Westeurope = "westeurope",
598
+ Westindia = "westindia",
599
+ Westus = "westus",
600
+ Westus2 = "westus2"
601
+ }
602
+
603
+ // @public
604
+ export enum KnownOperationStatus {
605
+ Cancelled = "Cancelled",
606
+ Failed = "Failed",
607
+ Pending = "Pending",
608
+ Succeeded = "Succeeded"
609
+ }
610
+
611
+ // @public
612
+ export enum KnownPaymentStatus {
613
+ Cancelled = "Cancelled",
614
+ Failed = "Failed",
615
+ Scheduled = "Scheduled",
616
+ Succeeded = "Succeeded"
617
+ }
618
+
619
+ // @public
620
+ export enum KnownProvisioningState {
621
+ BillingFailed = "BillingFailed",
622
+ Cancelled = "Cancelled",
623
+ ConfirmedBilling = "ConfirmedBilling",
624
+ ConfirmedResourceHold = "ConfirmedResourceHold",
625
+ Created = "Created",
626
+ Creating = "Creating",
627
+ Expired = "Expired",
628
+ Failed = "Failed",
629
+ Merged = "Merged",
630
+ PendingBilling = "PendingBilling",
631
+ PendingResourceHold = "PendingResourceHold",
632
+ Split = "Split",
633
+ Succeeded = "Succeeded"
634
+ }
635
+
636
+ // @public
637
+ export enum KnownQuotaRequestState {
638
+ Accepted = "Accepted",
639
+ Failed = "Failed",
640
+ InProgress = "InProgress",
641
+ Invalid = "Invalid",
642
+ Succeeded = "Succeeded"
643
+ }
644
+
645
+ // @public
646
+ export enum KnownReservationBillingPlan {
647
+ Monthly = "Monthly",
648
+ Upfront = "Upfront"
649
+ }
650
+
651
+ // @public
652
+ export enum KnownReservationStatusCode {
653
+ Active = "Active",
654
+ Expired = "Expired",
655
+ Merged = "Merged",
656
+ None = "None",
657
+ PaymentInstrumentError = "PaymentInstrumentError",
658
+ Pending = "Pending",
659
+ Processing = "Processing",
660
+ PurchaseError = "PurchaseError",
661
+ Split = "Split",
662
+ Succeeded = "Succeeded"
663
+ }
664
+
665
+ // @public
666
+ export enum KnownReservationTerm {
667
+ P1Y = "P1Y",
668
+ P3Y = "P3Y",
669
+ P5Y = "P5Y"
670
+ }
671
+
672
+ // @public
673
+ export enum KnownReservedResourceType {
674
+ AppService = "AppService",
675
+ AVS = "AVS",
676
+ AzureDataExplorer = "AzureDataExplorer",
677
+ AzureFiles = "AzureFiles",
678
+ BlockBlob = "BlockBlob",
679
+ CosmosDb = "CosmosDb",
680
+ Databricks = "Databricks",
681
+ DataFactory = "DataFactory",
682
+ DedicatedHost = "DedicatedHost",
683
+ ManagedDisk = "ManagedDisk",
684
+ MariaDb = "MariaDb",
685
+ MySql = "MySql",
686
+ NetAppStorage = "NetAppStorage",
687
+ PostgreSql = "PostgreSql",
688
+ RedHat = "RedHat",
689
+ RedHatOsa = "RedHatOsa",
690
+ RedisCache = "RedisCache",
691
+ SapHana = "SapHana",
692
+ SqlAzureHybridBenefit = "SqlAzureHybridBenefit",
693
+ SqlDatabases = "SqlDatabases",
694
+ SqlDataWarehouse = "SqlDataWarehouse",
695
+ SqlEdge = "SqlEdge",
696
+ SuseLinux = "SuseLinux",
697
+ VirtualMachines = "VirtualMachines",
698
+ VirtualMachineSoftware = "VirtualMachineSoftware",
699
+ VMwareCloudSimple = "VMwareCloudSimple"
700
+ }
701
+
702
+ // @public
703
+ export enum KnownResourceType {
704
+ Dedicated = "dedicated",
705
+ LowPriority = "lowPriority",
706
+ ServiceSpecific = "serviceSpecific",
707
+ Shared = "shared",
708
+ Standard = "standard"
709
+ }
710
+
711
+ // @public
712
+ export enum KnownSavingsPlanTerm {
713
+ P1Y = "P1Y",
714
+ P3Y = "P3Y"
715
+ }
716
+
717
+ // @public
718
+ export enum KnownUserFriendlyAppliedScopeType {
719
+ ManagementGroup = "ManagementGroup",
720
+ None = "None",
721
+ ResourceGroup = "ResourceGroup",
722
+ Shared = "Shared",
723
+ Single = "Single"
724
+ }
725
+
726
+ // @public
727
+ export enum KnownUserFriendlyRenewState {
728
+ NotApplicable = "NotApplicable",
729
+ NotRenewed = "NotRenewed",
730
+ Off = "Off",
731
+ On = "On",
732
+ Renewed = "Renewed"
733
+ }
734
+
735
+ // @public
736
+ export type Location = string;
737
+
738
+ // @public
739
+ export interface MergeRequest {
740
+ sources?: string[];
741
+ }
742
+
743
+ // @public
744
+ export interface Operation {
745
+ list(options?: OperationListOptionalParams): PagedAsyncIterableIterator<OperationResponse>;
746
+ }
747
+
748
+ // @public
749
+ export interface OperationDisplay {
750
+ // (undocumented)
751
+ description?: string;
752
+ // (undocumented)
753
+ operation?: string;
754
+ // (undocumented)
755
+ provider?: string;
756
+ // (undocumented)
757
+ resource?: string;
758
+ }
759
+
760
+ // @public
761
+ export interface OperationList {
762
+ nextLink?: string;
763
+ // (undocumented)
764
+ value?: OperationResponse[];
765
+ }
766
+
767
+ // @public
768
+ export interface OperationListNextOptionalParams extends coreClient.OperationOptions {
769
+ }
770
+
771
+ // @public
772
+ export type OperationListNextResponse = OperationList;
773
+
774
+ // @public
775
+ export interface OperationListOptionalParams extends coreClient.OperationOptions {
776
+ }
777
+
778
+ // @public
779
+ export type OperationListResponse = OperationList;
780
+
781
+ // @public
782
+ export interface OperationResponse {
783
+ display?: OperationDisplay;
784
+ isDataAction?: boolean;
785
+ name?: string;
786
+ origin?: string;
787
+ properties?: Record<string, unknown>;
788
+ }
789
+
790
+ // @public
791
+ export interface OperationResultError {
792
+ code?: string;
793
+ message?: string;
794
+ }
795
+
796
+ // @public
797
+ export type OperationStatus = string;
798
+
799
+ // @public
800
+ export interface Patch {
801
+ appliedScopeProperties?: AppliedScopeProperties;
802
+ appliedScopes?: string[];
803
+ appliedScopeType?: AppliedScopeType;
804
+ instanceFlexibility?: InstanceFlexibility;
805
+ name?: string;
806
+ renew?: boolean;
807
+ // (undocumented)
808
+ renewProperties?: PatchPropertiesRenewProperties;
809
+ reviewDateTime?: Date;
810
+ }
811
+
812
+ // @public (undocumented)
813
+ export interface PatchPropertiesRenewProperties {
814
+ purchaseProperties?: PurchaseRequest;
815
+ }
816
+
817
+ // @public
818
+ export interface PaymentDetail {
819
+ billingAccount?: string;
820
+ billingCurrencyTotal?: Price;
821
+ dueDate?: Date;
822
+ // (undocumented)
823
+ extendedStatusInfo?: ExtendedStatusInfo;
824
+ paymentDate?: Date;
825
+ pricingCurrencyTotal?: Price;
826
+ status?: PaymentStatus;
827
+ }
828
+
829
+ // @public
830
+ export type PaymentStatus = string;
831
+
832
+ // @public
833
+ export interface Price {
834
+ // (undocumented)
835
+ amount?: number;
836
+ currencyCode?: string;
837
+ }
838
+
839
+ // @public
840
+ export type ProvisioningState = string;
841
+
842
+ // @public
843
+ export interface ProxyResource extends Resource {
844
+ }
845
+
846
+ // @public
847
+ export interface PurchaseRequest {
848
+ appliedScopeProperties?: AppliedScopeProperties;
849
+ appliedScopes?: string[];
850
+ appliedScopeType?: AppliedScopeType;
851
+ billingPlan?: ReservationBillingPlan;
852
+ billingScopeId?: string;
853
+ displayName?: string;
854
+ location?: string;
855
+ quantity?: number;
856
+ renew?: boolean;
857
+ reservedResourceProperties?: PurchaseRequestPropertiesReservedResourceProperties;
858
+ reservedResourceType?: ReservedResourceType;
859
+ reviewDateTime?: Date;
860
+ sku?: SkuName;
861
+ term?: ReservationTerm;
862
+ }
863
+
864
+ // @public
865
+ export interface PurchaseRequestPropertiesReservedResourceProperties {
866
+ instanceFlexibility?: InstanceFlexibility;
867
+ }
868
+
869
+ // @public
870
+ export interface Quota {
871
+ beginCreateOrUpdate(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<QuotaCreateOrUpdateResponse>, QuotaCreateOrUpdateResponse>>;
872
+ beginCreateOrUpdateAndWait(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaCreateOrUpdateOptionalParams): Promise<QuotaCreateOrUpdateResponse>;
873
+ beginUpdate(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaUpdateOptionalParams): Promise<SimplePollerLike<OperationState<QuotaUpdateResponse>, QuotaUpdateResponse>>;
874
+ beginUpdateAndWait(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaUpdateOptionalParams): Promise<QuotaUpdateResponse>;
875
+ get(subscriptionId: string, providerId: string, location: string, resourceName: string, options?: QuotaGetOptionalParams): Promise<QuotaGetResponse>;
876
+ list(subscriptionId: string, providerId: string, location: string, options?: QuotaListOptionalParams): PagedAsyncIterableIterator<CurrentQuotaLimitBase>;
877
+ }
878
+
879
+ // @public
880
+ export interface QuotaCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
881
+ resumeFrom?: string;
882
+ updateIntervalInMs?: number;
883
+ }
884
+
885
+ // @public
886
+ export type QuotaCreateOrUpdateResponse = CurrentQuotaLimitBase;
887
+
888
+ // @public
889
+ export interface QuotaGetHeaders {
890
+ eTag?: string;
891
+ }
892
+
893
+ // @public
894
+ export interface QuotaGetOptionalParams extends coreClient.OperationOptions {
895
+ }
896
+
897
+ // @public
898
+ export type QuotaGetResponse = QuotaGetHeaders & CurrentQuotaLimitBase;
899
+
900
+ // @public
901
+ export interface QuotaLimits {
902
+ nextLink?: string;
903
+ value?: CurrentQuotaLimitBase[];
904
+ }
905
+
906
+ // @public
907
+ export interface QuotaLimitsResponse {
908
+ nextLink?: string;
909
+ value?: CurrentQuotaLimit[];
910
+ }
911
+
912
+ // @public
913
+ export interface QuotaListHeaders {
914
+ eTag?: string;
915
+ }
916
+
917
+ // @public
918
+ export interface QuotaListNextHeaders {
919
+ eTag?: string;
920
+ }
921
+
922
+ // @public
923
+ export interface QuotaListNextOptionalParams extends coreClient.OperationOptions {
924
+ }
925
+
926
+ // @public
927
+ export type QuotaListNextResponse = QuotaListNextHeaders & QuotaLimits;
928
+
929
+ // @public
930
+ export interface QuotaListOptionalParams extends coreClient.OperationOptions {
931
+ }
932
+
933
+ // @public
934
+ export type QuotaListResponse = QuotaListHeaders & QuotaLimits;
935
+
936
+ // @public
937
+ export interface QuotaProperties {
938
+ readonly currentValue?: number;
939
+ limit?: number;
940
+ name?: ResourceName;
941
+ properties?: Record<string, unknown>;
942
+ readonly quotaPeriod?: string;
943
+ resourceType?: ResourceType;
944
+ unit?: string;
945
+ }
946
+
947
+ // @public
948
+ export interface QuotaRequestDetails {
949
+ readonly id?: string;
950
+ readonly message?: string;
951
+ readonly name?: string;
952
+ provisioningState?: QuotaRequestState;
953
+ readonly requestSubmitTime?: Date;
954
+ readonly type?: string;
955
+ value?: SubRequest[];
956
+ }
957
+
958
+ // @public
959
+ export interface QuotaRequestDetailsList {
960
+ nextLink?: string;
961
+ value?: QuotaRequestDetails[];
962
+ }
963
+
964
+ // @public
965
+ export interface QuotaRequestOneResourceSubmitResponse {
966
+ readonly id?: string;
967
+ readonly idPropertiesId?: string;
968
+ readonly message?: string;
969
+ readonly name?: string;
970
+ readonly namePropertiesName?: string;
971
+ properties?: QuotaProperties;
972
+ readonly provisioningState?: QuotaRequestState;
973
+ readonly requestSubmitTime?: Date;
974
+ readonly type?: string;
975
+ readonly typePropertiesType?: string;
976
+ }
977
+
978
+ // @public
979
+ export interface QuotaRequestProperties {
980
+ readonly message?: string;
981
+ provisioningState?: QuotaRequestState;
982
+ readonly requestSubmitTime?: Date;
983
+ value?: SubRequest[];
984
+ }
985
+
986
+ // @public
987
+ export type QuotaRequestState = string;
988
+
989
+ // @public
990
+ export interface QuotaRequestStatus {
991
+ get(subscriptionId: string, providerId: string, location: string, id: string, options?: QuotaRequestStatusGetOptionalParams): Promise<QuotaRequestStatusGetResponse>;
992
+ list(subscriptionId: string, providerId: string, location: string, options?: QuotaRequestStatusListOptionalParams): PagedAsyncIterableIterator<QuotaRequestDetails>;
993
+ }
994
+
995
+ // @public
996
+ export interface QuotaRequestStatusGetOptionalParams extends coreClient.OperationOptions {
997
+ }
998
+
999
+ // @public
1000
+ export type QuotaRequestStatusGetResponse = QuotaRequestDetails;
1001
+
1002
+ // @public
1003
+ export interface QuotaRequestStatusListNextOptionalParams extends coreClient.OperationOptions {
1004
+ }
1005
+
1006
+ // @public
1007
+ export type QuotaRequestStatusListNextResponse = QuotaRequestDetailsList;
1008
+
1009
+ // @public
1010
+ export interface QuotaRequestStatusListOptionalParams extends coreClient.OperationOptions {
1011
+ filter?: string;
1012
+ skiptoken?: string;
1013
+ top?: number;
1014
+ }
1015
+
1016
+ // @public
1017
+ export type QuotaRequestStatusListResponse = QuotaRequestDetailsList;
1018
+
1019
+ // @public
1020
+ export interface QuotaRequestSubmitResponse {
1021
+ readonly id?: string;
1022
+ readonly name?: string;
1023
+ properties?: QuotaRequestProperties;
1024
+ readonly type?: string;
1025
+ }
1026
+
1027
+ // @public
1028
+ export interface QuotaRequestSubmitResponse201 {
1029
+ readonly id?: string;
1030
+ readonly message?: string;
1031
+ readonly name?: string;
1032
+ readonly provisioningState?: QuotaRequestState;
1033
+ readonly type?: string;
1034
+ }
1035
+
1036
+ // @public
1037
+ export interface QuotaUpdateOptionalParams extends coreClient.OperationOptions {
1038
+ resumeFrom?: string;
1039
+ updateIntervalInMs?: number;
1040
+ }
1041
+
1042
+ // @public
1043
+ export type QuotaUpdateResponse = CurrentQuotaLimitBase;
1044
+
1045
+ // @public
1046
+ export interface RefundBillingInformation {
1047
+ billingCurrencyProratedAmount?: Price;
1048
+ billingCurrencyRemainingCommitmentAmount?: Price;
1049
+ billingCurrencyTotalPaidAmount?: Price;
1050
+ billingPlan?: ReservationBillingPlan;
1051
+ completedTransactions?: number;
1052
+ totalTransactions?: number;
1053
+ }
1054
+
1055
+ // @public
1056
+ export interface RefundPolicyError {
1057
+ code?: ErrorResponseCode;
1058
+ // (undocumented)
1059
+ message?: string;
1060
+ }
1061
+
1062
+ // @public
1063
+ export interface RefundPolicyResult {
1064
+ properties?: RefundPolicyResultProperty;
1065
+ }
1066
+
1067
+ // @public
1068
+ export interface RefundPolicyResultProperty {
1069
+ consumedRefundsTotal?: Price;
1070
+ maxRefundLimit?: Price;
1071
+ policyErrors?: RefundPolicyError[];
1072
+ }
1073
+
1074
+ // @public
1075
+ export interface RefundRequest {
1076
+ properties?: RefundRequestProperties;
1077
+ }
1078
+
1079
+ // @public
1080
+ export interface RefundRequestProperties {
1081
+ reservationToReturn?: ReservationToReturn;
1082
+ returnReason?: string;
1083
+ scope?: string;
1084
+ sessionId?: string;
1085
+ }
1086
+
1087
+ // @public
1088
+ export interface RefundResponse {
1089
+ id?: string;
1090
+ properties?: RefundResponseProperties;
1091
+ }
1092
+
1093
+ // @public
1094
+ export interface RefundResponseProperties {
1095
+ billingInformation?: RefundBillingInformation;
1096
+ billingRefundAmount?: Price;
1097
+ policyResult?: RefundPolicyResult;
1098
+ pricingRefundAmount?: Price;
1099
+ quantity?: number;
1100
+ sessionId?: string;
1101
+ }
1102
+
1103
+ // @public
1104
+ export interface RenewPropertiesResponse {
1105
+ billingCurrencyTotal?: RenewPropertiesResponseBillingCurrencyTotal;
1106
+ pricingCurrencyTotal?: RenewPropertiesResponsePricingCurrencyTotal;
1107
+ purchaseProperties?: PurchaseRequest;
1108
+ }
1109
+
1110
+ // @public
1111
+ export interface RenewPropertiesResponseBillingCurrencyTotal {
1112
+ // (undocumented)
1113
+ amount?: number;
1114
+ currencyCode?: string;
1115
+ }
1116
+
1117
+ // @public
1118
+ export interface RenewPropertiesResponsePricingCurrencyTotal {
1119
+ // (undocumented)
1120
+ amount?: number;
1121
+ currencyCode?: string;
1122
+ }
1123
+
1124
+ // @public
1125
+ export interface Reservation {
1126
+ archive(reservationOrderId: string, reservationId: string, options?: ReservationArchiveOptionalParams): Promise<void>;
1127
+ beginAvailableScopes(reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams): Promise<SimplePollerLike<OperationState<ReservationAvailableScopesResponse>, ReservationAvailableScopesResponse>>;
1128
+ beginAvailableScopesAndWait(reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams): Promise<ReservationAvailableScopesResponse>;
1129
+ beginMerge(reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams): Promise<SimplePollerLike<OperationState<ReservationMergeResponse>, ReservationMergeResponse>>;
1130
+ beginMergeAndWait(reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams): Promise<ReservationMergeResponse>;
1131
+ beginSplit(reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams): Promise<SimplePollerLike<OperationState<ReservationSplitResponse>, ReservationSplitResponse>>;
1132
+ beginSplitAndWait(reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams): Promise<ReservationSplitResponse>;
1133
+ beginUpdate(reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ReservationUpdateResponse>, ReservationUpdateResponse>>;
1134
+ beginUpdateAndWait(reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams): Promise<ReservationUpdateResponse>;
1135
+ get(reservationOrderId: string, reservationId: string, options?: ReservationGetOptionalParams): Promise<ReservationGetResponse>;
1136
+ list(reservationOrderId: string, options?: ReservationListOptionalParams): PagedAsyncIterableIterator<ReservationResponse>;
1137
+ listAll(options?: ReservationListAllOptionalParams): PagedAsyncIterableIterator<ReservationResponse>;
1138
+ listRevisions(reservationOrderId: string, reservationId: string, options?: ReservationListRevisionsOptionalParams): PagedAsyncIterableIterator<ReservationResponse>;
1139
+ unarchive(reservationOrderId: string, reservationId: string, options?: ReservationUnarchiveOptionalParams): Promise<void>;
1140
+ }
1141
+
1142
+ // @public
1143
+ export interface ReservationArchiveOptionalParams extends coreClient.OperationOptions {
1144
+ }
1145
+
1146
+ // @public
1147
+ export interface ReservationAvailableScopesOptionalParams extends coreClient.OperationOptions {
1148
+ resumeFrom?: string;
1149
+ updateIntervalInMs?: number;
1150
+ }
1151
+
1152
+ // @public
1153
+ export type ReservationAvailableScopesResponse = AvailableScopeProperties;
1154
+
1155
+ // @public
1156
+ export type ReservationBillingPlan = string;
1157
+
1158
+ // @public
1159
+ export interface ReservationGetOptionalParams extends coreClient.OperationOptions {
1160
+ expand?: string;
1161
+ }
1162
+
1163
+ // @public
1164
+ export type ReservationGetResponse = ReservationResponse;
1165
+
1166
+ // @public
1167
+ export interface ReservationList {
1168
+ nextLink?: string;
1169
+ // (undocumented)
1170
+ value?: ReservationResponse[];
1171
+ }
1172
+
1173
+ // @public
1174
+ export interface ReservationListAllNextOptionalParams extends coreClient.OperationOptions {
1175
+ }
1176
+
1177
+ // @public
1178
+ export type ReservationListAllNextResponse = ReservationsListResult;
1179
+
1180
+ // @public
1181
+ export interface ReservationListAllOptionalParams extends coreClient.OperationOptions {
1182
+ filter?: string;
1183
+ orderby?: string;
1184
+ refreshSummary?: string;
1185
+ selectedState?: string;
1186
+ skiptoken?: number;
1187
+ take?: number;
1188
+ }
1189
+
1190
+ // @public
1191
+ export type ReservationListAllResponse = ReservationsListResult;
1192
+
1193
+ // @public
1194
+ export interface ReservationListNextOptionalParams extends coreClient.OperationOptions {
1195
+ }
1196
+
1197
+ // @public
1198
+ export type ReservationListNextResponse = ReservationList;
1199
+
1200
+ // @public
1201
+ export interface ReservationListOptionalParams extends coreClient.OperationOptions {
1202
+ }
1203
+
1204
+ // @public
1205
+ export type ReservationListResponse = ReservationList;
1206
+
1207
+ // @public
1208
+ export interface ReservationListRevisionsNextOptionalParams extends coreClient.OperationOptions {
1209
+ }
1210
+
1211
+ // @public
1212
+ export type ReservationListRevisionsNextResponse = ReservationList;
1213
+
1214
+ // @public
1215
+ export interface ReservationListRevisionsOptionalParams extends coreClient.OperationOptions {
1216
+ }
1217
+
1218
+ // @public
1219
+ export type ReservationListRevisionsResponse = ReservationList;
1220
+
1221
+ // @public
1222
+ export interface ReservationMergeHeaders {
1223
+ location?: string;
1224
+ retryAfter?: number;
1225
+ }
1226
+
1227
+ // @public
1228
+ export interface ReservationMergeOptionalParams extends coreClient.OperationOptions {
1229
+ resumeFrom?: string;
1230
+ updateIntervalInMs?: number;
1231
+ }
1232
+
1233
+ // @public
1234
+ export interface ReservationMergeProperties {
1235
+ mergeDestination?: string;
1236
+ mergeSources?: string[];
1237
+ }
1238
+
1239
+ // @public
1240
+ export type ReservationMergeResponse = ReservationResponse[];
1241
+
1242
+ // @public
1243
+ export interface ReservationOrder {
1244
+ beginPurchase(reservationOrderId: string, body: PurchaseRequest, options?: ReservationOrderPurchaseOptionalParams): Promise<SimplePollerLike<OperationState<ReservationOrderPurchaseResponse>, ReservationOrderPurchaseResponse>>;
1245
+ beginPurchaseAndWait(reservationOrderId: string, body: PurchaseRequest, options?: ReservationOrderPurchaseOptionalParams): Promise<ReservationOrderPurchaseResponse>;
1246
+ calculate(body: PurchaseRequest, options?: ReservationOrderCalculateOptionalParams): Promise<ReservationOrderCalculateResponse>;
1247
+ changeDirectory(reservationOrderId: string, body: ChangeDirectoryRequest, options?: ReservationOrderChangeDirectoryOptionalParams): Promise<ReservationOrderChangeDirectoryResponse>;
1248
+ get(reservationOrderId: string, options?: ReservationOrderGetOptionalParams): Promise<ReservationOrderGetResponse>;
1249
+ list(options?: ReservationOrderListOptionalParams): PagedAsyncIterableIterator<ReservationOrderResponse>;
1250
+ }
1251
+
1252
+ // @public
1253
+ export interface ReservationOrderBillingPlanInformation {
1254
+ nextPaymentDueDate?: Date;
1255
+ pricingCurrencyTotal?: Price;
1256
+ startDate?: Date;
1257
+ // (undocumented)
1258
+ transactions?: PaymentDetail[];
1259
+ }
1260
+
1261
+ // @public
1262
+ export interface ReservationOrderCalculateOptionalParams extends coreClient.OperationOptions {
1263
+ }
1264
+
1265
+ // @public
1266
+ export type ReservationOrderCalculateResponse = CalculatePriceResponse;
1267
+
1268
+ // @public
1269
+ export interface ReservationOrderChangeDirectoryOptionalParams extends coreClient.OperationOptions {
1270
+ }
1271
+
1272
+ // @public
1273
+ export type ReservationOrderChangeDirectoryResponse = ChangeDirectoryResponse;
1274
+
1275
+ // @public
1276
+ export interface ReservationOrderGetOptionalParams extends coreClient.OperationOptions {
1277
+ expand?: string;
1278
+ }
1279
+
1280
+ // @public
1281
+ export type ReservationOrderGetResponse = ReservationOrderResponse;
1282
+
1283
+ // @public
1284
+ export interface ReservationOrderList {
1285
+ nextLink?: string;
1286
+ // (undocumented)
1287
+ value?: ReservationOrderResponse[];
1288
+ }
1289
+
1290
+ // @public
1291
+ export interface ReservationOrderListNextOptionalParams extends coreClient.OperationOptions {
1292
+ }
1293
+
1294
+ // @public
1295
+ export type ReservationOrderListNextResponse = ReservationOrderList;
1296
+
1297
+ // @public
1298
+ export interface ReservationOrderListOptionalParams extends coreClient.OperationOptions {
1299
+ }
1300
+
1301
+ // @public
1302
+ export type ReservationOrderListResponse = ReservationOrderList;
1303
+
1304
+ // @public
1305
+ export interface ReservationOrderPurchaseHeaders {
1306
+ location?: string;
1307
+ retryAfter?: number;
1308
+ }
1309
+
1310
+ // @public
1311
+ export interface ReservationOrderPurchaseOptionalParams extends coreClient.OperationOptions {
1312
+ resumeFrom?: string;
1313
+ updateIntervalInMs?: number;
1314
+ }
1315
+
1316
+ // @public
1317
+ export type ReservationOrderPurchaseResponse = ReservationOrderResponse;
1318
+
1319
+ // @public
1320
+ export interface ReservationOrderResponse {
1321
+ benefitStartTime?: Date;
1322
+ billingPlan?: ReservationBillingPlan;
1323
+ createdDateTime?: Date;
1324
+ displayName?: string;
1325
+ // (undocumented)
1326
+ etag?: number;
1327
+ expiryDate?: Date;
1328
+ expiryDateTime?: Date;
1329
+ readonly id?: string;
1330
+ readonly name?: string;
1331
+ originalQuantity?: number;
1332
+ planInformation?: ReservationOrderBillingPlanInformation;
1333
+ provisioningState?: ProvisioningState;
1334
+ requestDateTime?: Date;
1335
+ // (undocumented)
1336
+ reservations?: ReservationResponse[];
1337
+ reviewDateTime?: Date;
1338
+ readonly systemData?: SystemData;
1339
+ term?: ReservationTerm;
1340
+ readonly type?: string;
1341
+ }
1342
+
1343
+ // @public
1344
+ export interface ReservationResponse extends ProxyResource {
1345
+ // (undocumented)
1346
+ etag?: number;
1347
+ kind?: "Microsoft.Compute";
1348
+ location?: string;
1349
+ properties?: ReservationsProperties;
1350
+ sku?: SkuName;
1351
+ }
1352
+
1353
+ // @public
1354
+ export interface ReservationsListResult {
1355
+ readonly nextLink?: string;
1356
+ summary?: ReservationSummary;
1357
+ readonly value?: ReservationResponse[];
1358
+ }
1359
+
1360
+ // @public
1361
+ export interface ReservationSplitHeaders {
1362
+ location?: string;
1363
+ retryAfter?: number;
1364
+ }
1365
+
1366
+ // @public
1367
+ export interface ReservationSplitOptionalParams extends coreClient.OperationOptions {
1368
+ resumeFrom?: string;
1369
+ updateIntervalInMs?: number;
1370
+ }
1371
+
1372
+ // @public
1373
+ export interface ReservationSplitProperties {
1374
+ splitDestinations?: string[];
1375
+ splitSource?: string;
1376
+ }
1377
+
1378
+ // @public
1379
+ export type ReservationSplitResponse = ReservationResponse[];
1380
+
1381
+ // @public
1382
+ export interface ReservationsProperties {
1383
+ appliedScopeProperties?: AppliedScopeProperties;
1384
+ appliedScopes?: string[];
1385
+ appliedScopeType?: AppliedScopeType;
1386
+ archived?: boolean;
1387
+ benefitStartTime?: Date;
1388
+ billingPlan?: ReservationBillingPlan;
1389
+ billingScopeId?: string;
1390
+ capabilities?: string;
1391
+ displayName?: string;
1392
+ readonly displayProvisioningState?: string;
1393
+ effectiveDateTime?: Date;
1394
+ expiryDate?: Date;
1395
+ expiryDateTime?: Date;
1396
+ extendedStatusInfo?: ExtendedStatusInfo;
1397
+ instanceFlexibility?: InstanceFlexibility;
1398
+ readonly lastUpdatedDateTime?: Date;
1399
+ mergeProperties?: ReservationMergeProperties;
1400
+ provisioningState?: ProvisioningState;
1401
+ readonly provisioningSubState?: string;
1402
+ purchaseDate?: Date;
1403
+ purchaseDateTime?: Date;
1404
+ quantity?: number;
1405
+ renew?: boolean;
1406
+ renewDestination?: string;
1407
+ renewProperties?: RenewPropertiesResponse;
1408
+ renewSource?: string;
1409
+ reservedResourceType?: ReservedResourceType;
1410
+ reviewDateTime?: Date;
1411
+ skuDescription?: string;
1412
+ splitProperties?: ReservationSplitProperties;
1413
+ swapProperties?: ReservationSwapProperties;
1414
+ term?: ReservationTerm;
1415
+ readonly userFriendlyAppliedScopeType?: string;
1416
+ readonly userFriendlyRenewState?: string;
1417
+ readonly utilization?: ReservationsPropertiesUtilization;
1418
+ }
1419
+
1420
+ // @public
1421
+ export interface ReservationsPropertiesUtilization {
1422
+ aggregates?: ReservationUtilizationAggregates[];
1423
+ readonly trend?: string;
1424
+ }
1425
+
1426
+ // @public
1427
+ export type ReservationStatusCode = string;
1428
+
1429
+ // @public
1430
+ export interface ReservationSummary {
1431
+ readonly cancelledCount?: number;
1432
+ readonly expiredCount?: number;
1433
+ readonly expiringCount?: number;
1434
+ readonly failedCount?: number;
1435
+ readonly noBenefitCount?: number;
1436
+ readonly pendingCount?: number;
1437
+ readonly processingCount?: number;
1438
+ readonly succeededCount?: number;
1439
+ readonly warningCount?: number;
1440
+ }
1441
+
1442
+ // @public
1443
+ export interface ReservationSwapProperties {
1444
+ swapDestination?: string;
1445
+ swapSource?: string;
1446
+ }
1447
+
1448
+ // @public
1449
+ export type ReservationTerm = string;
1450
+
1451
+ // @public
1452
+ export interface ReservationToExchange {
1453
+ billingInformation?: BillingInformation;
1454
+ billingRefundAmount?: Price;
1455
+ quantity?: number;
1456
+ reservationId?: string;
1457
+ }
1458
+
1459
+ // @public
1460
+ export interface ReservationToPurchaseCalculateExchange {
1461
+ billingCurrencyTotal?: Price;
1462
+ properties?: PurchaseRequest;
1463
+ }
1464
+
1465
+ // @public
1466
+ export interface ReservationToPurchaseExchange {
1467
+ billingCurrencyTotal?: Price;
1468
+ properties?: PurchaseRequest;
1469
+ reservationId?: string;
1470
+ reservationOrderId?: string;
1471
+ status?: OperationStatus;
1472
+ }
1473
+
1474
+ // @public
1475
+ export interface ReservationToReturn {
1476
+ quantity?: number;
1477
+ reservationId?: string;
1478
+ }
1479
+
1480
+ // @public
1481
+ export interface ReservationToReturnForExchange {
1482
+ billingInformation?: BillingInformation;
1483
+ billingRefundAmount?: Price;
1484
+ quantity?: number;
1485
+ reservationId?: string;
1486
+ status?: OperationStatus;
1487
+ }
1488
+
1489
+ // @public
1490
+ export interface ReservationUnarchiveOptionalParams extends coreClient.OperationOptions {
1491
+ }
1492
+
1493
+ // @public
1494
+ export interface ReservationUpdateHeaders {
1495
+ azureAsyncOperation?: string;
1496
+ location?: string;
1497
+ retryAfter?: number;
1498
+ }
1499
+
1500
+ // @public
1501
+ export interface ReservationUpdateOptionalParams extends coreClient.OperationOptions {
1502
+ resumeFrom?: string;
1503
+ updateIntervalInMs?: number;
1504
+ }
1505
+
1506
+ // @public
1507
+ export type ReservationUpdateResponse = ReservationResponse;
1508
+
1509
+ // @public
1510
+ export interface ReservationUtilizationAggregates {
1511
+ readonly grain?: number;
1512
+ readonly grainUnit?: string;
1513
+ readonly value?: number;
1514
+ readonly valueUnit?: string;
1515
+ }
1516
+
1517
+ // @public
1518
+ export type ReservedResourceType = string;
1519
+
1520
+ // @public
1521
+ export interface Resource {
1522
+ readonly id?: string;
1523
+ readonly name?: string;
1524
+ readonly systemData?: SystemData;
1525
+ readonly type?: string;
1526
+ }
1527
+
1528
+ // @public
1529
+ export interface ResourceName {
1530
+ readonly localizedValue?: string;
1531
+ value?: string;
1532
+ }
1533
+
1534
+ // @public
1535
+ export type ResourceType = string;
1536
+
1537
+ // @public
1538
+ export interface Return {
1539
+ beginPost(reservationOrderId: string, body: RefundRequest, options?: ReturnPostOptionalParams): Promise<SimplePollerLike<OperationState<ReturnPostResponse>, ReturnPostResponse>>;
1540
+ beginPostAndWait(reservationOrderId: string, body: RefundRequest, options?: ReturnPostOptionalParams): Promise<ReturnPostResponse>;
1541
+ }
1542
+
1543
+ // @public
1544
+ export interface ReturnPostHeaders {
1545
+ // (undocumented)
1546
+ location?: string;
1547
+ }
1548
+
1549
+ // @public
1550
+ export interface ReturnPostOptionalParams extends coreClient.OperationOptions {
1551
+ resumeFrom?: string;
1552
+ updateIntervalInMs?: number;
1553
+ }
1554
+
1555
+ // @public
1556
+ export type ReturnPostResponse = ReservationOrderResponse;
1557
+
1558
+ // @public
1559
+ export interface SavingsPlanPurchaseRequest {
1560
+ appliedScopeProperties?: AppliedScopeProperties;
1561
+ appliedScopeType?: AppliedScopeType;
1562
+ billingPlan?: BillingPlan;
1563
+ billingScopeId?: string;
1564
+ commitment?: Commitment;
1565
+ displayName?: string;
1566
+ sku?: SkuName;
1567
+ term?: SavingsPlanTerm;
1568
+ }
1569
+
1570
+ // @public
1571
+ export type SavingsPlanTerm = string;
1572
+
1573
+ // @public
1574
+ export interface SavingsPlanToPurchaseCalculateExchange {
1575
+ billingCurrencyTotal?: Price;
1576
+ properties?: SavingsPlanPurchaseRequest;
1577
+ }
1578
+
1579
+ // @public
1580
+ export interface SavingsPlanToPurchaseExchange {
1581
+ billingCurrencyTotal?: Price;
1582
+ properties?: SavingsPlanPurchaseRequest;
1583
+ savingsPlanId?: string;
1584
+ savingsPlanOrderId?: string;
1585
+ status?: OperationStatus;
1586
+ }
1587
+
1588
+ // @public
1589
+ export interface ScopeProperties {
1590
+ // (undocumented)
1591
+ scope?: string;
1592
+ // (undocumented)
1593
+ valid?: boolean;
1594
+ }
1595
+
1596
+ // @public
1597
+ export interface ServiceError {
1598
+ code?: string;
1599
+ readonly details?: ServiceErrorDetail[];
1600
+ message?: string;
1601
+ }
1602
+
1603
+ // @public
1604
+ export interface ServiceErrorDetail {
1605
+ readonly code?: string;
1606
+ readonly message?: string;
1607
+ }
1608
+
1609
+ // @public
1610
+ export interface SkuCapability {
1611
+ name?: string;
1612
+ value?: string;
1613
+ }
1614
+
1615
+ // @public
1616
+ export interface SkuName {
1617
+ // (undocumented)
1618
+ name?: string;
1619
+ }
1620
+
1621
+ // @public
1622
+ export interface SkuProperty {
1623
+ name?: string;
1624
+ value?: string;
1625
+ }
1626
+
1627
+ // @public
1628
+ export interface SkuRestriction {
1629
+ reasonCode?: string;
1630
+ type?: string;
1631
+ values?: string[];
1632
+ }
1633
+
1634
+ // @public
1635
+ export interface SplitRequest {
1636
+ quantities?: number[];
1637
+ reservationId?: string;
1638
+ }
1639
+
1640
+ // @public
1641
+ export interface SubRequest {
1642
+ readonly limit?: number;
1643
+ readonly message?: string;
1644
+ name?: ResourceName;
1645
+ provisioningState?: QuotaRequestState;
1646
+ readonly resourceType?: string;
1647
+ readonly subRequestId?: string;
1648
+ unit?: string;
1649
+ }
1650
+
1651
+ // @public
1652
+ export interface SubscriptionScopeProperties {
1653
+ // (undocumented)
1654
+ scopes?: ScopeProperties[];
1655
+ }
1656
+
1657
+ // @public
1658
+ export interface SystemData {
1659
+ createdAt?: Date;
1660
+ createdBy?: string;
1661
+ createdByType?: CreatedByType;
1662
+ lastModifiedAt?: Date;
1663
+ lastModifiedBy?: string;
1664
+ lastModifiedByType?: CreatedByType;
1665
+ }
1666
+
1667
+ // @public
1668
+ export type UserFriendlyAppliedScopeType = string;
1669
+
1670
+ // @public
1671
+ export type UserFriendlyRenewState = string;
1672
+
1673
+ // (No @packageDocumentation comment for this package)
1674
+
1675
+ ```