@azure/arm-consumption package

Classes

ConsumptionManagementClient

Interfaces

AggregatedCostGetByManagementGroupOptionalParams	Optional parameters.
AggregatedCostGetForBillingPeriodByManagementGroupOptionalParams	Optional parameters.
AggregatedCostOperations	Interface representing a AggregatedCost operations.
Amount	The amount plus currency .
AmountWithExchangeRate	The amount with exchange rate.
Balance	A balance resource.
BalanceProperties	The properties of the balance.
BalancePropertiesAdjustmentDetailsItem	model interface BalancePropertiesAdjustmentDetailsItem
BalancePropertiesNewPurchasesDetailsItem	model interface BalancePropertiesNewPurchasesDetailsItem
BalancesGetByBillingAccountOptionalParams	Optional parameters.
BalancesGetForBillingPeriodByBillingAccountOptionalParams	Optional parameters.
BalancesOperations	Interface representing a Balances operations.
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.
BudgetProperties	The properties of the budget.
BudgetTimePeriod	The start and end date for a budget.
BudgetsCreateOrUpdateOptionalParams	Optional parameters.
BudgetsDeleteOptionalParams	Optional parameters.
BudgetsGetOptionalParams	Optional parameters.
BudgetsListOptionalParams	Optional parameters.
BudgetsOperations	Interface representing a Budgets operations.
ChargeSummary	A charge summary resource.
ChargesListOptionalParams	Optional parameters.
ChargesListResult	Result of listing charge summary.
ChargesOperations	Interface representing a Charges operations.
ConsumptionManagementClientOptionalParams	Optional parameters for the client.
CreditBalanceSummary	Summary of credit balances.
CreditSummary	A credit summary resource.
CreditSummaryProperties	The properties of the credit summary.
CreditsGetOptionalParams	Optional parameters.
CreditsOperations	Interface representing a Credits operations.
CurrentSpend	The current amount of cost which is being tracked for a budget.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
EventProperties	The event properties.
EventSummary	An event summary resource.
EventsOperationsListByBillingAccountOptionalParams	Optional parameters.
EventsOperationsListByBillingProfileOptionalParams	Optional parameters.
EventsOperationsOperations	Interface representing a EventsOperations operations.
ExtensionResource	The base extension resource.
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: 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header. 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.
LegacyChargeSummary	Legacy charge summary.
LegacyChargeSummaryProperties	The properties of legacy charge summary.
LegacyReservationRecommendation	Legacy reservation recommendation.
LegacyReservationRecommendationProperties	The properties of the reservation recommendation.
LegacyReservationTransactionProperties	The properties of a legacy reservation transaction.
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.
LegacyUsageDetailProperties	The properties of the legacy usage detail.
LotProperties	The lot properties.
LotSummary	A lot summary resource.
LotsOperationsListByBillingAccountOptionalParams	Optional parameters.
LotsOperationsListByBillingProfileOptionalParams	Optional parameters.
LotsOperationsListByCustomerOptionalParams	Optional parameters.
LotsOperationsOperations	Interface representing a LotsOperations operations.
ManagementGroupAggregatedCostProperties	The properties of the Management Group Aggregated Cost.
ManagementGroupAggregatedCostResult	A management group aggregated cost resource.
Marketplace	A marketplace resource.
MarketplaceProperties	The properties of the marketplace usage detail.
MarketplacesListOptionalParams	Optional parameters.
MarketplacesOperations	Interface representing a Marketplaces operations.
MeterDetails	The properties of the meter detail.
MeterDetailsResponse	The properties of the meter detail.
ModernChargeSummary	Modern charge summary.
ModernChargeSummaryProperties	The properties of modern charge summary.
ModernReservationRecommendation	Modern reservation recommendation.
ModernReservationRecommendationProperties	The properties of the reservation recommendation.
ModernReservationTransaction	Modern Reservation transaction resource.
ModernReservationTransactionProperties	The properties of a modern reservation transaction.
ModernSharedScopeReservationRecommendationProperties	The properties of the modern reservation recommendation for shared scope.
ModernSingleScopeReservationRecommendationProperties	The properties of the modern reservation recommendation for single scope.
ModernUsageDetail	Modern usage detail.
ModernUsageDetailProperties	The properties of the usage detail.
Notification	The notification associated with a budget.
Operation	A Consumption REST API operation.
OperationDisplay	The object that represents the operation.
OperationStatus	The status of the long running operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PriceSheetDownloadByBillingAccountPeriodOptionalParams	Optional parameters.
PriceSheetGetByBillingPeriodOptionalParams	Optional parameters.
PriceSheetGetOptionalParams	Optional parameters.
PriceSheetModel	price sheet result. It contains the pricesheet associated with billing period
PriceSheetOperations	Interface representing a PriceSheet operations.
PriceSheetProperties	The properties of the price sheet.
PriceSheetResult	An pricesheet resource.
PricesheetDownloadProperties	The properties of the price sheet download.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Reseller	The reseller properties.
ReservationDetail	reservation detail resource.
ReservationDetailProperties	The properties of the reservation detail.
ReservationRecommendation	A reservation recommendation resource.
ReservationRecommendationDetailsCalculatedSavingsProperties	Details of estimated savings. The costs and savings are estimated for the term.
ReservationRecommendationDetailsGetOptionalParams	Optional parameters.
ReservationRecommendationDetailsModel	Reservation recommendation details.
ReservationRecommendationDetailsOperations	Interface representing a ReservationRecommendationDetails operations.
ReservationRecommendationDetailsProperties	The properties of the reservation recommendation.
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.
ReservationRecommendationsListOptionalParams	Optional parameters.
ReservationRecommendationsOperations	Interface representing a ReservationRecommendations operations.
ReservationSummary	reservation summary resource.
ReservationSummaryProperties	The properties of the reservation summary.
ReservationTransaction	Reservation transaction resource.
ReservationTransactionsListByBillingProfileOptionalParams	Optional parameters.
ReservationTransactionsListOptionalParams	Optional parameters.
ReservationTransactionsOperations	Interface representing a ReservationTransactions operations.
ReservationsDetailsListByReservationOrderAndReservationOptionalParams	Optional parameters.
ReservationsDetailsListByReservationOrderOptionalParams	Optional parameters.
ReservationsDetailsListOptionalParams	Optional parameters.
ReservationsDetailsOperations	Interface representing a ReservationsDetails operations.
ReservationsSummariesListByReservationOrderAndReservationOptionalParams	Optional parameters.
ReservationsSummariesListByReservationOrderOptionalParams	Optional parameters.
ReservationsSummariesListOptionalParams	Optional parameters.
ReservationsSummariesOperations	Interface representing a ReservationsSummaries operations.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SavingsPlan	The properties of the SavingsPlan.
SkuProperty	The Sku property
SystemData	Metadata pertaining to creation and last modification of the resource.
Tag	The tag resource.
TagProperties	The properties of the tag.
TagsGetOptionalParams	Optional parameters.
TagsOperations	Interface representing a Tags operations.
TagsResult	A resource listing all tags.
UsageDetail	An usage detail resource.
UsageDetailsListOptionalParams	Optional parameters.
UsageDetailsOperations	Interface representing a UsageDetails operations.

