@azure/arm-consumption 9.2.1-alpha.20250618.1 → 9.2.1-alpha.20250717.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.
@@ -1,1559 +1,1559 @@
1
- ## API Report File for "@azure/arm-consumption"
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 { PagedAsyncIterableIterator } from '@azure/core-paging';
10
-
11
- // @public
12
- export interface AggregatedCost {
13
- getByManagementGroup(managementGroupId: string, options?: AggregatedCostGetByManagementGroupOptionalParams): Promise<AggregatedCostGetByManagementGroupResponse>;
14
- getForBillingPeriodByManagementGroup(managementGroupId: string, billingPeriodName: string, options?: AggregatedCostGetForBillingPeriodByManagementGroupOptionalParams): Promise<AggregatedCostGetForBillingPeriodByManagementGroupResponse>;
15
- }
16
-
17
- // @public
18
- export interface AggregatedCostGetByManagementGroupOptionalParams extends coreClient.OperationOptions {
19
- filter?: string;
20
- }
21
-
22
- // @public
23
- export type AggregatedCostGetByManagementGroupResponse = ManagementGroupAggregatedCostResult;
24
-
25
- // @public
26
- export interface AggregatedCostGetForBillingPeriodByManagementGroupOptionalParams extends coreClient.OperationOptions {
27
- }
28
-
29
- // @public
30
- export type AggregatedCostGetForBillingPeriodByManagementGroupResponse = ManagementGroupAggregatedCostResult;
31
-
32
- // @public
33
- export interface Amount {
34
- readonly currency?: string;
35
- readonly value?: number;
36
- }
37
-
38
- // @public
39
- export interface AmountWithExchangeRate extends Amount {
40
- readonly exchangeRate?: number;
41
- readonly exchangeRateMonth?: number;
42
- }
43
-
44
- // @public
45
- export interface Balance extends Resource {
46
- readonly adjustmentDetails?: BalancePropertiesAdjustmentDetailsItem[];
47
- readonly adjustments?: number;
48
- readonly azureMarketplaceServiceCharges?: number;
49
- readonly beginningBalance?: number;
50
- billingFrequency?: BillingFrequency;
51
- readonly chargesBilledSeparately?: number;
52
- readonly currency?: string;
53
- readonly endingBalance?: number;
54
- readonly newPurchases?: number;
55
- readonly newPurchasesDetails?: BalancePropertiesNewPurchasesDetailsItem[];
56
- readonly priceHidden?: boolean;
57
- readonly serviceOverage?: number;
58
- readonly totalOverage?: number;
59
- readonly totalUsage?: number;
60
- readonly utilized?: number;
61
- }
62
-
63
- // @public (undocumented)
64
- export interface BalancePropertiesAdjustmentDetailsItem {
65
- readonly name?: string;
66
- readonly value?: number;
67
- }
68
-
69
- // @public (undocumented)
70
- export interface BalancePropertiesNewPurchasesDetailsItem {
71
- readonly name?: string;
72
- readonly value?: number;
73
- }
74
-
75
- // @public
76
- export interface Balances {
77
- getByBillingAccount(billingAccountId: string, options?: BalancesGetByBillingAccountOptionalParams): Promise<BalancesGetByBillingAccountResponse>;
78
- getForBillingPeriodByBillingAccount(billingAccountId: string, billingPeriodName: string, options?: BalancesGetForBillingPeriodByBillingAccountOptionalParams): Promise<BalancesGetForBillingPeriodByBillingAccountResponse>;
79
- }
80
-
81
- // @public
82
- export interface BalancesGetByBillingAccountOptionalParams extends coreClient.OperationOptions {
83
- }
84
-
85
- // @public
86
- export type BalancesGetByBillingAccountResponse = Balance;
87
-
88
- // @public
89
- export interface BalancesGetForBillingPeriodByBillingAccountOptionalParams extends coreClient.OperationOptions {
90
- }
91
-
92
- // @public
93
- export type BalancesGetForBillingPeriodByBillingAccountResponse = Balance;
94
-
95
- // @public
96
- export type BillingFrequency = string;
97
-
98
- // @public
99
- export interface Budget extends ProxyResource {
100
- amount?: number;
101
- category?: CategoryType;
102
- readonly currentSpend?: CurrentSpend;
103
- filter?: BudgetFilter;
104
- readonly forecastSpend?: ForecastSpend;
105
- notifications?: {
106
- [propertyName: string]: Notification;
107
- };
108
- timeGrain?: TimeGrainType;
109
- timePeriod?: BudgetTimePeriod;
110
- }
111
-
112
- // @public
113
- export interface BudgetComparisonExpression {
114
- name: string;
115
- operator: BudgetOperatorType;
116
- values: string[];
117
- }
118
-
119
- // @public
120
- export interface BudgetFilter {
121
- and?: BudgetFilterProperties[];
122
- dimensions?: BudgetComparisonExpression;
123
- not?: BudgetFilterProperties;
124
- tags?: BudgetComparisonExpression;
125
- }
126
-
127
- // @public
128
- export interface BudgetFilterProperties {
129
- dimensions?: BudgetComparisonExpression;
130
- tags?: BudgetComparisonExpression;
131
- }
132
-
133
- // @public
134
- export type BudgetOperatorType = string;
135
-
136
- // @public
137
- export interface Budgets {
138
- createOrUpdate(scope: string, budgetName: string, parameters: Budget, options?: BudgetsCreateOrUpdateOptionalParams): Promise<BudgetsCreateOrUpdateResponse>;
139
- delete(scope: string, budgetName: string, options?: BudgetsDeleteOptionalParams): Promise<void>;
140
- get(scope: string, budgetName: string, options?: BudgetsGetOptionalParams): Promise<BudgetsGetResponse>;
141
- list(scope: string, options?: BudgetsListOptionalParams): PagedAsyncIterableIterator<Budget>;
142
- }
143
-
144
- // @public
145
- export interface BudgetsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
146
- }
147
-
148
- // @public
149
- export type BudgetsCreateOrUpdateResponse = Budget;
150
-
151
- // @public
152
- export interface BudgetsDeleteOptionalParams extends coreClient.OperationOptions {
153
- }
154
-
155
- // @public
156
- export interface BudgetsGetOptionalParams extends coreClient.OperationOptions {
157
- }
158
-
159
- // @public
160
- export type BudgetsGetResponse = Budget;
161
-
162
- // @public
163
- export interface BudgetsListNextOptionalParams extends coreClient.OperationOptions {
164
- }
165
-
166
- // @public
167
- export type BudgetsListNextResponse = BudgetsListResult;
168
-
169
- // @public
170
- export interface BudgetsListOptionalParams extends coreClient.OperationOptions {
171
- }
172
-
173
- // @public
174
- export type BudgetsListResponse = BudgetsListResult;
175
-
176
- // @public
177
- export interface BudgetsListResult {
178
- readonly nextLink?: string;
179
- readonly value?: Budget[];
180
- }
181
-
182
- // @public
183
- export interface BudgetTimePeriod {
184
- endDate?: Date;
185
- startDate: Date;
186
- }
187
-
188
- // @public
189
- export type CategoryType = string;
190
-
191
- // @public
192
- export interface Charges {
193
- list(scope: string, options?: ChargesListOptionalParams): Promise<ChargesListResponse>;
194
- }
195
-
196
- // @public
197
- export interface ChargesListOptionalParams extends coreClient.OperationOptions {
198
- apply?: string;
199
- endDate?: string;
200
- filter?: string;
201
- startDate?: string;
202
- }
203
-
204
- // @public
205
- export type ChargesListResponse = ChargesListResult;
206
-
207
- // @public
208
- export interface ChargesListResult {
209
- readonly value?: ChargeSummaryUnion[];
210
- }
211
-
212
- // @public
213
- export interface ChargeSummary extends ProxyResource {
214
- kind: ChargeSummaryKind;
215
- }
216
-
217
- // @public
218
- export type ChargeSummaryKind = string;
219
-
220
- // @public (undocumented)
221
- export type ChargeSummaryUnion = ChargeSummary | LegacyChargeSummary | ModernChargeSummary;
222
-
223
- // @public (undocumented)
224
- export class ConsumptionManagementClient extends coreClient.ServiceClient {
225
- // (undocumented)
226
- $host: string;
227
- constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ConsumptionManagementClientOptionalParams);
228
- // (undocumented)
229
- aggregatedCost: AggregatedCost;
230
- // (undocumented)
231
- apiVersion: string;
232
- // (undocumented)
233
- balances: Balances;
234
- // (undocumented)
235
- budgets: Budgets;
236
- // (undocumented)
237
- charges: Charges;
238
- // (undocumented)
239
- credits: Credits;
240
- // (undocumented)
241
- eventsOperations: EventsOperations;
242
- // (undocumented)
243
- lotsOperations: LotsOperations;
244
- // (undocumented)
245
- marketplaces: Marketplaces;
246
- // (undocumented)
247
- operations: Operations;
248
- // (undocumented)
249
- priceSheet: PriceSheet;
250
- // (undocumented)
251
- reservationRecommendationDetails: ReservationRecommendationDetails;
252
- // (undocumented)
253
- reservationRecommendations: ReservationRecommendations;
254
- // (undocumented)
255
- reservationsDetails: ReservationsDetails;
256
- // (undocumented)
257
- reservationsSummaries: ReservationsSummaries;
258
- // (undocumented)
259
- reservationTransactions: ReservationTransactions;
260
- // (undocumented)
261
- subscriptionId: string;
262
- // (undocumented)
263
- tags: Tags;
264
- // (undocumented)
265
- usageDetails: UsageDetails;
266
- }
267
-
268
- // @public
269
- export interface ConsumptionManagementClientOptionalParams extends coreClient.ServiceClientOptions {
270
- $host?: string;
271
- apiVersion?: string;
272
- endpoint?: string;
273
- }
274
-
275
- // @public
276
- export interface CreditBalanceSummary {
277
- readonly currentBalance?: Amount;
278
- readonly estimatedBalance?: Amount;
279
- readonly estimatedBalanceInBillingCurrency?: AmountWithExchangeRate;
280
- }
281
-
282
- // @public
283
- export interface Credits {
284
- get(billingAccountId: string, billingProfileId: string, options?: CreditsGetOptionalParams): Promise<CreditsGetResponse>;
285
- }
286
-
287
- // @public
288
- export interface CreditsGetOptionalParams extends coreClient.OperationOptions {
289
- }
290
-
291
- // @public
292
- export type CreditsGetResponse = CreditSummary;
293
-
294
- // @public
295
- export interface CreditSummary extends Resource {
296
- readonly balanceSummary?: CreditBalanceSummary;
297
- readonly billingCurrency?: string;
298
- readonly creditCurrency?: string;
299
- readonly eTag?: string;
300
- readonly expiredCredit?: Amount;
301
- readonly pendingCreditAdjustments?: Amount;
302
- readonly pendingEligibleCharges?: Amount;
303
- readonly reseller?: Reseller;
304
- }
305
-
306
- // @public
307
- export type CultureCode = string;
308
-
309
- // @public
310
- export interface CurrentSpend {
311
- readonly amount?: number;
312
- readonly unit?: string;
313
- }
314
-
315
- // @public
316
- export type Datagrain = string;
317
-
318
- // @public
319
- export interface DownloadProperties {
320
- readonly downloadUrl?: string;
321
- readonly validTill?: string;
322
- }
323
-
324
- // @public
325
- export interface ErrorDetails {
326
- readonly code?: string;
327
- readonly message?: string;
328
- }
329
-
330
- // @public
331
- export interface ErrorResponse {
332
- error?: ErrorDetails;
333
- }
334
-
335
- // @public
336
- export interface Events {
337
- readonly nextLink?: string;
338
- readonly value?: EventSummary[];
339
- }
340
-
341
- // @public
342
- export interface EventsListByBillingAccountNextOptionalParams extends coreClient.OperationOptions {
343
- }
344
-
345
- // @public
346
- export type EventsListByBillingAccountNextResponse = Events;
347
-
348
- // @public
349
- export interface EventsListByBillingAccountOptionalParams extends coreClient.OperationOptions {
350
- filter?: string;
351
- }
352
-
353
- // @public
354
- export type EventsListByBillingAccountResponse = Events;
355
-
356
- // @public
357
- export interface EventsListByBillingProfileNextOptionalParams extends coreClient.OperationOptions {
358
- }
359
-
360
- // @public
361
- export type EventsListByBillingProfileNextResponse = Events;
362
-
363
- // @public
364
- export interface EventsListByBillingProfileOptionalParams extends coreClient.OperationOptions {
365
- }
366
-
367
- // @public
368
- export type EventsListByBillingProfileResponse = Events;
369
-
370
- // @public
371
- export interface EventsOperations {
372
- listByBillingAccount(billingAccountId: string, options?: EventsListByBillingAccountOptionalParams): PagedAsyncIterableIterator<EventSummary>;
373
- listByBillingProfile(billingAccountId: string, billingProfileId: string, startDate: string, endDate: string, options?: EventsListByBillingProfileOptionalParams): PagedAsyncIterableIterator<EventSummary>;
374
- }
375
-
376
- // @public
377
- export interface EventSummary extends ProxyResource {
378
- readonly adjustments?: Amount;
379
- readonly adjustmentsInBillingCurrency?: AmountWithExchangeRate;
380
- readonly billingCurrency?: string;
381
- readonly billingProfileDisplayName?: string;
382
- readonly billingProfileId?: string;
383
- readonly canceledCredit?: Amount;
384
- readonly charges?: Amount;
385
- readonly chargesInBillingCurrency?: AmountWithExchangeRate;
386
- readonly closedBalance?: Amount;
387
- readonly closedBalanceInBillingCurrency?: AmountWithExchangeRate;
388
- readonly creditCurrency?: string;
389
- readonly creditExpired?: Amount;
390
- readonly creditExpiredInBillingCurrency?: AmountWithExchangeRate;
391
- readonly description?: string;
392
- readonly eTagPropertiesETag?: string;
393
- eventType?: EventType;
394
- readonly invoiceNumber?: string;
395
- readonly lotId?: string;
396
- readonly lotSource?: string;
397
- readonly newCredit?: Amount;
398
- readonly newCreditInBillingCurrency?: AmountWithExchangeRate;
399
- readonly reseller?: Reseller;
400
- readonly transactionDate?: Date;
401
- }
402
-
403
- // @public
404
- export type EventType = string;
405
-
406
- // @public
407
- export interface ForecastSpend {
408
- readonly amount?: number;
409
- readonly unit?: string;
410
- }
411
-
412
- // @public
413
- export function getContinuationToken(page: unknown): string | undefined;
414
-
415
- // @public
416
- export interface HighCasedErrorDetails {
417
- readonly code?: string;
418
- readonly message?: string;
419
- }
420
-
421
- // @public
422
- export interface HighCasedErrorResponse {
423
- error?: HighCasedErrorDetails;
424
- }
425
-
426
- // @public
427
- export enum KnownBillingFrequency {
428
- Month = "Month",
429
- Quarter = "Quarter",
430
- Year = "Year"
431
- }
432
-
433
- // @public
434
- export enum KnownBudgetOperatorType {
435
- In = "In"
436
- }
437
-
438
- // @public
439
- export enum KnownCategoryType {
440
- Cost = "Cost"
441
- }
442
-
443
- // @public
444
- export enum KnownChargeSummaryKind {
445
- Legacy = "legacy",
446
- Modern = "modern"
447
- }
448
-
449
- // @public
450
- export enum KnownCultureCode {
451
- CsCz = "cs-cz",
452
- DaDk = "da-dk",
453
- DeDe = "de-de",
454
- EnGb = "en-gb",
455
- EnUs = "en-us",
456
- EsEs = "es-es",
457
- FrFr = "fr-fr",
458
- HuHu = "hu-hu",
459
- ItIt = "it-it",
460
- JaJp = "ja-jp",
461
- KoKr = "ko-kr",
462
- NbNo = "nb-no",
463
- NlNl = "nl-nl",
464
- PlPl = "pl-pl",
465
- PtBr = "pt-br",
466
- PtPt = "pt-pt",
467
- RuRu = "ru-ru",
468
- SvSe = "sv-se",
469
- TrTr = "tr-tr",
470
- ZhCn = "zh-cn",
471
- ZhTw = "zh-tw"
472
- }
473
-
474
- // @public
475
- export enum KnownDatagrain {
476
- DailyGrain = "daily",
477
- MonthlyGrain = "monthly"
478
- }
479
-
480
- // @public
481
- export enum KnownEventType {
482
- NewCredit = "NewCredit",
483
- PendingAdjustments = "PendingAdjustments",
484
- PendingCharges = "PendingCharges",
485
- PendingExpiredCredit = "PendingExpiredCredit",
486
- PendingNewCredit = "PendingNewCredit",
487
- SettledCharges = "SettledCharges",
488
- UnKnown = "UnKnown"
489
- }
490
-
491
- // @public
492
- export enum KnownLookBackPeriod {
493
- Last07Days = "Last7Days",
494
- Last30Days = "Last30Days",
495
- Last60Days = "Last60Days"
496
- }
497
-
498
- // @public
499
- export enum KnownLotSource {
500
- ConsumptionCommitment = "ConsumptionCommitment",
501
- PromotionalCredit = "PromotionalCredit",
502
- PurchasedCredit = "PurchasedCredit"
503
- }
504
-
505
- // @public
506
- export enum KnownMetrictype {
507
- ActualCostMetricType = "actualcost",
508
- AmortizedCostMetricType = "amortizedcost",
509
- UsageMetricType = "usage"
510
- }
511
-
512
- // @public
513
- export enum KnownOperatorType {
514
- EqualTo = "EqualTo",
515
- GreaterThan = "GreaterThan",
516
- GreaterThanOrEqualTo = "GreaterThanOrEqualTo"
517
- }
518
-
519
- // @public
520
- export enum KnownPricingModelType {
521
- OnDemand = "On Demand",
522
- Reservation = "Reservation",
523
- Spot = "Spot"
524
- }
525
-
526
- // @public
527
- export enum KnownReservationRecommendationKind {
528
- Legacy = "legacy",
529
- Modern = "modern"
530
- }
531
-
532
- // @public
533
- export enum KnownScope {
534
- Shared = "Shared",
535
- Single = "Single"
536
- }
537
-
538
- // @public
539
- export enum KnownStatus {
540
- Active = "Active",
541
- Canceled = "Canceled",
542
- Complete = "Complete",
543
- Expired = "Expired",
544
- Inactive = "Inactive",
545
- None = "None"
546
- }
547
-
548
- // @public
549
- export enum KnownTerm {
550
- P1Y = "P1Y",
551
- P3Y = "P3Y"
552
- }
553
-
554
- // @public
555
- export enum KnownThresholdType {
556
- Actual = "Actual",
557
- Forecasted = "Forecasted"
558
- }
559
-
560
- // @public
561
- export enum KnownTimeGrainType {
562
- Annually = "Annually",
563
- BillingAnnual = "BillingAnnual",
564
- BillingMonth = "BillingMonth",
565
- BillingQuarter = "BillingQuarter",
566
- Monthly = "Monthly",
567
- Quarterly = "Quarterly"
568
- }
569
-
570
- // @public
571
- export enum KnownUsageDetailsKind {
572
- Legacy = "legacy",
573
- Modern = "modern"
574
- }
575
-
576
- // @public
577
- export interface LegacyChargeSummary extends ChargeSummary {
578
- readonly azureCharges?: number;
579
- readonly billingPeriodId?: string;
580
- readonly chargesBilledSeparately?: number;
581
- readonly currency?: string;
582
- kind: "legacy";
583
- readonly marketplaceCharges?: number;
584
- readonly usageEnd?: string;
585
- readonly usageStart?: string;
586
- }
587
-
588
- // @public
589
- export interface LegacyReservationRecommendation extends ReservationRecommendation {
590
- readonly costWithNoReservedInstances?: number;
591
- readonly firstUsageDate?: Date;
592
- readonly instanceFlexibilityGroup?: string;
593
- readonly instanceFlexibilityRatio?: number;
594
- kind: "legacy";
595
- readonly lookBackPeriod?: string;
596
- readonly meterId?: string;
597
- readonly netSavings?: number;
598
- readonly normalizedSize?: string;
599
- readonly recommendedQuantity?: number;
600
- readonly recommendedQuantityNormalized?: number;
601
- readonly resourceType?: string;
602
- scope: string;
603
- readonly skuProperties?: SkuProperty[];
604
- readonly term?: string;
605
- readonly totalCostWithReservedInstances?: number;
606
- }
607
-
608
- // @public
609
- export interface LegacyReservationRecommendationProperties {
610
- readonly costWithNoReservedInstances?: number;
611
- readonly firstUsageDate?: Date;
612
- readonly instanceFlexibilityGroup?: string;
613
- readonly instanceFlexibilityRatio?: number;
614
- readonly lookBackPeriod?: string;
615
- readonly meterId?: string;
616
- readonly netSavings?: number;
617
- readonly normalizedSize?: string;
618
- readonly recommendedQuantity?: number;
619
- readonly recommendedQuantityNormalized?: number;
620
- readonly resourceType?: string;
621
- scope: "Single" | "Shared";
622
- readonly skuProperties?: SkuProperty[];
623
- readonly term?: string;
624
- readonly totalCostWithReservedInstances?: number;
625
- }
626
-
627
- // @public (undocumented)
628
- export type LegacyReservationRecommendationPropertiesUnion = LegacyReservationRecommendationProperties | LegacySingleScopeReservationRecommendationProperties | LegacySharedScopeReservationRecommendationProperties;
629
-
630
- // @public
631
- export interface LegacyReservationTransaction extends ReservationTransaction {
632
- }
633
-
634
- // @public
635
- export interface LegacySharedScopeReservationRecommendationProperties extends LegacyReservationRecommendationProperties {
636
- scope: "Shared";
637
- }
638
-
639
- // @public
640
- export interface LegacySingleScopeReservationRecommendationProperties extends LegacyReservationRecommendationProperties {
641
- scope: "Single";
642
- readonly subscriptionId?: string;
643
- }
644
-
645
- // @public
646
- export interface LegacyUsageDetail extends UsageDetail {
647
- readonly accountName?: string;
648
- readonly accountOwnerId?: string;
649
- readonly additionalInfo?: string;
650
- readonly billingAccountId?: string;
651
- readonly billingAccountName?: string;
652
- readonly billingCurrency?: string;
653
- readonly billingPeriodEndDate?: Date;
654
- readonly billingPeriodStartDate?: Date;
655
- readonly billingProfileId?: string;
656
- readonly billingProfileName?: string;
657
- readonly chargeType?: string;
658
- readonly consumedService?: string;
659
- readonly cost?: number;
660
- readonly costCenter?: string;
661
- readonly date?: Date;
662
- readonly effectivePrice?: number;
663
- readonly frequency?: string;
664
- readonly invoiceSection?: string;
665
- readonly isAzureCreditEligible?: boolean;
666
- kind: "legacy";
667
- readonly meterDetails?: MeterDetailsResponse;
668
- readonly meterId?: string;
669
- readonly offerId?: string;
670
- readonly partNumber?: string;
671
- readonly payGPrice?: number;
672
- readonly planName?: string;
673
- readonly pricingModel?: PricingModelType;
674
- readonly product?: string;
675
- readonly productOrderId?: string;
676
- readonly productOrderName?: string;
677
- readonly publisherName?: string;
678
- readonly publisherType?: string;
679
- readonly quantity?: number;
680
- readonly reservationId?: string;
681
- readonly reservationName?: string;
682
- readonly resourceGroup?: string;
683
- readonly resourceId?: string;
684
- readonly resourceLocation?: string;
685
- readonly resourceName?: string;
686
- readonly serviceInfo1?: string;
687
- readonly serviceInfo2?: string;
688
- readonly subscriptionId?: string;
689
- readonly subscriptionName?: string;
690
- readonly term?: string;
691
- readonly unitPrice?: number;
692
- }
693
-
694
- // @public
695
- export type LookBackPeriod = string;
696
-
697
- // @public
698
- export interface Lots {
699
- readonly nextLink?: string;
700
- readonly value?: LotSummary[];
701
- }
702
-
703
- // @public
704
- export interface LotsListByBillingAccountNextOptionalParams extends coreClient.OperationOptions {
705
- }
706
-
707
- // @public
708
- export type LotsListByBillingAccountNextResponse = Lots;
709
-
710
- // @public
711
- export interface LotsListByBillingAccountOptionalParams extends coreClient.OperationOptions {
712
- filter?: string;
713
- }
714
-
715
- // @public
716
- export type LotsListByBillingAccountResponse = Lots;
717
-
718
- // @public
719
- export interface LotsListByBillingProfileNextOptionalParams extends coreClient.OperationOptions {
720
- }
721
-
722
- // @public
723
- export type LotsListByBillingProfileNextResponse = Lots;
724
-
725
- // @public
726
- export interface LotsListByBillingProfileOptionalParams extends coreClient.OperationOptions {
727
- }
728
-
729
- // @public
730
- export type LotsListByBillingProfileResponse = Lots;
731
-
732
- // @public
733
- export interface LotsOperations {
734
- listByBillingAccount(billingAccountId: string, options?: LotsListByBillingAccountOptionalParams): PagedAsyncIterableIterator<LotSummary>;
735
- listByBillingProfile(billingAccountId: string, billingProfileId: string, options?: LotsListByBillingProfileOptionalParams): PagedAsyncIterableIterator<LotSummary>;
736
- }
737
-
738
- // @public
739
- export type LotSource = string;
740
-
741
- // @public
742
- export interface LotSummary extends ProxyResource {
743
- readonly billingCurrency?: string;
744
- readonly closedBalance?: Amount;
745
- readonly closedBalanceInBillingCurrency?: AmountWithExchangeRate;
746
- readonly creditCurrency?: string;
747
- readonly eTagPropertiesETag?: string;
748
- readonly expirationDate?: Date;
749
- readonly originalAmount?: Amount;
750
- readonly originalAmountInBillingCurrency?: AmountWithExchangeRate;
751
- readonly poNumber?: string;
752
- readonly purchasedDate?: Date;
753
- readonly reseller?: Reseller;
754
- readonly source?: LotSource;
755
- readonly startDate?: Date;
756
- readonly status?: Status;
757
- }
758
-
759
- // @public
760
- export interface ManagementGroupAggregatedCostResult extends Resource {
761
- readonly azureCharges?: number;
762
- readonly billingPeriodId?: string;
763
- readonly chargesBilledSeparately?: number;
764
- children?: ManagementGroupAggregatedCostResult[];
765
- readonly currency?: string;
766
- excludedSubscriptions?: string[];
767
- includedSubscriptions?: string[];
768
- readonly marketplaceCharges?: number;
769
- readonly usageEnd?: Date;
770
- readonly usageStart?: Date;
771
- }
772
-
773
- // @public
774
- export interface Marketplace extends Resource {
775
- readonly accountName?: string;
776
- readonly additionalInfo?: string;
777
- readonly additionalProperties?: string;
778
- readonly billingPeriodId?: string;
779
- readonly consumedQuantity?: number;
780
- readonly consumedService?: string;
781
- readonly costCenter?: string;
782
- readonly currency?: string;
783
- readonly departmentName?: string;
784
- readonly instanceId?: string;
785
- readonly instanceName?: string;
786
- readonly isEstimated?: boolean;
787
- readonly isRecurringCharge?: boolean;
788
- readonly meterId?: string;
789
- readonly offerName?: string;
790
- readonly orderNumber?: string;
791
- readonly planName?: string;
792
- readonly pretaxCost?: number;
793
- readonly publisherName?: string;
794
- readonly resourceGroup?: string;
795
- readonly resourceRate?: number;
796
- readonly subscriptionGuid?: string;
797
- readonly subscriptionName?: string;
798
- readonly unitOfMeasure?: string;
799
- readonly usageEnd?: Date;
800
- readonly usageStart?: Date;
801
- }
802
-
803
- // @public
804
- export interface Marketplaces {
805
- list(scope: string, options?: MarketplacesListOptionalParams): PagedAsyncIterableIterator<Marketplace>;
806
- }
807
-
808
- // @public
809
- export interface MarketplacesListNextOptionalParams extends coreClient.OperationOptions {
810
- }
811
-
812
- // @public
813
- export type MarketplacesListNextResponse = MarketplacesListResult;
814
-
815
- // @public
816
- export interface MarketplacesListOptionalParams extends coreClient.OperationOptions {
817
- filter?: string;
818
- skiptoken?: string;
819
- top?: number;
820
- }
821
-
822
- // @public
823
- export type MarketplacesListResponse = MarketplacesListResult;
824
-
825
- // @public
826
- export interface MarketplacesListResult {
827
- readonly nextLink?: string;
828
- readonly value?: Marketplace[];
829
- }
830
-
831
- // @public
832
- export interface MeterDetails {
833
- readonly meterCategory?: string;
834
- readonly meterLocation?: string;
835
- readonly meterName?: string;
836
- readonly meterSubCategory?: string;
837
- readonly pretaxStandardRate?: number;
838
- readonly serviceName?: string;
839
- readonly serviceTier?: string;
840
- readonly totalIncludedQuantity?: number;
841
- readonly unit?: string;
842
- }
843
-
844
- // @public
845
- export interface MeterDetailsResponse {
846
- readonly meterCategory?: string;
847
- readonly meterName?: string;
848
- readonly meterSubCategory?: string;
849
- readonly serviceFamily?: string;
850
- readonly unitOfMeasure?: string;
851
- }
852
-
853
- // @public
854
- export type Metrictype = string;
855
-
856
- // @public
857
- export interface ModernChargeSummary extends ChargeSummary {
858
- readonly azureCharges?: Amount;
859
- readonly billingAccountId?: string;
860
- readonly billingPeriodId?: string;
861
- readonly billingProfileId?: string;
862
- readonly chargesBilledSeparately?: Amount;
863
- readonly customerId?: string;
864
- readonly invoiceSectionId?: string;
865
- readonly isInvoiced?: boolean;
866
- kind: "modern";
867
- readonly marketplaceCharges?: Amount;
868
- readonly usageEnd?: string;
869
- readonly usageStart?: string;
870
- }
871
-
872
- // @public
873
- export interface ModernReservationRecommendation extends ReservationRecommendation {
874
- readonly costWithNoReservedInstances?: Amount;
875
- readonly firstUsageDate?: Date;
876
- readonly instanceFlexibilityGroup?: string;
877
- readonly instanceFlexibilityRatio?: number;
878
- kind: "modern";
879
- readonly locationPropertiesLocation?: string;
880
- readonly lookBackPeriod?: number;
881
- readonly meterId?: string;
882
- readonly netSavings?: Amount;
883
- readonly normalizedSize?: string;
884
- readonly recommendedQuantity?: number;
885
- readonly recommendedQuantityNormalized?: number;
886
- readonly scope?: string;
887
- readonly skuName?: string;
888
- readonly skuProperties?: SkuProperty[];
889
- readonly term?: string;
890
- readonly totalCostWithReservedInstances?: Amount;
891
- }
892
-
893
- // @public
894
- export interface ModernReservationTransaction extends ReservationTransactionResource {
895
- readonly amount?: number;
896
- readonly armSkuName?: string;
897
- readonly billingFrequency?: string;
898
- readonly billingProfileId?: string;
899
- readonly billingProfileName?: string;
900
- readonly currency?: string;
901
- readonly description?: string;
902
- readonly eventDate?: Date;
903
- readonly eventType?: string;
904
- readonly invoice?: string;
905
- readonly invoiceId?: string;
906
- readonly invoiceSectionId?: string;
907
- readonly invoiceSectionName?: string;
908
- readonly purchasingSubscriptionGuid?: string;
909
- readonly purchasingSubscriptionName?: string;
910
- readonly quantity?: number;
911
- readonly region?: string;
912
- readonly reservationOrderId?: string;
913
- readonly reservationOrderName?: string;
914
- readonly term?: string;
915
- }
916
-
917
- // @public
918
- export interface ModernReservationTransactionsListResult {
919
- readonly nextLink?: string;
920
- readonly value?: ModernReservationTransaction[];
921
- }
922
-
923
- // @public
924
- export interface ModernUsageDetail extends UsageDetail {
925
- readonly additionalInfo?: string;
926
- readonly benefitId?: string;
927
- readonly benefitName?: string;
928
- readonly billingAccountId?: string;
929
- readonly billingAccountName?: string;
930
- readonly billingCurrencyCode?: string;
931
- readonly billingPeriodEndDate?: Date;
932
- readonly billingPeriodStartDate?: Date;
933
- readonly billingProfileId?: string;
934
- readonly billingProfileName?: string;
935
- readonly chargeType?: string;
936
- readonly consumedService?: string;
937
- readonly costAllocationRuleName?: string;
938
- readonly costCenter?: string;
939
- readonly costInBillingCurrency?: number;
940
- readonly costInPricingCurrency?: number;
941
- readonly costInUSD?: number;
942
- readonly customerName?: string;
943
- readonly customerTenantId?: string;
944
- readonly date?: Date;
945
- readonly effectivePrice?: number;
946
- readonly exchangeRate?: string;
947
- readonly exchangeRateDate?: Date;
948
- readonly exchangeRatePricingToBilling?: number;
949
- readonly frequency?: string;
950
- readonly instanceName?: string;
951
- readonly invoiceId?: string;
952
- readonly invoiceSectionId?: string;
953
- readonly invoiceSectionName?: string;
954
- readonly isAzureCreditEligible?: boolean;
955
- kind: "modern";
956
- readonly marketPrice?: number;
957
- readonly meterCategory?: string;
958
- readonly meterId?: string;
959
- readonly meterName?: string;
960
- readonly meterRegion?: string;
961
- readonly meterSubCategory?: string;
962
- readonly partnerEarnedCreditApplied?: string;
963
- readonly partnerEarnedCreditRate?: number;
964
- readonly partnerName?: string;
965
- readonly partnerTenantId?: string;
966
- readonly paygCostInBillingCurrency?: number;
967
- readonly paygCostInUSD?: number;
968
- readonly payGPrice?: number;
969
- readonly previousInvoiceId?: string;
970
- readonly pricingCurrencyCode?: string;
971
- readonly pricingModel?: PricingModelType;
972
- readonly product?: string;
973
- readonly productIdentifier?: string;
974
- readonly productOrderId?: string;
975
- readonly productOrderName?: string;
976
- readonly provider?: string;
977
- readonly publisherId?: string;
978
- readonly publisherName?: string;
979
- readonly publisherType?: string;
980
- readonly quantity?: number;
981
- readonly resellerMpnId?: string;
982
- readonly resellerName?: string;
983
- readonly reservationId?: string;
984
- readonly reservationName?: string;
985
- readonly resourceGroup?: string;
986
- readonly resourceLocation?: string;
987
- readonly resourceLocationNormalized?: string;
988
- readonly serviceFamily?: string;
989
- readonly serviceInfo1?: string;
990
- readonly serviceInfo2?: string;
991
- readonly servicePeriodEndDate?: Date;
992
- readonly servicePeriodStartDate?: Date;
993
- readonly subscriptionGuid?: string;
994
- readonly subscriptionName?: string;
995
- readonly term?: string;
996
- readonly unitOfMeasure?: string;
997
- readonly unitPrice?: number;
998
- }
999
-
1000
- // @public
1001
- export interface Notification {
1002
- contactEmails: string[];
1003
- contactGroups?: string[];
1004
- contactRoles?: string[];
1005
- enabled: boolean;
1006
- locale?: CultureCode;
1007
- operator: OperatorType;
1008
- threshold: number;
1009
- thresholdType?: ThresholdType;
1010
- }
1011
-
1012
- // @public
1013
- export interface Operation {
1014
- display?: OperationDisplay;
1015
- readonly id?: string;
1016
- readonly name?: string;
1017
- }
1018
-
1019
- // @public
1020
- export interface OperationDisplay {
1021
- readonly description?: string;
1022
- readonly operation?: string;
1023
- readonly provider?: string;
1024
- readonly resource?: string;
1025
- }
1026
-
1027
- // @public
1028
- export interface OperationListResult {
1029
- readonly nextLink?: string;
1030
- readonly value?: Operation[];
1031
- }
1032
-
1033
- // @public
1034
- export interface Operations {
1035
- list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
1036
- }
1037
-
1038
- // @public
1039
- export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
1040
- }
1041
-
1042
- // @public
1043
- export type OperationsListNextResponse = OperationListResult;
1044
-
1045
- // @public
1046
- export interface OperationsListOptionalParams extends coreClient.OperationOptions {
1047
- }
1048
-
1049
- // @public
1050
- export type OperationsListResponse = OperationListResult;
1051
-
1052
- // @public
1053
- export type OperatorType = string;
1054
-
1055
- // @public
1056
- export interface PriceSheet {
1057
- get(options?: PriceSheetGetOptionalParams): Promise<PriceSheetGetResponse>;
1058
- getByBillingPeriod(billingPeriodName: string, options?: PriceSheetGetByBillingPeriodOptionalParams): Promise<PriceSheetGetByBillingPeriodResponse>;
1059
- }
1060
-
1061
- // @public
1062
- export interface PriceSheetGetByBillingPeriodOptionalParams extends coreClient.OperationOptions {
1063
- expand?: string;
1064
- skiptoken?: string;
1065
- top?: number;
1066
- }
1067
-
1068
- // @public
1069
- export type PriceSheetGetByBillingPeriodResponse = PriceSheetResult;
1070
-
1071
- // @public
1072
- export interface PriceSheetGetOptionalParams extends coreClient.OperationOptions {
1073
- expand?: string;
1074
- skiptoken?: string;
1075
- top?: number;
1076
- }
1077
-
1078
- // @public
1079
- export type PriceSheetGetResponse = PriceSheetResult;
1080
-
1081
- // @public
1082
- export interface PriceSheetProperties {
1083
- readonly billingPeriodId?: string;
1084
- readonly currencyCode?: string;
1085
- readonly includedQuantity?: number;
1086
- readonly meterDetails?: MeterDetails;
1087
- readonly meterId?: string;
1088
- readonly offerId?: string;
1089
- readonly partNumber?: string;
1090
- readonly unitOfMeasure?: string;
1091
- readonly unitPrice?: number;
1092
- }
1093
-
1094
- // @public
1095
- export interface PriceSheetResult extends Resource {
1096
- readonly download?: MeterDetails;
1097
- readonly nextLink?: string;
1098
- readonly pricesheets?: PriceSheetProperties[];
1099
- }
1100
-
1101
- // @public
1102
- export type PricingModelType = string;
1103
-
1104
- // @public
1105
- export interface ProxyResource {
1106
- eTag?: string;
1107
- readonly id?: string;
1108
- readonly name?: string;
1109
- readonly type?: string;
1110
- }
1111
-
1112
- // @public
1113
- export interface Reseller {
1114
- readonly resellerDescription?: string;
1115
- readonly resellerId?: string;
1116
- }
1117
-
1118
- // @public
1119
- export interface ReservationDetail extends Resource {
1120
- readonly instanceFlexibilityGroup?: string;
1121
- readonly instanceFlexibilityRatio?: string;
1122
- readonly instanceId?: string;
1123
- readonly kind?: string;
1124
- readonly reservationId?: string;
1125
- readonly reservationOrderId?: string;
1126
- readonly reservedHours?: number;
1127
- readonly skuName?: string;
1128
- readonly totalReservedQuantity?: number;
1129
- readonly usageDate?: Date;
1130
- readonly usedHours?: number;
1131
- }
1132
-
1133
- // @public
1134
- export interface ReservationDetailsListResult {
1135
- readonly nextLink?: string;
1136
- readonly value?: ReservationDetail[];
1137
- }
1138
-
1139
- // @public
1140
- export interface ReservationRecommendation extends Resource, ResourceAttributes {
1141
- kind: ReservationRecommendationKind;
1142
- }
1143
-
1144
- // @public
1145
- export interface ReservationRecommendationDetails {
1146
- get(scope: string, region: string, term: Term, lookBackPeriod: LookBackPeriod, product: string, options?: ReservationRecommendationDetailsGetOptionalParams): Promise<ReservationRecommendationDetailsGetResponse>;
1147
- }
1148
-
1149
- // @public
1150
- export interface ReservationRecommendationDetailsCalculatedSavingsProperties {
1151
- readonly onDemandCost?: number;
1152
- readonly overageCost?: number;
1153
- readonly quantity?: number;
1154
- readonly reservationCost?: number;
1155
- reservedUnitCount?: number;
1156
- readonly savings?: number;
1157
- readonly totalReservationCost?: number;
1158
- }
1159
-
1160
- // @public
1161
- export interface ReservationRecommendationDetailsGetOptionalParams extends coreClient.OperationOptions {
1162
- }
1163
-
1164
- // @public
1165
- export type ReservationRecommendationDetailsGetResponse = ReservationRecommendationDetailsModel;
1166
-
1167
- // @public
1168
- export interface ReservationRecommendationDetailsModel extends Resource {
1169
- readonly currency?: string;
1170
- location?: string;
1171
- readonly resource?: ReservationRecommendationDetailsResourceProperties;
1172
- readonly resourceGroup?: string;
1173
- readonly savings?: ReservationRecommendationDetailsSavingsProperties;
1174
- readonly scope?: string;
1175
- sku?: string;
1176
- readonly usage?: ReservationRecommendationDetailsUsageProperties;
1177
- }
1178
-
1179
- // @public
1180
- export interface ReservationRecommendationDetailsResourceProperties {
1181
- readonly appliedScopes?: string[];
1182
- readonly onDemandRate?: number;
1183
- readonly product?: string;
1184
- readonly region?: string;
1185
- readonly reservationRate?: number;
1186
- readonly resourceType?: string;
1187
- }
1188
-
1189
- // @public
1190
- export interface ReservationRecommendationDetailsSavingsProperties {
1191
- calculatedSavings?: ReservationRecommendationDetailsCalculatedSavingsProperties[];
1192
- readonly lookBackPeriod?: number;
1193
- readonly recommendedQuantity?: number;
1194
- readonly reservationOrderTerm?: string;
1195
- readonly savingsType?: string;
1196
- readonly unitOfMeasure?: string;
1197
- }
1198
-
1199
- // @public
1200
- export interface ReservationRecommendationDetailsUsageProperties {
1201
- readonly firstConsumptionDate?: string;
1202
- readonly lastConsumptionDate?: string;
1203
- readonly lookBackUnitType?: string;
1204
- readonly usageData?: number[];
1205
- readonly usageGrain?: string;
1206
- }
1207
-
1208
- // @public
1209
- export type ReservationRecommendationKind = string;
1210
-
1211
- // @public
1212
- export interface ReservationRecommendations {
1213
- list(scope: string, options?: ReservationRecommendationsListOptionalParams): PagedAsyncIterableIterator<ReservationRecommendationUnion>;
1214
- }
1215
-
1216
- // @public
1217
- export interface ReservationRecommendationsListNextOptionalParams extends coreClient.OperationOptions {
1218
- }
1219
-
1220
- // @public
1221
- export type ReservationRecommendationsListNextResponse = ReservationRecommendationsListResult;
1222
-
1223
- // @public
1224
- export interface ReservationRecommendationsListOptionalParams extends coreClient.OperationOptions {
1225
- filter?: string;
1226
- }
1227
-
1228
- // @public
1229
- export type ReservationRecommendationsListResponse = ReservationRecommendationsListResult;
1230
-
1231
- // @public
1232
- export interface ReservationRecommendationsListResult {
1233
- readonly nextLink?: string;
1234
- readonly previousLink?: string;
1235
- readonly value?: ReservationRecommendationUnion[];
1236
- }
1237
-
1238
- // @public (undocumented)
1239
- export type ReservationRecommendationUnion = ReservationRecommendation | LegacyReservationRecommendation | ModernReservationRecommendation;
1240
-
1241
- // @public
1242
- export interface ReservationsDetails {
1243
- list(scope: string, options?: ReservationsDetailsListOptionalParams): PagedAsyncIterableIterator<ReservationDetail>;
1244
- listByReservationOrder(reservationOrderId: string, filter: string, options?: ReservationsDetailsListByReservationOrderOptionalParams): PagedAsyncIterableIterator<ReservationDetail>;
1245
- listByReservationOrderAndReservation(reservationOrderId: string, reservationId: string, filter: string, options?: ReservationsDetailsListByReservationOrderAndReservationOptionalParams): PagedAsyncIterableIterator<ReservationDetail>;
1246
- }
1247
-
1248
- // @public
1249
- export interface ReservationsDetailsListByReservationOrderAndReservationNextOptionalParams extends coreClient.OperationOptions {
1250
- }
1251
-
1252
- // @public
1253
- export type ReservationsDetailsListByReservationOrderAndReservationNextResponse = ReservationDetailsListResult;
1254
-
1255
- // @public
1256
- export interface ReservationsDetailsListByReservationOrderAndReservationOptionalParams extends coreClient.OperationOptions {
1257
- }
1258
-
1259
- // @public
1260
- export type ReservationsDetailsListByReservationOrderAndReservationResponse = ReservationDetailsListResult;
1261
-
1262
- // @public
1263
- export interface ReservationsDetailsListByReservationOrderNextOptionalParams extends coreClient.OperationOptions {
1264
- }
1265
-
1266
- // @public
1267
- export type ReservationsDetailsListByReservationOrderNextResponse = ReservationDetailsListResult;
1268
-
1269
- // @public
1270
- export interface ReservationsDetailsListByReservationOrderOptionalParams extends coreClient.OperationOptions {
1271
- }
1272
-
1273
- // @public
1274
- export type ReservationsDetailsListByReservationOrderResponse = ReservationDetailsListResult;
1275
-
1276
- // @public
1277
- export interface ReservationsDetailsListNextOptionalParams extends coreClient.OperationOptions {
1278
- }
1279
-
1280
- // @public
1281
- export type ReservationsDetailsListNextResponse = ReservationDetailsListResult;
1282
-
1283
- // @public
1284
- export interface ReservationsDetailsListOptionalParams extends coreClient.OperationOptions {
1285
- endDate?: string;
1286
- filter?: string;
1287
- reservationId?: string;
1288
- reservationOrderId?: string;
1289
- startDate?: string;
1290
- }
1291
-
1292
- // @public
1293
- export type ReservationsDetailsListResponse = ReservationDetailsListResult;
1294
-
1295
- // @public
1296
- export interface ReservationsSummaries {
1297
- list(scope: string, grain: Datagrain, options?: ReservationsSummariesListOptionalParams): PagedAsyncIterableIterator<ReservationSummary>;
1298
- listByReservationOrder(reservationOrderId: string, grain: Datagrain, options?: ReservationsSummariesListByReservationOrderOptionalParams): PagedAsyncIterableIterator<ReservationSummary>;
1299
- listByReservationOrderAndReservation(reservationOrderId: string, reservationId: string, grain: Datagrain, options?: ReservationsSummariesListByReservationOrderAndReservationOptionalParams): PagedAsyncIterableIterator<ReservationSummary>;
1300
- }
1301
-
1302
- // @public
1303
- export interface ReservationsSummariesListByReservationOrderAndReservationNextOptionalParams extends coreClient.OperationOptions {
1304
- }
1305
-
1306
- // @public
1307
- export type ReservationsSummariesListByReservationOrderAndReservationNextResponse = ReservationSummariesListResult;
1308
-
1309
- // @public
1310
- export interface ReservationsSummariesListByReservationOrderAndReservationOptionalParams extends coreClient.OperationOptions {
1311
- filter?: string;
1312
- }
1313
-
1314
- // @public
1315
- export type ReservationsSummariesListByReservationOrderAndReservationResponse = ReservationSummariesListResult;
1316
-
1317
- // @public
1318
- export interface ReservationsSummariesListByReservationOrderNextOptionalParams extends coreClient.OperationOptions {
1319
- }
1320
-
1321
- // @public
1322
- export type ReservationsSummariesListByReservationOrderNextResponse = ReservationSummariesListResult;
1323
-
1324
- // @public
1325
- export interface ReservationsSummariesListByReservationOrderOptionalParams extends coreClient.OperationOptions {
1326
- filter?: string;
1327
- }
1328
-
1329
- // @public
1330
- export type ReservationsSummariesListByReservationOrderResponse = ReservationSummariesListResult;
1331
-
1332
- // @public
1333
- export interface ReservationsSummariesListNextOptionalParams extends coreClient.OperationOptions {
1334
- }
1335
-
1336
- // @public
1337
- export type ReservationsSummariesListNextResponse = ReservationSummariesListResult;
1338
-
1339
- // @public
1340
- export interface ReservationsSummariesListOptionalParams extends coreClient.OperationOptions {
1341
- endDate?: string;
1342
- filter?: string;
1343
- reservationId?: string;
1344
- reservationOrderId?: string;
1345
- startDate?: string;
1346
- }
1347
-
1348
- // @public
1349
- export type ReservationsSummariesListResponse = ReservationSummariesListResult;
1350
-
1351
- // @public
1352
- export interface ReservationSummariesListResult {
1353
- readonly nextLink?: string;
1354
- readonly value?: ReservationSummary[];
1355
- }
1356
-
1357
- // @public
1358
- export interface ReservationSummary extends Resource {
1359
- readonly avgUtilizationPercentage?: number;
1360
- readonly kind?: string;
1361
- readonly maxUtilizationPercentage?: number;
1362
- readonly minUtilizationPercentage?: number;
1363
- readonly purchasedQuantity?: number;
1364
- readonly remainingQuantity?: number;
1365
- readonly reservationId?: string;
1366
- readonly reservationOrderId?: string;
1367
- readonly reservedHours?: number;
1368
- readonly skuName?: string;
1369
- readonly totalReservedQuantity?: number;
1370
- readonly usageDate?: Date;
1371
- readonly usedHours?: number;
1372
- readonly usedQuantity?: number;
1373
- readonly utilizedPercentage?: number;
1374
- }
1375
-
1376
- // @public
1377
- export interface ReservationTransaction extends ReservationTransactionResource {
1378
- readonly accountName?: string;
1379
- readonly accountOwnerEmail?: string;
1380
- readonly amount?: number;
1381
- readonly armSkuName?: string;
1382
- readonly billingFrequency?: string;
1383
- readonly billingMonth?: number;
1384
- readonly costCenter?: string;
1385
- readonly currency?: string;
1386
- readonly currentEnrollment?: string;
1387
- readonly departmentName?: string;
1388
- readonly description?: string;
1389
- readonly eventDate?: Date;
1390
- readonly eventType?: string;
1391
- readonly monetaryCommitment?: number;
1392
- readonly overage?: number;
1393
- readonly purchasingEnrollment?: string;
1394
- readonly purchasingSubscriptionGuid?: string;
1395
- readonly purchasingSubscriptionName?: string;
1396
- readonly quantity?: number;
1397
- readonly region?: string;
1398
- readonly reservationOrderId?: string;
1399
- readonly reservationOrderName?: string;
1400
- readonly term?: string;
1401
- }
1402
-
1403
- // @public
1404
- export interface ReservationTransactionResource {
1405
- readonly id?: string;
1406
- readonly name?: string;
1407
- readonly tags?: string[];
1408
- readonly type?: string;
1409
- }
1410
-
1411
- // @public
1412
- export interface ReservationTransactions {
1413
- list(billingAccountId: string, options?: ReservationTransactionsListOptionalParams): PagedAsyncIterableIterator<ReservationTransaction>;
1414
- listByBillingProfile(billingAccountId: string, billingProfileId: string, options?: ReservationTransactionsListByBillingProfileOptionalParams): PagedAsyncIterableIterator<ModernReservationTransaction>;
1415
- }
1416
-
1417
- // @public
1418
- export interface ReservationTransactionsListByBillingProfileNextOptionalParams extends coreClient.OperationOptions {
1419
- }
1420
-
1421
- // @public
1422
- export type ReservationTransactionsListByBillingProfileNextResponse = ModernReservationTransactionsListResult;
1423
-
1424
- // @public
1425
- export interface ReservationTransactionsListByBillingProfileOptionalParams extends coreClient.OperationOptions {
1426
- filter?: string;
1427
- }
1428
-
1429
- // @public
1430
- export type ReservationTransactionsListByBillingProfileResponse = ModernReservationTransactionsListResult;
1431
-
1432
- // @public
1433
- export interface ReservationTransactionsListNextOptionalParams extends coreClient.OperationOptions {
1434
- }
1435
-
1436
- // @public
1437
- export type ReservationTransactionsListNextResponse = ReservationTransactionsListResult;
1438
-
1439
- // @public
1440
- export interface ReservationTransactionsListOptionalParams extends coreClient.OperationOptions {
1441
- filter?: string;
1442
- }
1443
-
1444
- // @public
1445
- export type ReservationTransactionsListResponse = ReservationTransactionsListResult;
1446
-
1447
- // @public
1448
- export interface ReservationTransactionsListResult {
1449
- readonly nextLink?: string;
1450
- readonly value?: ReservationTransaction[];
1451
- }
1452
-
1453
- // @public
1454
- export interface Resource {
1455
- readonly etag?: string;
1456
- readonly id?: string;
1457
- readonly name?: string;
1458
- readonly tags?: {
1459
- [propertyName: string]: string;
1460
- };
1461
- readonly type?: string;
1462
- }
1463
-
1464
- // @public
1465
- export interface ResourceAttributes {
1466
- readonly location?: string;
1467
- readonly sku?: string;
1468
- }
1469
-
1470
- // @public
1471
- export type Scope = string;
1472
-
1473
- // @public
1474
- export interface SkuProperty {
1475
- readonly name?: string;
1476
- readonly value?: string;
1477
- }
1478
-
1479
- // @public
1480
- export type Status = string;
1481
-
1482
- // @public
1483
- export interface Tag {
1484
- key?: string;
1485
- value?: string[];
1486
- }
1487
-
1488
- // @public
1489
- export interface Tags {
1490
- get(scope: string, options?: TagsGetOptionalParams): Promise<TagsGetResponse>;
1491
- }
1492
-
1493
- // @public
1494
- export interface TagsGetOptionalParams extends coreClient.OperationOptions {
1495
- }
1496
-
1497
- // @public
1498
- export type TagsGetResponse = TagsResult;
1499
-
1500
- // @public
1501
- export interface TagsResult extends ProxyResource {
1502
- readonly nextLink?: string;
1503
- readonly previousLink?: string;
1504
- tags?: Tag[];
1505
- }
1506
-
1507
- // @public
1508
- export type Term = string;
1509
-
1510
- // @public
1511
- export type ThresholdType = string;
1512
-
1513
- // @public
1514
- export type TimeGrainType = string;
1515
-
1516
- // @public
1517
- export interface UsageDetail extends Resource {
1518
- kind: UsageDetailsKind;
1519
- }
1520
-
1521
- // @public
1522
- export interface UsageDetails {
1523
- list(scope: string, options?: UsageDetailsListOptionalParams): PagedAsyncIterableIterator<UsageDetailUnion>;
1524
- }
1525
-
1526
- // @public
1527
- export type UsageDetailsKind = string;
1528
-
1529
- // @public
1530
- export interface UsageDetailsListNextOptionalParams extends coreClient.OperationOptions {
1531
- }
1532
-
1533
- // @public
1534
- export type UsageDetailsListNextResponse = UsageDetailsListResult;
1535
-
1536
- // @public
1537
- export interface UsageDetailsListOptionalParams extends coreClient.OperationOptions {
1538
- expand?: string;
1539
- filter?: string;
1540
- metric?: Metrictype;
1541
- skiptoken?: string;
1542
- top?: number;
1543
- }
1544
-
1545
- // @public
1546
- export type UsageDetailsListResponse = UsageDetailsListResult;
1547
-
1548
- // @public
1549
- export interface UsageDetailsListResult {
1550
- readonly nextLink?: string;
1551
- readonly value?: UsageDetailUnion[];
1552
- }
1553
-
1554
- // @public (undocumented)
1555
- export type UsageDetailUnion = UsageDetail | LegacyUsageDetail | ModernUsageDetail;
1556
-
1557
- // (No @packageDocumentation comment for this package)
1558
-
1559
- ```
1
+ ## API Report File for "@azure/arm-consumption"
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 { PagedAsyncIterableIterator } from '@azure/core-paging';
10
+
11
+ // @public
12
+ export interface AggregatedCost {
13
+ getByManagementGroup(managementGroupId: string, options?: AggregatedCostGetByManagementGroupOptionalParams): Promise<AggregatedCostGetByManagementGroupResponse>;
14
+ getForBillingPeriodByManagementGroup(managementGroupId: string, billingPeriodName: string, options?: AggregatedCostGetForBillingPeriodByManagementGroupOptionalParams): Promise<AggregatedCostGetForBillingPeriodByManagementGroupResponse>;
15
+ }
16
+
17
+ // @public
18
+ export interface AggregatedCostGetByManagementGroupOptionalParams extends coreClient.OperationOptions {
19
+ filter?: string;
20
+ }
21
+
22
+ // @public
23
+ export type AggregatedCostGetByManagementGroupResponse = ManagementGroupAggregatedCostResult;
24
+
25
+ // @public
26
+ export interface AggregatedCostGetForBillingPeriodByManagementGroupOptionalParams extends coreClient.OperationOptions {
27
+ }
28
+
29
+ // @public
30
+ export type AggregatedCostGetForBillingPeriodByManagementGroupResponse = ManagementGroupAggregatedCostResult;
31
+
32
+ // @public
33
+ export interface Amount {
34
+ readonly currency?: string;
35
+ readonly value?: number;
36
+ }
37
+
38
+ // @public
39
+ export interface AmountWithExchangeRate extends Amount {
40
+ readonly exchangeRate?: number;
41
+ readonly exchangeRateMonth?: number;
42
+ }
43
+
44
+ // @public
45
+ export interface Balance extends Resource {
46
+ readonly adjustmentDetails?: BalancePropertiesAdjustmentDetailsItem[];
47
+ readonly adjustments?: number;
48
+ readonly azureMarketplaceServiceCharges?: number;
49
+ readonly beginningBalance?: number;
50
+ billingFrequency?: BillingFrequency;
51
+ readonly chargesBilledSeparately?: number;
52
+ readonly currency?: string;
53
+ readonly endingBalance?: number;
54
+ readonly newPurchases?: number;
55
+ readonly newPurchasesDetails?: BalancePropertiesNewPurchasesDetailsItem[];
56
+ readonly priceHidden?: boolean;
57
+ readonly serviceOverage?: number;
58
+ readonly totalOverage?: number;
59
+ readonly totalUsage?: number;
60
+ readonly utilized?: number;
61
+ }
62
+
63
+ // @public (undocumented)
64
+ export interface BalancePropertiesAdjustmentDetailsItem {
65
+ readonly name?: string;
66
+ readonly value?: number;
67
+ }
68
+
69
+ // @public (undocumented)
70
+ export interface BalancePropertiesNewPurchasesDetailsItem {
71
+ readonly name?: string;
72
+ readonly value?: number;
73
+ }
74
+
75
+ // @public
76
+ export interface Balances {
77
+ getByBillingAccount(billingAccountId: string, options?: BalancesGetByBillingAccountOptionalParams): Promise<BalancesGetByBillingAccountResponse>;
78
+ getForBillingPeriodByBillingAccount(billingAccountId: string, billingPeriodName: string, options?: BalancesGetForBillingPeriodByBillingAccountOptionalParams): Promise<BalancesGetForBillingPeriodByBillingAccountResponse>;
79
+ }
80
+
81
+ // @public
82
+ export interface BalancesGetByBillingAccountOptionalParams extends coreClient.OperationOptions {
83
+ }
84
+
85
+ // @public
86
+ export type BalancesGetByBillingAccountResponse = Balance;
87
+
88
+ // @public
89
+ export interface BalancesGetForBillingPeriodByBillingAccountOptionalParams extends coreClient.OperationOptions {
90
+ }
91
+
92
+ // @public
93
+ export type BalancesGetForBillingPeriodByBillingAccountResponse = Balance;
94
+
95
+ // @public
96
+ export type BillingFrequency = string;
97
+
98
+ // @public
99
+ export interface Budget extends ProxyResource {
100
+ amount?: number;
101
+ category?: CategoryType;
102
+ readonly currentSpend?: CurrentSpend;
103
+ filter?: BudgetFilter;
104
+ readonly forecastSpend?: ForecastSpend;
105
+ notifications?: {
106
+ [propertyName: string]: Notification;
107
+ };
108
+ timeGrain?: TimeGrainType;
109
+ timePeriod?: BudgetTimePeriod;
110
+ }
111
+
112
+ // @public
113
+ export interface BudgetComparisonExpression {
114
+ name: string;
115
+ operator: BudgetOperatorType;
116
+ values: string[];
117
+ }
118
+
119
+ // @public
120
+ export interface BudgetFilter {
121
+ and?: BudgetFilterProperties[];
122
+ dimensions?: BudgetComparisonExpression;
123
+ not?: BudgetFilterProperties;
124
+ tags?: BudgetComparisonExpression;
125
+ }
126
+
127
+ // @public
128
+ export interface BudgetFilterProperties {
129
+ dimensions?: BudgetComparisonExpression;
130
+ tags?: BudgetComparisonExpression;
131
+ }
132
+
133
+ // @public
134
+ export type BudgetOperatorType = string;
135
+
136
+ // @public
137
+ export interface Budgets {
138
+ createOrUpdate(scope: string, budgetName: string, parameters: Budget, options?: BudgetsCreateOrUpdateOptionalParams): Promise<BudgetsCreateOrUpdateResponse>;
139
+ delete(scope: string, budgetName: string, options?: BudgetsDeleteOptionalParams): Promise<void>;
140
+ get(scope: string, budgetName: string, options?: BudgetsGetOptionalParams): Promise<BudgetsGetResponse>;
141
+ list(scope: string, options?: BudgetsListOptionalParams): PagedAsyncIterableIterator<Budget>;
142
+ }
143
+
144
+ // @public
145
+ export interface BudgetsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
146
+ }
147
+
148
+ // @public
149
+ export type BudgetsCreateOrUpdateResponse = Budget;
150
+
151
+ // @public
152
+ export interface BudgetsDeleteOptionalParams extends coreClient.OperationOptions {
153
+ }
154
+
155
+ // @public
156
+ export interface BudgetsGetOptionalParams extends coreClient.OperationOptions {
157
+ }
158
+
159
+ // @public
160
+ export type BudgetsGetResponse = Budget;
161
+
162
+ // @public
163
+ export interface BudgetsListNextOptionalParams extends coreClient.OperationOptions {
164
+ }
165
+
166
+ // @public
167
+ export type BudgetsListNextResponse = BudgetsListResult;
168
+
169
+ // @public
170
+ export interface BudgetsListOptionalParams extends coreClient.OperationOptions {
171
+ }
172
+
173
+ // @public
174
+ export type BudgetsListResponse = BudgetsListResult;
175
+
176
+ // @public
177
+ export interface BudgetsListResult {
178
+ readonly nextLink?: string;
179
+ readonly value?: Budget[];
180
+ }
181
+
182
+ // @public
183
+ export interface BudgetTimePeriod {
184
+ endDate?: Date;
185
+ startDate: Date;
186
+ }
187
+
188
+ // @public
189
+ export type CategoryType = string;
190
+
191
+ // @public
192
+ export interface Charges {
193
+ list(scope: string, options?: ChargesListOptionalParams): Promise<ChargesListResponse>;
194
+ }
195
+
196
+ // @public
197
+ export interface ChargesListOptionalParams extends coreClient.OperationOptions {
198
+ apply?: string;
199
+ endDate?: string;
200
+ filter?: string;
201
+ startDate?: string;
202
+ }
203
+
204
+ // @public
205
+ export type ChargesListResponse = ChargesListResult;
206
+
207
+ // @public
208
+ export interface ChargesListResult {
209
+ readonly value?: ChargeSummaryUnion[];
210
+ }
211
+
212
+ // @public
213
+ export interface ChargeSummary extends ProxyResource {
214
+ kind: ChargeSummaryKind;
215
+ }
216
+
217
+ // @public
218
+ export type ChargeSummaryKind = string;
219
+
220
+ // @public (undocumented)
221
+ export type ChargeSummaryUnion = ChargeSummary | LegacyChargeSummary | ModernChargeSummary;
222
+
223
+ // @public (undocumented)
224
+ export class ConsumptionManagementClient extends coreClient.ServiceClient {
225
+ // (undocumented)
226
+ $host: string;
227
+ constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ConsumptionManagementClientOptionalParams);
228
+ // (undocumented)
229
+ aggregatedCost: AggregatedCost;
230
+ // (undocumented)
231
+ apiVersion: string;
232
+ // (undocumented)
233
+ balances: Balances;
234
+ // (undocumented)
235
+ budgets: Budgets;
236
+ // (undocumented)
237
+ charges: Charges;
238
+ // (undocumented)
239
+ credits: Credits;
240
+ // (undocumented)
241
+ eventsOperations: EventsOperations;
242
+ // (undocumented)
243
+ lotsOperations: LotsOperations;
244
+ // (undocumented)
245
+ marketplaces: Marketplaces;
246
+ // (undocumented)
247
+ operations: Operations;
248
+ // (undocumented)
249
+ priceSheet: PriceSheet;
250
+ // (undocumented)
251
+ reservationRecommendationDetails: ReservationRecommendationDetails;
252
+ // (undocumented)
253
+ reservationRecommendations: ReservationRecommendations;
254
+ // (undocumented)
255
+ reservationsDetails: ReservationsDetails;
256
+ // (undocumented)
257
+ reservationsSummaries: ReservationsSummaries;
258
+ // (undocumented)
259
+ reservationTransactions: ReservationTransactions;
260
+ // (undocumented)
261
+ subscriptionId: string;
262
+ // (undocumented)
263
+ tags: Tags;
264
+ // (undocumented)
265
+ usageDetails: UsageDetails;
266
+ }
267
+
268
+ // @public
269
+ export interface ConsumptionManagementClientOptionalParams extends coreClient.ServiceClientOptions {
270
+ $host?: string;
271
+ apiVersion?: string;
272
+ endpoint?: string;
273
+ }
274
+
275
+ // @public
276
+ export interface CreditBalanceSummary {
277
+ readonly currentBalance?: Amount;
278
+ readonly estimatedBalance?: Amount;
279
+ readonly estimatedBalanceInBillingCurrency?: AmountWithExchangeRate;
280
+ }
281
+
282
+ // @public
283
+ export interface Credits {
284
+ get(billingAccountId: string, billingProfileId: string, options?: CreditsGetOptionalParams): Promise<CreditsGetResponse>;
285
+ }
286
+
287
+ // @public
288
+ export interface CreditsGetOptionalParams extends coreClient.OperationOptions {
289
+ }
290
+
291
+ // @public
292
+ export type CreditsGetResponse = CreditSummary;
293
+
294
+ // @public
295
+ export interface CreditSummary extends Resource {
296
+ readonly balanceSummary?: CreditBalanceSummary;
297
+ readonly billingCurrency?: string;
298
+ readonly creditCurrency?: string;
299
+ readonly eTag?: string;
300
+ readonly expiredCredit?: Amount;
301
+ readonly pendingCreditAdjustments?: Amount;
302
+ readonly pendingEligibleCharges?: Amount;
303
+ readonly reseller?: Reseller;
304
+ }
305
+
306
+ // @public
307
+ export type CultureCode = string;
308
+
309
+ // @public
310
+ export interface CurrentSpend {
311
+ readonly amount?: number;
312
+ readonly unit?: string;
313
+ }
314
+
315
+ // @public
316
+ export type Datagrain = string;
317
+
318
+ // @public
319
+ export interface DownloadProperties {
320
+ readonly downloadUrl?: string;
321
+ readonly validTill?: string;
322
+ }
323
+
324
+ // @public
325
+ export interface ErrorDetails {
326
+ readonly code?: string;
327
+ readonly message?: string;
328
+ }
329
+
330
+ // @public
331
+ export interface ErrorResponse {
332
+ error?: ErrorDetails;
333
+ }
334
+
335
+ // @public
336
+ export interface Events {
337
+ readonly nextLink?: string;
338
+ readonly value?: EventSummary[];
339
+ }
340
+
341
+ // @public
342
+ export interface EventsListByBillingAccountNextOptionalParams extends coreClient.OperationOptions {
343
+ }
344
+
345
+ // @public
346
+ export type EventsListByBillingAccountNextResponse = Events;
347
+
348
+ // @public
349
+ export interface EventsListByBillingAccountOptionalParams extends coreClient.OperationOptions {
350
+ filter?: string;
351
+ }
352
+
353
+ // @public
354
+ export type EventsListByBillingAccountResponse = Events;
355
+
356
+ // @public
357
+ export interface EventsListByBillingProfileNextOptionalParams extends coreClient.OperationOptions {
358
+ }
359
+
360
+ // @public
361
+ export type EventsListByBillingProfileNextResponse = Events;
362
+
363
+ // @public
364
+ export interface EventsListByBillingProfileOptionalParams extends coreClient.OperationOptions {
365
+ }
366
+
367
+ // @public
368
+ export type EventsListByBillingProfileResponse = Events;
369
+
370
+ // @public
371
+ export interface EventsOperations {
372
+ listByBillingAccount(billingAccountId: string, options?: EventsListByBillingAccountOptionalParams): PagedAsyncIterableIterator<EventSummary>;
373
+ listByBillingProfile(billingAccountId: string, billingProfileId: string, startDate: string, endDate: string, options?: EventsListByBillingProfileOptionalParams): PagedAsyncIterableIterator<EventSummary>;
374
+ }
375
+
376
+ // @public
377
+ export interface EventSummary extends ProxyResource {
378
+ readonly adjustments?: Amount;
379
+ readonly adjustmentsInBillingCurrency?: AmountWithExchangeRate;
380
+ readonly billingCurrency?: string;
381
+ readonly billingProfileDisplayName?: string;
382
+ readonly billingProfileId?: string;
383
+ readonly canceledCredit?: Amount;
384
+ readonly charges?: Amount;
385
+ readonly chargesInBillingCurrency?: AmountWithExchangeRate;
386
+ readonly closedBalance?: Amount;
387
+ readonly closedBalanceInBillingCurrency?: AmountWithExchangeRate;
388
+ readonly creditCurrency?: string;
389
+ readonly creditExpired?: Amount;
390
+ readonly creditExpiredInBillingCurrency?: AmountWithExchangeRate;
391
+ readonly description?: string;
392
+ readonly eTagPropertiesETag?: string;
393
+ eventType?: EventType;
394
+ readonly invoiceNumber?: string;
395
+ readonly lotId?: string;
396
+ readonly lotSource?: string;
397
+ readonly newCredit?: Amount;
398
+ readonly newCreditInBillingCurrency?: AmountWithExchangeRate;
399
+ readonly reseller?: Reseller;
400
+ readonly transactionDate?: Date;
401
+ }
402
+
403
+ // @public
404
+ export type EventType = string;
405
+
406
+ // @public
407
+ export interface ForecastSpend {
408
+ readonly amount?: number;
409
+ readonly unit?: string;
410
+ }
411
+
412
+ // @public
413
+ export function getContinuationToken(page: unknown): string | undefined;
414
+
415
+ // @public
416
+ export interface HighCasedErrorDetails {
417
+ readonly code?: string;
418
+ readonly message?: string;
419
+ }
420
+
421
+ // @public
422
+ export interface HighCasedErrorResponse {
423
+ error?: HighCasedErrorDetails;
424
+ }
425
+
426
+ // @public
427
+ export enum KnownBillingFrequency {
428
+ Month = "Month",
429
+ Quarter = "Quarter",
430
+ Year = "Year"
431
+ }
432
+
433
+ // @public
434
+ export enum KnownBudgetOperatorType {
435
+ In = "In"
436
+ }
437
+
438
+ // @public
439
+ export enum KnownCategoryType {
440
+ Cost = "Cost"
441
+ }
442
+
443
+ // @public
444
+ export enum KnownChargeSummaryKind {
445
+ Legacy = "legacy",
446
+ Modern = "modern"
447
+ }
448
+
449
+ // @public
450
+ export enum KnownCultureCode {
451
+ CsCz = "cs-cz",
452
+ DaDk = "da-dk",
453
+ DeDe = "de-de",
454
+ EnGb = "en-gb",
455
+ EnUs = "en-us",
456
+ EsEs = "es-es",
457
+ FrFr = "fr-fr",
458
+ HuHu = "hu-hu",
459
+ ItIt = "it-it",
460
+ JaJp = "ja-jp",
461
+ KoKr = "ko-kr",
462
+ NbNo = "nb-no",
463
+ NlNl = "nl-nl",
464
+ PlPl = "pl-pl",
465
+ PtBr = "pt-br",
466
+ PtPt = "pt-pt",
467
+ RuRu = "ru-ru",
468
+ SvSe = "sv-se",
469
+ TrTr = "tr-tr",
470
+ ZhCn = "zh-cn",
471
+ ZhTw = "zh-tw"
472
+ }
473
+
474
+ // @public
475
+ export enum KnownDatagrain {
476
+ DailyGrain = "daily",
477
+ MonthlyGrain = "monthly"
478
+ }
479
+
480
+ // @public
481
+ export enum KnownEventType {
482
+ NewCredit = "NewCredit",
483
+ PendingAdjustments = "PendingAdjustments",
484
+ PendingCharges = "PendingCharges",
485
+ PendingExpiredCredit = "PendingExpiredCredit",
486
+ PendingNewCredit = "PendingNewCredit",
487
+ SettledCharges = "SettledCharges",
488
+ UnKnown = "UnKnown"
489
+ }
490
+
491
+ // @public
492
+ export enum KnownLookBackPeriod {
493
+ Last07Days = "Last7Days",
494
+ Last30Days = "Last30Days",
495
+ Last60Days = "Last60Days"
496
+ }
497
+
498
+ // @public
499
+ export enum KnownLotSource {
500
+ ConsumptionCommitment = "ConsumptionCommitment",
501
+ PromotionalCredit = "PromotionalCredit",
502
+ PurchasedCredit = "PurchasedCredit"
503
+ }
504
+
505
+ // @public
506
+ export enum KnownMetrictype {
507
+ ActualCostMetricType = "actualcost",
508
+ AmortizedCostMetricType = "amortizedcost",
509
+ UsageMetricType = "usage"
510
+ }
511
+
512
+ // @public
513
+ export enum KnownOperatorType {
514
+ EqualTo = "EqualTo",
515
+ GreaterThan = "GreaterThan",
516
+ GreaterThanOrEqualTo = "GreaterThanOrEqualTo"
517
+ }
518
+
519
+ // @public
520
+ export enum KnownPricingModelType {
521
+ OnDemand = "On Demand",
522
+ Reservation = "Reservation",
523
+ Spot = "Spot"
524
+ }
525
+
526
+ // @public
527
+ export enum KnownReservationRecommendationKind {
528
+ Legacy = "legacy",
529
+ Modern = "modern"
530
+ }
531
+
532
+ // @public
533
+ export enum KnownScope {
534
+ Shared = "Shared",
535
+ Single = "Single"
536
+ }
537
+
538
+ // @public
539
+ export enum KnownStatus {
540
+ Active = "Active",
541
+ Canceled = "Canceled",
542
+ Complete = "Complete",
543
+ Expired = "Expired",
544
+ Inactive = "Inactive",
545
+ None = "None"
546
+ }
547
+
548
+ // @public
549
+ export enum KnownTerm {
550
+ P1Y = "P1Y",
551
+ P3Y = "P3Y"
552
+ }
553
+
554
+ // @public
555
+ export enum KnownThresholdType {
556
+ Actual = "Actual",
557
+ Forecasted = "Forecasted"
558
+ }
559
+
560
+ // @public
561
+ export enum KnownTimeGrainType {
562
+ Annually = "Annually",
563
+ BillingAnnual = "BillingAnnual",
564
+ BillingMonth = "BillingMonth",
565
+ BillingQuarter = "BillingQuarter",
566
+ Monthly = "Monthly",
567
+ Quarterly = "Quarterly"
568
+ }
569
+
570
+ // @public
571
+ export enum KnownUsageDetailsKind {
572
+ Legacy = "legacy",
573
+ Modern = "modern"
574
+ }
575
+
576
+ // @public
577
+ export interface LegacyChargeSummary extends ChargeSummary {
578
+ readonly azureCharges?: number;
579
+ readonly billingPeriodId?: string;
580
+ readonly chargesBilledSeparately?: number;
581
+ readonly currency?: string;
582
+ kind: "legacy";
583
+ readonly marketplaceCharges?: number;
584
+ readonly usageEnd?: string;
585
+ readonly usageStart?: string;
586
+ }
587
+
588
+ // @public
589
+ export interface LegacyReservationRecommendation extends ReservationRecommendation {
590
+ readonly costWithNoReservedInstances?: number;
591
+ readonly firstUsageDate?: Date;
592
+ readonly instanceFlexibilityGroup?: string;
593
+ readonly instanceFlexibilityRatio?: number;
594
+ kind: "legacy";
595
+ readonly lookBackPeriod?: string;
596
+ readonly meterId?: string;
597
+ readonly netSavings?: number;
598
+ readonly normalizedSize?: string;
599
+ readonly recommendedQuantity?: number;
600
+ readonly recommendedQuantityNormalized?: number;
601
+ readonly resourceType?: string;
602
+ scope: string;
603
+ readonly skuProperties?: SkuProperty[];
604
+ readonly term?: string;
605
+ readonly totalCostWithReservedInstances?: number;
606
+ }
607
+
608
+ // @public
609
+ export interface LegacyReservationRecommendationProperties {
610
+ readonly costWithNoReservedInstances?: number;
611
+ readonly firstUsageDate?: Date;
612
+ readonly instanceFlexibilityGroup?: string;
613
+ readonly instanceFlexibilityRatio?: number;
614
+ readonly lookBackPeriod?: string;
615
+ readonly meterId?: string;
616
+ readonly netSavings?: number;
617
+ readonly normalizedSize?: string;
618
+ readonly recommendedQuantity?: number;
619
+ readonly recommendedQuantityNormalized?: number;
620
+ readonly resourceType?: string;
621
+ scope: "Single" | "Shared";
622
+ readonly skuProperties?: SkuProperty[];
623
+ readonly term?: string;
624
+ readonly totalCostWithReservedInstances?: number;
625
+ }
626
+
627
+ // @public (undocumented)
628
+ export type LegacyReservationRecommendationPropertiesUnion = LegacyReservationRecommendationProperties | LegacySingleScopeReservationRecommendationProperties | LegacySharedScopeReservationRecommendationProperties;
629
+
630
+ // @public
631
+ export interface LegacyReservationTransaction extends ReservationTransaction {
632
+ }
633
+
634
+ // @public
635
+ export interface LegacySharedScopeReservationRecommendationProperties extends LegacyReservationRecommendationProperties {
636
+ scope: "Shared";
637
+ }
638
+
639
+ // @public
640
+ export interface LegacySingleScopeReservationRecommendationProperties extends LegacyReservationRecommendationProperties {
641
+ scope: "Single";
642
+ readonly subscriptionId?: string;
643
+ }
644
+
645
+ // @public
646
+ export interface LegacyUsageDetail extends UsageDetail {
647
+ readonly accountName?: string;
648
+ readonly accountOwnerId?: string;
649
+ readonly additionalInfo?: string;
650
+ readonly billingAccountId?: string;
651
+ readonly billingAccountName?: string;
652
+ readonly billingCurrency?: string;
653
+ readonly billingPeriodEndDate?: Date;
654
+ readonly billingPeriodStartDate?: Date;
655
+ readonly billingProfileId?: string;
656
+ readonly billingProfileName?: string;
657
+ readonly chargeType?: string;
658
+ readonly consumedService?: string;
659
+ readonly cost?: number;
660
+ readonly costCenter?: string;
661
+ readonly date?: Date;
662
+ readonly effectivePrice?: number;
663
+ readonly frequency?: string;
664
+ readonly invoiceSection?: string;
665
+ readonly isAzureCreditEligible?: boolean;
666
+ kind: "legacy";
667
+ readonly meterDetails?: MeterDetailsResponse;
668
+ readonly meterId?: string;
669
+ readonly offerId?: string;
670
+ readonly partNumber?: string;
671
+ readonly payGPrice?: number;
672
+ readonly planName?: string;
673
+ readonly pricingModel?: PricingModelType;
674
+ readonly product?: string;
675
+ readonly productOrderId?: string;
676
+ readonly productOrderName?: string;
677
+ readonly publisherName?: string;
678
+ readonly publisherType?: string;
679
+ readonly quantity?: number;
680
+ readonly reservationId?: string;
681
+ readonly reservationName?: string;
682
+ readonly resourceGroup?: string;
683
+ readonly resourceId?: string;
684
+ readonly resourceLocation?: string;
685
+ readonly resourceName?: string;
686
+ readonly serviceInfo1?: string;
687
+ readonly serviceInfo2?: string;
688
+ readonly subscriptionId?: string;
689
+ readonly subscriptionName?: string;
690
+ readonly term?: string;
691
+ readonly unitPrice?: number;
692
+ }
693
+
694
+ // @public
695
+ export type LookBackPeriod = string;
696
+
697
+ // @public
698
+ export interface Lots {
699
+ readonly nextLink?: string;
700
+ readonly value?: LotSummary[];
701
+ }
702
+
703
+ // @public
704
+ export interface LotsListByBillingAccountNextOptionalParams extends coreClient.OperationOptions {
705
+ }
706
+
707
+ // @public
708
+ export type LotsListByBillingAccountNextResponse = Lots;
709
+
710
+ // @public
711
+ export interface LotsListByBillingAccountOptionalParams extends coreClient.OperationOptions {
712
+ filter?: string;
713
+ }
714
+
715
+ // @public
716
+ export type LotsListByBillingAccountResponse = Lots;
717
+
718
+ // @public
719
+ export interface LotsListByBillingProfileNextOptionalParams extends coreClient.OperationOptions {
720
+ }
721
+
722
+ // @public
723
+ export type LotsListByBillingProfileNextResponse = Lots;
724
+
725
+ // @public
726
+ export interface LotsListByBillingProfileOptionalParams extends coreClient.OperationOptions {
727
+ }
728
+
729
+ // @public
730
+ export type LotsListByBillingProfileResponse = Lots;
731
+
732
+ // @public
733
+ export interface LotsOperations {
734
+ listByBillingAccount(billingAccountId: string, options?: LotsListByBillingAccountOptionalParams): PagedAsyncIterableIterator<LotSummary>;
735
+ listByBillingProfile(billingAccountId: string, billingProfileId: string, options?: LotsListByBillingProfileOptionalParams): PagedAsyncIterableIterator<LotSummary>;
736
+ }
737
+
738
+ // @public
739
+ export type LotSource = string;
740
+
741
+ // @public
742
+ export interface LotSummary extends ProxyResource {
743
+ readonly billingCurrency?: string;
744
+ readonly closedBalance?: Amount;
745
+ readonly closedBalanceInBillingCurrency?: AmountWithExchangeRate;
746
+ readonly creditCurrency?: string;
747
+ readonly eTagPropertiesETag?: string;
748
+ readonly expirationDate?: Date;
749
+ readonly originalAmount?: Amount;
750
+ readonly originalAmountInBillingCurrency?: AmountWithExchangeRate;
751
+ readonly poNumber?: string;
752
+ readonly purchasedDate?: Date;
753
+ readonly reseller?: Reseller;
754
+ readonly source?: LotSource;
755
+ readonly startDate?: Date;
756
+ readonly status?: Status;
757
+ }
758
+
759
+ // @public
760
+ export interface ManagementGroupAggregatedCostResult extends Resource {
761
+ readonly azureCharges?: number;
762
+ readonly billingPeriodId?: string;
763
+ readonly chargesBilledSeparately?: number;
764
+ children?: ManagementGroupAggregatedCostResult[];
765
+ readonly currency?: string;
766
+ excludedSubscriptions?: string[];
767
+ includedSubscriptions?: string[];
768
+ readonly marketplaceCharges?: number;
769
+ readonly usageEnd?: Date;
770
+ readonly usageStart?: Date;
771
+ }
772
+
773
+ // @public
774
+ export interface Marketplace extends Resource {
775
+ readonly accountName?: string;
776
+ readonly additionalInfo?: string;
777
+ readonly additionalProperties?: string;
778
+ readonly billingPeriodId?: string;
779
+ readonly consumedQuantity?: number;
780
+ readonly consumedService?: string;
781
+ readonly costCenter?: string;
782
+ readonly currency?: string;
783
+ readonly departmentName?: string;
784
+ readonly instanceId?: string;
785
+ readonly instanceName?: string;
786
+ readonly isEstimated?: boolean;
787
+ readonly isRecurringCharge?: boolean;
788
+ readonly meterId?: string;
789
+ readonly offerName?: string;
790
+ readonly orderNumber?: string;
791
+ readonly planName?: string;
792
+ readonly pretaxCost?: number;
793
+ readonly publisherName?: string;
794
+ readonly resourceGroup?: string;
795
+ readonly resourceRate?: number;
796
+ readonly subscriptionGuid?: string;
797
+ readonly subscriptionName?: string;
798
+ readonly unitOfMeasure?: string;
799
+ readonly usageEnd?: Date;
800
+ readonly usageStart?: Date;
801
+ }
802
+
803
+ // @public
804
+ export interface Marketplaces {
805
+ list(scope: string, options?: MarketplacesListOptionalParams): PagedAsyncIterableIterator<Marketplace>;
806
+ }
807
+
808
+ // @public
809
+ export interface MarketplacesListNextOptionalParams extends coreClient.OperationOptions {
810
+ }
811
+
812
+ // @public
813
+ export type MarketplacesListNextResponse = MarketplacesListResult;
814
+
815
+ // @public
816
+ export interface MarketplacesListOptionalParams extends coreClient.OperationOptions {
817
+ filter?: string;
818
+ skiptoken?: string;
819
+ top?: number;
820
+ }
821
+
822
+ // @public
823
+ export type MarketplacesListResponse = MarketplacesListResult;
824
+
825
+ // @public
826
+ export interface MarketplacesListResult {
827
+ readonly nextLink?: string;
828
+ readonly value?: Marketplace[];
829
+ }
830
+
831
+ // @public
832
+ export interface MeterDetails {
833
+ readonly meterCategory?: string;
834
+ readonly meterLocation?: string;
835
+ readonly meterName?: string;
836
+ readonly meterSubCategory?: string;
837
+ readonly pretaxStandardRate?: number;
838
+ readonly serviceName?: string;
839
+ readonly serviceTier?: string;
840
+ readonly totalIncludedQuantity?: number;
841
+ readonly unit?: string;
842
+ }
843
+
844
+ // @public
845
+ export interface MeterDetailsResponse {
846
+ readonly meterCategory?: string;
847
+ readonly meterName?: string;
848
+ readonly meterSubCategory?: string;
849
+ readonly serviceFamily?: string;
850
+ readonly unitOfMeasure?: string;
851
+ }
852
+
853
+ // @public
854
+ export type Metrictype = string;
855
+
856
+ // @public
857
+ export interface ModernChargeSummary extends ChargeSummary {
858
+ readonly azureCharges?: Amount;
859
+ readonly billingAccountId?: string;
860
+ readonly billingPeriodId?: string;
861
+ readonly billingProfileId?: string;
862
+ readonly chargesBilledSeparately?: Amount;
863
+ readonly customerId?: string;
864
+ readonly invoiceSectionId?: string;
865
+ readonly isInvoiced?: boolean;
866
+ kind: "modern";
867
+ readonly marketplaceCharges?: Amount;
868
+ readonly usageEnd?: string;
869
+ readonly usageStart?: string;
870
+ }
871
+
872
+ // @public
873
+ export interface ModernReservationRecommendation extends ReservationRecommendation {
874
+ readonly costWithNoReservedInstances?: Amount;
875
+ readonly firstUsageDate?: Date;
876
+ readonly instanceFlexibilityGroup?: string;
877
+ readonly instanceFlexibilityRatio?: number;
878
+ kind: "modern";
879
+ readonly locationPropertiesLocation?: string;
880
+ readonly lookBackPeriod?: number;
881
+ readonly meterId?: string;
882
+ readonly netSavings?: Amount;
883
+ readonly normalizedSize?: string;
884
+ readonly recommendedQuantity?: number;
885
+ readonly recommendedQuantityNormalized?: number;
886
+ readonly scope?: string;
887
+ readonly skuName?: string;
888
+ readonly skuProperties?: SkuProperty[];
889
+ readonly term?: string;
890
+ readonly totalCostWithReservedInstances?: Amount;
891
+ }
892
+
893
+ // @public
894
+ export interface ModernReservationTransaction extends ReservationTransactionResource {
895
+ readonly amount?: number;
896
+ readonly armSkuName?: string;
897
+ readonly billingFrequency?: string;
898
+ readonly billingProfileId?: string;
899
+ readonly billingProfileName?: string;
900
+ readonly currency?: string;
901
+ readonly description?: string;
902
+ readonly eventDate?: Date;
903
+ readonly eventType?: string;
904
+ readonly invoice?: string;
905
+ readonly invoiceId?: string;
906
+ readonly invoiceSectionId?: string;
907
+ readonly invoiceSectionName?: string;
908
+ readonly purchasingSubscriptionGuid?: string;
909
+ readonly purchasingSubscriptionName?: string;
910
+ readonly quantity?: number;
911
+ readonly region?: string;
912
+ readonly reservationOrderId?: string;
913
+ readonly reservationOrderName?: string;
914
+ readonly term?: string;
915
+ }
916
+
917
+ // @public
918
+ export interface ModernReservationTransactionsListResult {
919
+ readonly nextLink?: string;
920
+ readonly value?: ModernReservationTransaction[];
921
+ }
922
+
923
+ // @public
924
+ export interface ModernUsageDetail extends UsageDetail {
925
+ readonly additionalInfo?: string;
926
+ readonly benefitId?: string;
927
+ readonly benefitName?: string;
928
+ readonly billingAccountId?: string;
929
+ readonly billingAccountName?: string;
930
+ readonly billingCurrencyCode?: string;
931
+ readonly billingPeriodEndDate?: Date;
932
+ readonly billingPeriodStartDate?: Date;
933
+ readonly billingProfileId?: string;
934
+ readonly billingProfileName?: string;
935
+ readonly chargeType?: string;
936
+ readonly consumedService?: string;
937
+ readonly costAllocationRuleName?: string;
938
+ readonly costCenter?: string;
939
+ readonly costInBillingCurrency?: number;
940
+ readonly costInPricingCurrency?: number;
941
+ readonly costInUSD?: number;
942
+ readonly customerName?: string;
943
+ readonly customerTenantId?: string;
944
+ readonly date?: Date;
945
+ readonly effectivePrice?: number;
946
+ readonly exchangeRate?: string;
947
+ readonly exchangeRateDate?: Date;
948
+ readonly exchangeRatePricingToBilling?: number;
949
+ readonly frequency?: string;
950
+ readonly instanceName?: string;
951
+ readonly invoiceId?: string;
952
+ readonly invoiceSectionId?: string;
953
+ readonly invoiceSectionName?: string;
954
+ readonly isAzureCreditEligible?: boolean;
955
+ kind: "modern";
956
+ readonly marketPrice?: number;
957
+ readonly meterCategory?: string;
958
+ readonly meterId?: string;
959
+ readonly meterName?: string;
960
+ readonly meterRegion?: string;
961
+ readonly meterSubCategory?: string;
962
+ readonly partnerEarnedCreditApplied?: string;
963
+ readonly partnerEarnedCreditRate?: number;
964
+ readonly partnerName?: string;
965
+ readonly partnerTenantId?: string;
966
+ readonly paygCostInBillingCurrency?: number;
967
+ readonly paygCostInUSD?: number;
968
+ readonly payGPrice?: number;
969
+ readonly previousInvoiceId?: string;
970
+ readonly pricingCurrencyCode?: string;
971
+ readonly pricingModel?: PricingModelType;
972
+ readonly product?: string;
973
+ readonly productIdentifier?: string;
974
+ readonly productOrderId?: string;
975
+ readonly productOrderName?: string;
976
+ readonly provider?: string;
977
+ readonly publisherId?: string;
978
+ readonly publisherName?: string;
979
+ readonly publisherType?: string;
980
+ readonly quantity?: number;
981
+ readonly resellerMpnId?: string;
982
+ readonly resellerName?: string;
983
+ readonly reservationId?: string;
984
+ readonly reservationName?: string;
985
+ readonly resourceGroup?: string;
986
+ readonly resourceLocation?: string;
987
+ readonly resourceLocationNormalized?: string;
988
+ readonly serviceFamily?: string;
989
+ readonly serviceInfo1?: string;
990
+ readonly serviceInfo2?: string;
991
+ readonly servicePeriodEndDate?: Date;
992
+ readonly servicePeriodStartDate?: Date;
993
+ readonly subscriptionGuid?: string;
994
+ readonly subscriptionName?: string;
995
+ readonly term?: string;
996
+ readonly unitOfMeasure?: string;
997
+ readonly unitPrice?: number;
998
+ }
999
+
1000
+ // @public
1001
+ export interface Notification {
1002
+ contactEmails: string[];
1003
+ contactGroups?: string[];
1004
+ contactRoles?: string[];
1005
+ enabled: boolean;
1006
+ locale?: CultureCode;
1007
+ operator: OperatorType;
1008
+ threshold: number;
1009
+ thresholdType?: ThresholdType;
1010
+ }
1011
+
1012
+ // @public
1013
+ export interface Operation {
1014
+ display?: OperationDisplay;
1015
+ readonly id?: string;
1016
+ readonly name?: string;
1017
+ }
1018
+
1019
+ // @public
1020
+ export interface OperationDisplay {
1021
+ readonly description?: string;
1022
+ readonly operation?: string;
1023
+ readonly provider?: string;
1024
+ readonly resource?: string;
1025
+ }
1026
+
1027
+ // @public
1028
+ export interface OperationListResult {
1029
+ readonly nextLink?: string;
1030
+ readonly value?: Operation[];
1031
+ }
1032
+
1033
+ // @public
1034
+ export interface Operations {
1035
+ list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
1036
+ }
1037
+
1038
+ // @public
1039
+ export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
1040
+ }
1041
+
1042
+ // @public
1043
+ export type OperationsListNextResponse = OperationListResult;
1044
+
1045
+ // @public
1046
+ export interface OperationsListOptionalParams extends coreClient.OperationOptions {
1047
+ }
1048
+
1049
+ // @public
1050
+ export type OperationsListResponse = OperationListResult;
1051
+
1052
+ // @public
1053
+ export type OperatorType = string;
1054
+
1055
+ // @public
1056
+ export interface PriceSheet {
1057
+ get(options?: PriceSheetGetOptionalParams): Promise<PriceSheetGetResponse>;
1058
+ getByBillingPeriod(billingPeriodName: string, options?: PriceSheetGetByBillingPeriodOptionalParams): Promise<PriceSheetGetByBillingPeriodResponse>;
1059
+ }
1060
+
1061
+ // @public
1062
+ export interface PriceSheetGetByBillingPeriodOptionalParams extends coreClient.OperationOptions {
1063
+ expand?: string;
1064
+ skiptoken?: string;
1065
+ top?: number;
1066
+ }
1067
+
1068
+ // @public
1069
+ export type PriceSheetGetByBillingPeriodResponse = PriceSheetResult;
1070
+
1071
+ // @public
1072
+ export interface PriceSheetGetOptionalParams extends coreClient.OperationOptions {
1073
+ expand?: string;
1074
+ skiptoken?: string;
1075
+ top?: number;
1076
+ }
1077
+
1078
+ // @public
1079
+ export type PriceSheetGetResponse = PriceSheetResult;
1080
+
1081
+ // @public
1082
+ export interface PriceSheetProperties {
1083
+ readonly billingPeriodId?: string;
1084
+ readonly currencyCode?: string;
1085
+ readonly includedQuantity?: number;
1086
+ readonly meterDetails?: MeterDetails;
1087
+ readonly meterId?: string;
1088
+ readonly offerId?: string;
1089
+ readonly partNumber?: string;
1090
+ readonly unitOfMeasure?: string;
1091
+ readonly unitPrice?: number;
1092
+ }
1093
+
1094
+ // @public
1095
+ export interface PriceSheetResult extends Resource {
1096
+ readonly download?: MeterDetails;
1097
+ readonly nextLink?: string;
1098
+ readonly pricesheets?: PriceSheetProperties[];
1099
+ }
1100
+
1101
+ // @public
1102
+ export type PricingModelType = string;
1103
+
1104
+ // @public
1105
+ export interface ProxyResource {
1106
+ eTag?: string;
1107
+ readonly id?: string;
1108
+ readonly name?: string;
1109
+ readonly type?: string;
1110
+ }
1111
+
1112
+ // @public
1113
+ export interface Reseller {
1114
+ readonly resellerDescription?: string;
1115
+ readonly resellerId?: string;
1116
+ }
1117
+
1118
+ // @public
1119
+ export interface ReservationDetail extends Resource {
1120
+ readonly instanceFlexibilityGroup?: string;
1121
+ readonly instanceFlexibilityRatio?: string;
1122
+ readonly instanceId?: string;
1123
+ readonly kind?: string;
1124
+ readonly reservationId?: string;
1125
+ readonly reservationOrderId?: string;
1126
+ readonly reservedHours?: number;
1127
+ readonly skuName?: string;
1128
+ readonly totalReservedQuantity?: number;
1129
+ readonly usageDate?: Date;
1130
+ readonly usedHours?: number;
1131
+ }
1132
+
1133
+ // @public
1134
+ export interface ReservationDetailsListResult {
1135
+ readonly nextLink?: string;
1136
+ readonly value?: ReservationDetail[];
1137
+ }
1138
+
1139
+ // @public
1140
+ export interface ReservationRecommendation extends Resource, ResourceAttributes {
1141
+ kind: ReservationRecommendationKind;
1142
+ }
1143
+
1144
+ // @public
1145
+ export interface ReservationRecommendationDetails {
1146
+ get(scope: string, region: string, term: Term, lookBackPeriod: LookBackPeriod, product: string, options?: ReservationRecommendationDetailsGetOptionalParams): Promise<ReservationRecommendationDetailsGetResponse>;
1147
+ }
1148
+
1149
+ // @public
1150
+ export interface ReservationRecommendationDetailsCalculatedSavingsProperties {
1151
+ readonly onDemandCost?: number;
1152
+ readonly overageCost?: number;
1153
+ readonly quantity?: number;
1154
+ readonly reservationCost?: number;
1155
+ reservedUnitCount?: number;
1156
+ readonly savings?: number;
1157
+ readonly totalReservationCost?: number;
1158
+ }
1159
+
1160
+ // @public
1161
+ export interface ReservationRecommendationDetailsGetOptionalParams extends coreClient.OperationOptions {
1162
+ }
1163
+
1164
+ // @public
1165
+ export type ReservationRecommendationDetailsGetResponse = ReservationRecommendationDetailsModel;
1166
+
1167
+ // @public
1168
+ export interface ReservationRecommendationDetailsModel extends Resource {
1169
+ readonly currency?: string;
1170
+ location?: string;
1171
+ readonly resource?: ReservationRecommendationDetailsResourceProperties;
1172
+ readonly resourceGroup?: string;
1173
+ readonly savings?: ReservationRecommendationDetailsSavingsProperties;
1174
+ readonly scope?: string;
1175
+ sku?: string;
1176
+ readonly usage?: ReservationRecommendationDetailsUsageProperties;
1177
+ }
1178
+
1179
+ // @public
1180
+ export interface ReservationRecommendationDetailsResourceProperties {
1181
+ readonly appliedScopes?: string[];
1182
+ readonly onDemandRate?: number;
1183
+ readonly product?: string;
1184
+ readonly region?: string;
1185
+ readonly reservationRate?: number;
1186
+ readonly resourceType?: string;
1187
+ }
1188
+
1189
+ // @public
1190
+ export interface ReservationRecommendationDetailsSavingsProperties {
1191
+ calculatedSavings?: ReservationRecommendationDetailsCalculatedSavingsProperties[];
1192
+ readonly lookBackPeriod?: number;
1193
+ readonly recommendedQuantity?: number;
1194
+ readonly reservationOrderTerm?: string;
1195
+ readonly savingsType?: string;
1196
+ readonly unitOfMeasure?: string;
1197
+ }
1198
+
1199
+ // @public
1200
+ export interface ReservationRecommendationDetailsUsageProperties {
1201
+ readonly firstConsumptionDate?: string;
1202
+ readonly lastConsumptionDate?: string;
1203
+ readonly lookBackUnitType?: string;
1204
+ readonly usageData?: number[];
1205
+ readonly usageGrain?: string;
1206
+ }
1207
+
1208
+ // @public
1209
+ export type ReservationRecommendationKind = string;
1210
+
1211
+ // @public
1212
+ export interface ReservationRecommendations {
1213
+ list(scope: string, options?: ReservationRecommendationsListOptionalParams): PagedAsyncIterableIterator<ReservationRecommendationUnion>;
1214
+ }
1215
+
1216
+ // @public
1217
+ export interface ReservationRecommendationsListNextOptionalParams extends coreClient.OperationOptions {
1218
+ }
1219
+
1220
+ // @public
1221
+ export type ReservationRecommendationsListNextResponse = ReservationRecommendationsListResult;
1222
+
1223
+ // @public
1224
+ export interface ReservationRecommendationsListOptionalParams extends coreClient.OperationOptions {
1225
+ filter?: string;
1226
+ }
1227
+
1228
+ // @public
1229
+ export type ReservationRecommendationsListResponse = ReservationRecommendationsListResult;
1230
+
1231
+ // @public
1232
+ export interface ReservationRecommendationsListResult {
1233
+ readonly nextLink?: string;
1234
+ readonly previousLink?: string;
1235
+ readonly value?: ReservationRecommendationUnion[];
1236
+ }
1237
+
1238
+ // @public (undocumented)
1239
+ export type ReservationRecommendationUnion = ReservationRecommendation | LegacyReservationRecommendation | ModernReservationRecommendation;
1240
+
1241
+ // @public
1242
+ export interface ReservationsDetails {
1243
+ list(scope: string, options?: ReservationsDetailsListOptionalParams): PagedAsyncIterableIterator<ReservationDetail>;
1244
+ listByReservationOrder(reservationOrderId: string, filter: string, options?: ReservationsDetailsListByReservationOrderOptionalParams): PagedAsyncIterableIterator<ReservationDetail>;
1245
+ listByReservationOrderAndReservation(reservationOrderId: string, reservationId: string, filter: string, options?: ReservationsDetailsListByReservationOrderAndReservationOptionalParams): PagedAsyncIterableIterator<ReservationDetail>;
1246
+ }
1247
+
1248
+ // @public
1249
+ export interface ReservationsDetailsListByReservationOrderAndReservationNextOptionalParams extends coreClient.OperationOptions {
1250
+ }
1251
+
1252
+ // @public
1253
+ export type ReservationsDetailsListByReservationOrderAndReservationNextResponse = ReservationDetailsListResult;
1254
+
1255
+ // @public
1256
+ export interface ReservationsDetailsListByReservationOrderAndReservationOptionalParams extends coreClient.OperationOptions {
1257
+ }
1258
+
1259
+ // @public
1260
+ export type ReservationsDetailsListByReservationOrderAndReservationResponse = ReservationDetailsListResult;
1261
+
1262
+ // @public
1263
+ export interface ReservationsDetailsListByReservationOrderNextOptionalParams extends coreClient.OperationOptions {
1264
+ }
1265
+
1266
+ // @public
1267
+ export type ReservationsDetailsListByReservationOrderNextResponse = ReservationDetailsListResult;
1268
+
1269
+ // @public
1270
+ export interface ReservationsDetailsListByReservationOrderOptionalParams extends coreClient.OperationOptions {
1271
+ }
1272
+
1273
+ // @public
1274
+ export type ReservationsDetailsListByReservationOrderResponse = ReservationDetailsListResult;
1275
+
1276
+ // @public
1277
+ export interface ReservationsDetailsListNextOptionalParams extends coreClient.OperationOptions {
1278
+ }
1279
+
1280
+ // @public
1281
+ export type ReservationsDetailsListNextResponse = ReservationDetailsListResult;
1282
+
1283
+ // @public
1284
+ export interface ReservationsDetailsListOptionalParams extends coreClient.OperationOptions {
1285
+ endDate?: string;
1286
+ filter?: string;
1287
+ reservationId?: string;
1288
+ reservationOrderId?: string;
1289
+ startDate?: string;
1290
+ }
1291
+
1292
+ // @public
1293
+ export type ReservationsDetailsListResponse = ReservationDetailsListResult;
1294
+
1295
+ // @public
1296
+ export interface ReservationsSummaries {
1297
+ list(scope: string, grain: Datagrain, options?: ReservationsSummariesListOptionalParams): PagedAsyncIterableIterator<ReservationSummary>;
1298
+ listByReservationOrder(reservationOrderId: string, grain: Datagrain, options?: ReservationsSummariesListByReservationOrderOptionalParams): PagedAsyncIterableIterator<ReservationSummary>;
1299
+ listByReservationOrderAndReservation(reservationOrderId: string, reservationId: string, grain: Datagrain, options?: ReservationsSummariesListByReservationOrderAndReservationOptionalParams): PagedAsyncIterableIterator<ReservationSummary>;
1300
+ }
1301
+
1302
+ // @public
1303
+ export interface ReservationsSummariesListByReservationOrderAndReservationNextOptionalParams extends coreClient.OperationOptions {
1304
+ }
1305
+
1306
+ // @public
1307
+ export type ReservationsSummariesListByReservationOrderAndReservationNextResponse = ReservationSummariesListResult;
1308
+
1309
+ // @public
1310
+ export interface ReservationsSummariesListByReservationOrderAndReservationOptionalParams extends coreClient.OperationOptions {
1311
+ filter?: string;
1312
+ }
1313
+
1314
+ // @public
1315
+ export type ReservationsSummariesListByReservationOrderAndReservationResponse = ReservationSummariesListResult;
1316
+
1317
+ // @public
1318
+ export interface ReservationsSummariesListByReservationOrderNextOptionalParams extends coreClient.OperationOptions {
1319
+ }
1320
+
1321
+ // @public
1322
+ export type ReservationsSummariesListByReservationOrderNextResponse = ReservationSummariesListResult;
1323
+
1324
+ // @public
1325
+ export interface ReservationsSummariesListByReservationOrderOptionalParams extends coreClient.OperationOptions {
1326
+ filter?: string;
1327
+ }
1328
+
1329
+ // @public
1330
+ export type ReservationsSummariesListByReservationOrderResponse = ReservationSummariesListResult;
1331
+
1332
+ // @public
1333
+ export interface ReservationsSummariesListNextOptionalParams extends coreClient.OperationOptions {
1334
+ }
1335
+
1336
+ // @public
1337
+ export type ReservationsSummariesListNextResponse = ReservationSummariesListResult;
1338
+
1339
+ // @public
1340
+ export interface ReservationsSummariesListOptionalParams extends coreClient.OperationOptions {
1341
+ endDate?: string;
1342
+ filter?: string;
1343
+ reservationId?: string;
1344
+ reservationOrderId?: string;
1345
+ startDate?: string;
1346
+ }
1347
+
1348
+ // @public
1349
+ export type ReservationsSummariesListResponse = ReservationSummariesListResult;
1350
+
1351
+ // @public
1352
+ export interface ReservationSummariesListResult {
1353
+ readonly nextLink?: string;
1354
+ readonly value?: ReservationSummary[];
1355
+ }
1356
+
1357
+ // @public
1358
+ export interface ReservationSummary extends Resource {
1359
+ readonly avgUtilizationPercentage?: number;
1360
+ readonly kind?: string;
1361
+ readonly maxUtilizationPercentage?: number;
1362
+ readonly minUtilizationPercentage?: number;
1363
+ readonly purchasedQuantity?: number;
1364
+ readonly remainingQuantity?: number;
1365
+ readonly reservationId?: string;
1366
+ readonly reservationOrderId?: string;
1367
+ readonly reservedHours?: number;
1368
+ readonly skuName?: string;
1369
+ readonly totalReservedQuantity?: number;
1370
+ readonly usageDate?: Date;
1371
+ readonly usedHours?: number;
1372
+ readonly usedQuantity?: number;
1373
+ readonly utilizedPercentage?: number;
1374
+ }
1375
+
1376
+ // @public
1377
+ export interface ReservationTransaction extends ReservationTransactionResource {
1378
+ readonly accountName?: string;
1379
+ readonly accountOwnerEmail?: string;
1380
+ readonly amount?: number;
1381
+ readonly armSkuName?: string;
1382
+ readonly billingFrequency?: string;
1383
+ readonly billingMonth?: number;
1384
+ readonly costCenter?: string;
1385
+ readonly currency?: string;
1386
+ readonly currentEnrollment?: string;
1387
+ readonly departmentName?: string;
1388
+ readonly description?: string;
1389
+ readonly eventDate?: Date;
1390
+ readonly eventType?: string;
1391
+ readonly monetaryCommitment?: number;
1392
+ readonly overage?: number;
1393
+ readonly purchasingEnrollment?: string;
1394
+ readonly purchasingSubscriptionGuid?: string;
1395
+ readonly purchasingSubscriptionName?: string;
1396
+ readonly quantity?: number;
1397
+ readonly region?: string;
1398
+ readonly reservationOrderId?: string;
1399
+ readonly reservationOrderName?: string;
1400
+ readonly term?: string;
1401
+ }
1402
+
1403
+ // @public
1404
+ export interface ReservationTransactionResource {
1405
+ readonly id?: string;
1406
+ readonly name?: string;
1407
+ readonly tags?: string[];
1408
+ readonly type?: string;
1409
+ }
1410
+
1411
+ // @public
1412
+ export interface ReservationTransactions {
1413
+ list(billingAccountId: string, options?: ReservationTransactionsListOptionalParams): PagedAsyncIterableIterator<ReservationTransaction>;
1414
+ listByBillingProfile(billingAccountId: string, billingProfileId: string, options?: ReservationTransactionsListByBillingProfileOptionalParams): PagedAsyncIterableIterator<ModernReservationTransaction>;
1415
+ }
1416
+
1417
+ // @public
1418
+ export interface ReservationTransactionsListByBillingProfileNextOptionalParams extends coreClient.OperationOptions {
1419
+ }
1420
+
1421
+ // @public
1422
+ export type ReservationTransactionsListByBillingProfileNextResponse = ModernReservationTransactionsListResult;
1423
+
1424
+ // @public
1425
+ export interface ReservationTransactionsListByBillingProfileOptionalParams extends coreClient.OperationOptions {
1426
+ filter?: string;
1427
+ }
1428
+
1429
+ // @public
1430
+ export type ReservationTransactionsListByBillingProfileResponse = ModernReservationTransactionsListResult;
1431
+
1432
+ // @public
1433
+ export interface ReservationTransactionsListNextOptionalParams extends coreClient.OperationOptions {
1434
+ }
1435
+
1436
+ // @public
1437
+ export type ReservationTransactionsListNextResponse = ReservationTransactionsListResult;
1438
+
1439
+ // @public
1440
+ export interface ReservationTransactionsListOptionalParams extends coreClient.OperationOptions {
1441
+ filter?: string;
1442
+ }
1443
+
1444
+ // @public
1445
+ export type ReservationTransactionsListResponse = ReservationTransactionsListResult;
1446
+
1447
+ // @public
1448
+ export interface ReservationTransactionsListResult {
1449
+ readonly nextLink?: string;
1450
+ readonly value?: ReservationTransaction[];
1451
+ }
1452
+
1453
+ // @public
1454
+ export interface Resource {
1455
+ readonly etag?: string;
1456
+ readonly id?: string;
1457
+ readonly name?: string;
1458
+ readonly tags?: {
1459
+ [propertyName: string]: string;
1460
+ };
1461
+ readonly type?: string;
1462
+ }
1463
+
1464
+ // @public
1465
+ export interface ResourceAttributes {
1466
+ readonly location?: string;
1467
+ readonly sku?: string;
1468
+ }
1469
+
1470
+ // @public
1471
+ export type Scope = string;
1472
+
1473
+ // @public
1474
+ export interface SkuProperty {
1475
+ readonly name?: string;
1476
+ readonly value?: string;
1477
+ }
1478
+
1479
+ // @public
1480
+ export type Status = string;
1481
+
1482
+ // @public
1483
+ export interface Tag {
1484
+ key?: string;
1485
+ value?: string[];
1486
+ }
1487
+
1488
+ // @public
1489
+ export interface Tags {
1490
+ get(scope: string, options?: TagsGetOptionalParams): Promise<TagsGetResponse>;
1491
+ }
1492
+
1493
+ // @public
1494
+ export interface TagsGetOptionalParams extends coreClient.OperationOptions {
1495
+ }
1496
+
1497
+ // @public
1498
+ export type TagsGetResponse = TagsResult;
1499
+
1500
+ // @public
1501
+ export interface TagsResult extends ProxyResource {
1502
+ readonly nextLink?: string;
1503
+ readonly previousLink?: string;
1504
+ tags?: Tag[];
1505
+ }
1506
+
1507
+ // @public
1508
+ export type Term = string;
1509
+
1510
+ // @public
1511
+ export type ThresholdType = string;
1512
+
1513
+ // @public
1514
+ export type TimeGrainType = string;
1515
+
1516
+ // @public
1517
+ export interface UsageDetail extends Resource {
1518
+ kind: UsageDetailsKind;
1519
+ }
1520
+
1521
+ // @public
1522
+ export interface UsageDetails {
1523
+ list(scope: string, options?: UsageDetailsListOptionalParams): PagedAsyncIterableIterator<UsageDetailUnion>;
1524
+ }
1525
+
1526
+ // @public
1527
+ export type UsageDetailsKind = string;
1528
+
1529
+ // @public
1530
+ export interface UsageDetailsListNextOptionalParams extends coreClient.OperationOptions {
1531
+ }
1532
+
1533
+ // @public
1534
+ export type UsageDetailsListNextResponse = UsageDetailsListResult;
1535
+
1536
+ // @public
1537
+ export interface UsageDetailsListOptionalParams extends coreClient.OperationOptions {
1538
+ expand?: string;
1539
+ filter?: string;
1540
+ metric?: Metrictype;
1541
+ skiptoken?: string;
1542
+ top?: number;
1543
+ }
1544
+
1545
+ // @public
1546
+ export type UsageDetailsListResponse = UsageDetailsListResult;
1547
+
1548
+ // @public
1549
+ export interface UsageDetailsListResult {
1550
+ readonly nextLink?: string;
1551
+ readonly value?: UsageDetailUnion[];
1552
+ }
1553
+
1554
+ // @public (undocumented)
1555
+ export type UsageDetailUnion = UsageDetail | LegacyUsageDetail | ModernUsageDetail;
1556
+
1557
+ // (No @packageDocumentation comment for this package)
1558
+
1559
+ ```