@azure/arm-consumption package
Classes
| ConsumptionManagementClient |
Interfaces
| AggregatedCost |
Interface representing a AggregatedCost. |
| AggregatedCostGetByManagementGroupOptionalParams |
Optional parameters. |
| AggregatedCostGetForBillingPeriodByManagementGroupOptionalParams |
Optional parameters. |
| Amount |
The amount plus currency . |
| AmountWithExchangeRate |
The amount with exchange rate. |
| Balance |
A balance resource. |
| BalancePropertiesAdjustmentDetailsItem | |
| BalancePropertiesNewPurchasesDetailsItem | |
| Balances |
Interface representing a Balances. |
| BalancesGetByBillingAccountOptionalParams |
Optional parameters. |
| BalancesGetForBillingPeriodByBillingAccountOptionalParams |
Optional parameters. |
| Budget |
A budget resource. |
| BudgetComparisonExpression |
The comparison expression to be used in the budgets. |
| BudgetFilter |
May be used to filter budgets by resource group, resource, or meter. |
| BudgetFilterProperties |
The Dimensions or Tags to filter a budget by. |
| BudgetTimePeriod |
The start and end date for a budget. |
| Budgets |
Interface representing a Budgets. |
| BudgetsCreateOrUpdateOptionalParams |
Optional parameters. |
| BudgetsDeleteOptionalParams |
Optional parameters. |
| BudgetsGetOptionalParams |
Optional parameters. |
| BudgetsListNextOptionalParams |
Optional parameters. |
| BudgetsListOptionalParams |
Optional parameters. |
| BudgetsListResult |
Result of listing budgets. It contains a list of available budgets in the scope provided. |
| ChargeSummary |
A charge summary resource. |
| Charges |
Interface representing a Charges. |
| ChargesListOptionalParams |
Optional parameters. |
| ChargesListResult |
Result of listing charge summary. |
| ConsumptionManagementClientOptionalParams |
Optional parameters. |
| CreditBalanceSummary |
Summary of credit balances. |
| CreditSummary |
A credit summary resource. |
| Credits |
Interface representing a Credits. |
| CreditsGetOptionalParams |
Optional parameters. |
| CurrentSpend |
The current amount of cost which is being tracked for a budget. |
| DownloadProperties |
The properties of the price sheet download. |
| ErrorDetails |
The details of the error. |
| ErrorResponse |
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. Some Error responses:
|
| EventSummary |
An event summary resource. |
| Events |
Result of listing event summary. |
| EventsListByBillingAccountNextOptionalParams |
Optional parameters. |
| EventsListByBillingAccountOptionalParams |
Optional parameters. |
| EventsListByBillingProfileNextOptionalParams |
Optional parameters. |
| EventsListByBillingProfileOptionalParams |
Optional parameters. |
| EventsOperations |
Interface representing a EventsOperations. |
| ForecastSpend |
The forecasted cost which is being tracked for a budget. |
| HighCasedErrorDetails |
The details of the error. |
| HighCasedErrorResponse |
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. Some Error responses:
|
| LegacyChargeSummary |
Legacy charge summary. |
| LegacyReservationRecommendation |
Legacy reservation recommendation. |
| LegacyReservationRecommendationProperties |
The properties of the reservation recommendation. |
| LegacyReservationTransaction |
Legacy Reservation transaction resource. |
| LegacySharedScopeReservationRecommendationProperties |
The properties of the legacy reservation recommendation for shared scope. |
| LegacySingleScopeReservationRecommendationProperties |
The properties of the legacy reservation recommendation for single scope. |
| LegacyUsageDetail |
Legacy usage detail. |
| LotSummary |
A lot summary resource. |
| Lots |
Result of listing lot summary. |
| LotsListByBillingAccountNextOptionalParams |
Optional parameters. |
| LotsListByBillingAccountOptionalParams |
Optional parameters. |
| LotsListByBillingProfileNextOptionalParams |
Optional parameters. |
| LotsListByBillingProfileOptionalParams |
Optional parameters. |
| LotsOperations |
Interface representing a LotsOperations. |
| ManagementGroupAggregatedCostResult |
A management group aggregated cost resource. |
| Marketplace |
A marketplace resource. |
| Marketplaces |
Interface representing a Marketplaces. |
| MarketplacesListNextOptionalParams |
Optional parameters. |
| MarketplacesListOptionalParams |
Optional parameters. |
| MarketplacesListResult |
Result of listing marketplaces. It contains a list of available marketplaces in reverse chronological order by billing period. |
| MeterDetails |
The properties of the meter detail. |
| MeterDetailsResponse |
The properties of the meter detail. |
| ModernChargeSummary |
Modern charge summary. |
| ModernReservationRecommendation |
Modern reservation recommendation. |
| ModernReservationTransaction |
Modern Reservation transaction resource. |
| ModernReservationTransactionsListResult |
Result of listing reservation recommendations. |
| ModernUsageDetail |
Modern usage detail. |
| Notification |
The notification associated with a budget. |
| Operation |
A Consumption REST API operation. |
| OperationDisplay |
The object that represents the operation. |
| OperationListResult |
Result of listing consumption operations. It contains a list of operations and a URL link to get the next set of results. |
| Operations |
Interface representing a Operations. |
| OperationsListNextOptionalParams |
Optional parameters. |
| OperationsListOptionalParams |
Optional parameters. |
| PriceSheet |
Interface representing a PriceSheet. |
| PriceSheetGetByBillingPeriodOptionalParams |
Optional parameters. |
| PriceSheetGetOptionalParams |
Optional parameters. |
| PriceSheetProperties |
The properties of the price sheet. |
| PriceSheetResult |
An pricesheet resource. |
| ProxyResource |
The Resource model definition. |
| Reseller |
The reseller properties. |
| ReservationDetail |
reservation detail resource. |
| ReservationDetailsListResult |
Result of listing reservation details. |
| ReservationRecommendation |
A reservation recommendation resource. |
| ReservationRecommendationDetails |
Interface representing a ReservationRecommendationDetails. |
| ReservationRecommendationDetailsCalculatedSavingsProperties |
Details of estimated savings. |
| ReservationRecommendationDetailsGetOptionalParams |
Optional parameters. |
| ReservationRecommendationDetailsModel |
Reservation recommendation details. |
| ReservationRecommendationDetailsResourceProperties |
Details of the resource. |
| ReservationRecommendationDetailsSavingsProperties |
Details of the estimated savings. |
| ReservationRecommendationDetailsUsageProperties |
Details about historical usage data that has been used for computing the recommendation. |
| ReservationRecommendations |
Interface representing a ReservationRecommendations. |
| ReservationRecommendationsListNextOptionalParams |
Optional parameters. |
| ReservationRecommendationsListOptionalParams |
Optional parameters. |
| ReservationRecommendationsListResult |
Result of listing reservation recommendations. |
| ReservationSummariesListResult |
Result of listing reservation summaries. |
| ReservationSummary |
reservation summary resource. |
| ReservationTransaction |
Reservation transaction resource. |
| ReservationTransactionResource |
The Resource model definition. |
| ReservationTransactions |
Interface representing a ReservationTransactions. |
| ReservationTransactionsListByBillingProfileNextOptionalParams |
Optional parameters. |
| ReservationTransactionsListByBillingProfileOptionalParams |
Optional parameters. |
| ReservationTransactionsListNextOptionalParams |
Optional parameters. |
| ReservationTransactionsListOptionalParams |
Optional parameters. |
| ReservationTransactionsListResult |
Result of listing reservation recommendations. |
| ReservationsDetails |
Interface representing a ReservationsDetails. |
| ReservationsDetailsListByReservationOrderAndReservationNextOptionalParams |
Optional parameters. |
| ReservationsDetailsListByReservationOrderAndReservationOptionalParams |
Optional parameters. |
| ReservationsDetailsListByReservationOrderNextOptionalParams |
Optional parameters. |
| ReservationsDetailsListByReservationOrderOptionalParams |
Optional parameters. |
| ReservationsDetailsListNextOptionalParams |
Optional parameters. |
| ReservationsDetailsListOptionalParams |
Optional parameters. |
| ReservationsSummaries |
Interface representing a ReservationsSummaries. |
| ReservationsSummariesListByReservationOrderAndReservationNextOptionalParams |
Optional parameters. |
| ReservationsSummariesListByReservationOrderAndReservationOptionalParams |
Optional parameters. |
| ReservationsSummariesListByReservationOrderNextOptionalParams |
Optional parameters. |
| ReservationsSummariesListByReservationOrderOptionalParams |
Optional parameters. |
| ReservationsSummariesListNextOptionalParams |
Optional parameters. |
| ReservationsSummariesListOptionalParams |
Optional parameters. |
| Resource |
The Resource model definition. |
| ResourceAttributes |
The Resource model definition. |
| SkuProperty |
The Sku property |
| Tag |
The tag resource. |
| Tags |
Interface representing a Tags. |
| TagsGetOptionalParams |
Optional parameters. |
| TagsResult |
A resource listing all tags. |
| UsageDetail |
An usage detail resource. |
| UsageDetails |
Interface representing a UsageDetails. |
| UsageDetailsListNextOptionalParams |
Optional parameters. |
| UsageDetailsListOptionalParams |
Optional parameters. |
| UsageDetailsListResult |
Result of listing usage details. It contains a list of available usage details in reverse chronological order by billing period. |
Type Aliases
| AggregatedCostGetByManagementGroupResponse |
Contains response data for the getByManagementGroup operation. |
| AggregatedCostGetForBillingPeriodByManagementGroupResponse |
Contains response data for the getForBillingPeriodByManagementGroup operation. |
| BalancesGetByBillingAccountResponse |
Contains response data for the getByBillingAccount operation. |
| BalancesGetForBillingPeriodByBillingAccountResponse |
Contains response data for the getForBillingPeriodByBillingAccount operation. |
| BillingFrequency |
Defines values for BillingFrequency. Known values supported by the serviceMonth |
| BudgetOperatorType |
Defines values for BudgetOperatorType. Known values supported by the serviceIn |
| BudgetsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| BudgetsGetResponse |
Contains response data for the get operation. |
| BudgetsListNextResponse |
Contains response data for the listNext operation. |
| BudgetsListResponse |
Contains response data for the list operation. |
| CategoryType |
Defines values for CategoryType. Known values supported by the serviceCost |
| ChargeSummaryKind |
Defines values for ChargeSummaryKind. Known values supported by the servicelegacy |
| ChargeSummaryUnion | |
| ChargesListResponse |
Contains response data for the list operation. |
| CreditsGetResponse |
Contains response data for the get operation. |
| CultureCode |
Defines values for CultureCode. Known values supported by the serviceen-us |
| Datagrain |
Defines values for Datagrain. Known values supported by the servicedaily: Daily grain of data |
| EventType |
Defines values for EventType. Known values supported by the serviceSettledCharges |
| EventsListByBillingAccountNextResponse |
Contains response data for the listByBillingAccountNext operation. |
| EventsListByBillingAccountResponse |
Contains response data for the listByBillingAccount operation. |
| EventsListByBillingProfileNextResponse |
Contains response data for the listByBillingProfileNext operation. |
| EventsListByBillingProfileResponse |
Contains response data for the listByBillingProfile operation. |
| LegacyReservationRecommendationPropertiesUnion | |
| LookBackPeriod |
Defines values for LookBackPeriod. Known values supported by the serviceLast7Days: Use 7 days of data for recommendations |
| LotSource |
Defines values for LotSource. Known values supported by the servicePurchasedCredit |
| LotsListByBillingAccountNextResponse |
Contains response data for the listByBillingAccountNext operation. |
| LotsListByBillingAccountResponse |
Contains response data for the listByBillingAccount operation. |
| LotsListByBillingProfileNextResponse |
Contains response data for the listByBillingProfileNext operation. |
| LotsListByBillingProfileResponse |
Contains response data for the listByBillingProfile operation. |
| MarketplacesListNextResponse |
Contains response data for the listNext operation. |
| MarketplacesListResponse |
Contains response data for the list operation. |
| Metrictype |
Defines values for Metrictype. Known values supported by the serviceactualcost: Actual cost data. |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| OperatorType |
Defines values for OperatorType. Known values supported by the serviceEqualTo |
| PriceSheetGetByBillingPeriodResponse |
Contains response data for the getByBillingPeriod operation. |
| PriceSheetGetResponse |
Contains response data for the get operation. |
| PricingModelType |
Defines values for PricingModelType. Known values supported by the serviceOn Demand |
| ReservationRecommendationDetailsGetResponse |
Contains response data for the get operation. |
| ReservationRecommendationKind |
Defines values for ReservationRecommendationKind. Known values supported by the servicelegacy |
| ReservationRecommendationUnion | |
| ReservationRecommendationsListNextResponse |
Contains response data for the listNext operation. |
| ReservationRecommendationsListResponse |
Contains response data for the list operation. |
| ReservationTransactionsListByBillingProfileNextResponse |
Contains response data for the listByBillingProfileNext operation. |
| ReservationTransactionsListByBillingProfileResponse |
Contains response data for the listByBillingProfile operation. |
| ReservationTransactionsListNextResponse |
Contains response data for the listNext operation. |
| ReservationTransactionsListResponse |
Contains response data for the list operation. |
| ReservationsDetailsListByReservationOrderAndReservationNextResponse |
Contains response data for the listByReservationOrderAndReservationNext operation. |
| ReservationsDetailsListByReservationOrderAndReservationResponse |
Contains response data for the listByReservationOrderAndReservation operation. |
| ReservationsDetailsListByReservationOrderNextResponse |
Contains response data for the listByReservationOrderNext operation. |
| ReservationsDetailsListByReservationOrderResponse |
Contains response data for the listByReservationOrder operation. |
| ReservationsDetailsListNextResponse |
Contains response data for the listNext operation. |
| ReservationsDetailsListResponse |
Contains response data for the list operation. |
| ReservationsSummariesListByReservationOrderAndReservationNextResponse |
Contains response data for the listByReservationOrderAndReservationNext operation. |
| ReservationsSummariesListByReservationOrderAndReservationResponse |
Contains response data for the listByReservationOrderAndReservation operation. |
| ReservationsSummariesListByReservationOrderNextResponse |
Contains response data for the listByReservationOrderNext operation. |
| ReservationsSummariesListByReservationOrderResponse |
Contains response data for the listByReservationOrder operation. |
| ReservationsSummariesListNextResponse |
Contains response data for the listNext operation. |
| ReservationsSummariesListResponse |
Contains response data for the list operation. |
| Scope |
Defines values for Scope. Known values supported by the serviceSingle |
| Status |
Defines values for Status. Known values supported by the serviceNone |
| TagsGetResponse |
Contains response data for the get operation. |
| Term |
Defines values for Term. Known values supported by the serviceP1Y: 1 year reservation term |
| ThresholdType |
Defines values for ThresholdType. Known values supported by the serviceActual |
| TimeGrainType |
Defines values for TimeGrainType. Known values supported by the serviceMonthly |
| UsageDetailUnion | |
| UsageDetailsKind |
Defines values for UsageDetailsKind. Known values supported by the servicelegacy |
| UsageDetailsListNextResponse |
Contains response data for the listNext operation. |
| UsageDetailsListResponse |
Contains response data for the list operation. |
Enums
| KnownBillingFrequency |
Known values of BillingFrequency that the service accepts. |
| KnownBudgetOperatorType |
Known values of BudgetOperatorType that the service accepts. |
| KnownCategoryType |
Known values of CategoryType that the service accepts. |
| KnownChargeSummaryKind |
Known values of ChargeSummaryKind that the service accepts. |
| KnownCultureCode |
Known values of CultureCode that the service accepts. |
| KnownDatagrain |
Known values of Datagrain that the service accepts. |
| KnownEventType |
Known values of EventType that the service accepts. |
| KnownLookBackPeriod |
Known values of LookBackPeriod that the service accepts. |
| KnownLotSource |
Known values of LotSource that the service accepts. |
| KnownMetrictype |
Known values of Metrictype that the service accepts. |
| KnownOperatorType |
Known values of OperatorType that the service accepts. |
| KnownPricingModelType |
Known values of PricingModelType that the service accepts. |
| KnownReservationRecommendationKind |
Known values of ReservationRecommendationKind that the service accepts. |
| KnownScope |
Known values of Scope that the service accepts. |
| KnownStatus |
Known values of Status that the service accepts. |
| KnownTerm |
Known values of Term that the service accepts. |
| KnownThresholdType |
Known values of ThresholdType that the service accepts. |
| KnownTimeGrainType |
Known values of TimeGrainType that the service accepts. |
| KnownUsageDetailsKind |
Known values of UsageDetailsKind that the service accepts. |
Functions
| get |
Given the last |
Function Details
getContinuationToken(unknown)
Given the last .value produced by the byPage iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefined
Parameters
- page
-
unknown
An object from accessing value on the IteratorResult from a byPage iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.