Type Aliases

AzureSupportedClouds	The supported values for cloud setting as a string literal type
BillingFrequency	The billing frequency. KnownBillingFrequency can be used interchangeably with BillingFrequency, this enum contains the known values that the service supports. Known values supported by the service Month Quarter Year
BudgetOperatorType	The operator to use for comparison. KnownBudgetOperatorType can be used interchangeably with BudgetOperatorType, this enum contains the known values that the service supports. Known values supported by the service In
CategoryType	The category of the budget, whether the budget tracks cost or usage. KnownCategoryType can be used interchangeably with CategoryType, this enum contains the known values that the service supports. Known values supported by the service Cost
ChargeSummaryKind	Specifies the kind of charge summary. KnownChargeSummaryKind can be used interchangeably with ChargeSummaryKind, this enum contains the known values that the service supports. Known values supported by the service legacy modern
ChargeSummaryUnion	Alias for ChargeSummaryUnion
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
CultureCode	Language in which the recipient will receive the notification KnownCultureCode can be used interchangeably with CultureCode, this enum contains the known values that the service supports. Known values supported by the service en-us ja-jp zh-cn de-de es-es fr-fr it-it ko-kr pt-br ru-ru zh-tw cs-cz pl-pl tr-tr da-dk en-gb hu-hu nb-no nl-nl pt-pt sv-se
Datagrain	Type of Datagrain
EventType	Identifies the type of the event. KnownEventType can be used interchangeably with EventType, this enum contains the known values that the service supports. Known values supported by the service SettledCharges PendingCharges PendingAdjustments PendingNewCredit PendingExpiredCredit UnKnown NewCredit CreditExpired
LegacyReservationRecommendationPropertiesUnion	Alias for LegacyReservationRecommendationPropertiesUnion
LookBackPeriod	Type of LookBackPeriod
LotSource	The source of the lot. KnownLotSource can be used interchangeably with LotSource, this enum contains the known values that the service supports. Known values supported by the service PurchasedCredit PromotionalCredit ConsumptionCommitment
Metrictype	Type of Metrictype
ModernReservationRecommendationPropertiesUnion	Alias for ModernReservationRecommendationPropertiesUnion
OperationStatusType	The status of the long running operation. KnownOperationStatusType can be used interchangeably with OperationStatusType, this enum contains the known values that the service supports. Known values supported by the service Running Completed Failed
OperatorType	The comparison operator. KnownOperatorType can be used interchangeably with OperatorType, this enum contains the known values that the service supports. Known values supported by the service EqualTo: Alert will be triggered if the evaluated cost is the same as threshold value. Note: It’s not recommended to use this OperatorType as there’s low chance of cost being exactly the same as threshold value, leading to missing of your alert. This OperatorType will be deprecated in future. GreaterThan: Alert will be triggered if the evaluated cost is greater than the threshold value. Note: This is the recommended OperatorType while configuring Budget Alert. GreaterThanOrEqualTo: Alert will be triggered if the evaluated cost is greater than or equal to the threshold value.
OrganizationType	The organization type of the lot. KnownOrganizationType can be used interchangeably with OrganizationType, this enum contains the known values that the service supports. Known values supported by the service Primary: Primary organization type for Multi-Entity consumption commitment. Contributor: Contributor organization type for Multi-Entity consumption commitment.
PricingModelType	Identifier that indicates how the meter is priced. KnownPricingModelType can be used interchangeably with PricingModelType, this enum contains the known values that the service supports. Known values supported by the service On Demand Reservation Spot
ReservationRecommendationKind	Specifies the kind of reservation recommendation. KnownReservationRecommendationKind can be used interchangeably with ReservationRecommendationKind, this enum contains the known values that the service supports. Known values supported by the service legacy modern
ReservationRecommendationUnion	Alias for ReservationRecommendationUnion
Scope	Type of Scope
Status	The status of the lot. KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service None Active Inactive Expired Complete Canceled
Term	Type of Term
ThresholdType	The type of threshold KnownThresholdType can be used interchangeably with ThresholdType, this enum contains the known values that the service supports. Known values supported by the service Actual: Actual costs budget alerts notify when the actual accrued cost exceeds the allocated budget . Forecasted: Forecasted costs budget alerts provide advanced notification that your spending trends are likely to exceed your allocated budget, as it relies on forecasted cost predictions.
TimeGrainType	The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers KnownTimeGrainType can be used interchangeably with TimeGrainType, this enum contains the known values that the service supports. Known values supported by the service Monthly Quarterly Annually BillingMonth BillingQuarter BillingAnnual
UsageDetailUnion	Alias for UsageDetailUnion
UsageDetailsKind	Specifies the kind of usage details. KnownUsageDetailsKind can be used interchangeably with UsageDetailsKind, this enum contains the known values that the service supports. Known values supported by the service legacy modern

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownBillingFrequency	The billing frequency.
KnownBudgetOperatorType	The operator to use for comparison.
KnownCategoryType	The category of the budget, whether the budget tracks cost or usage.
KnownChargeSummaryKind	Specifies the kind of charge summary.
KnownCreatedByType	The kind of entity that created the resource.
KnownCultureCode	Language in which the recipient will receive the notification
KnownDatagrain	Known values of Datagrain that the service accepts.
KnownEventType	Identifies the type of the event.
KnownLookBackPeriod	Known values of LookBackPeriod that the service accepts.
KnownLotSource	The source of the lot.
KnownMetrictype	Known values of Metrictype that the service accepts.
KnownOperationStatusType	The status of the long running operation.
KnownOperatorType	The comparison operator.
KnownOrganizationType	The organization type of the lot.
KnownPricingModelType	Identifier that indicates how the meter is priced.
KnownReservationRecommendationKind	Specifies the kind of reservation recommendation.
KnownScope	Known values of Scope that the service accepts.
KnownStatus	The status of the lot.
KnownTerm	Known values of Term that the service accepts.
KnownThresholdType	The type of threshold
KnownTimeGrainType	The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers
KnownUsageDetailsKind	Specifies the kind of usage details.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(ConsumptionManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(ConsumptionManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: ConsumptionManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

ConsumptionManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor