@azure/arm-costmanagement package

Classes

CostManagementClient

Interfaces

Alert	An individual alert.
AlertProperties	Alert properties.
AlertPropertiesDefinition	defines the type of alert
AlertPropertiesDetails	Alert details
AlertsDismissOptionalParams	Optional parameters.
AlertsGetOptionalParams	Optional parameters.
AlertsListExternalOptionalParams	Optional parameters.
AlertsListOptionalParams	Optional parameters.
AlertsOperations	Interface representing a Alerts operations.
AlertsResult	Result of alerts.
AllSavingsBenefitDetails	Benefit recommendation details.
AllSavingsList	The list of all benefit recommendations with the recommendation details.
ArmErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
AsyncOperationStatusProperties	Object representing the report url and valid until date of the async report generated.
BenefitRecommendationModel	benefit plan recommendation details.
BenefitRecommendationProperties	The properties of the benefit recommendations.
BenefitRecommendationsListOptionalParams	Optional parameters.
BenefitRecommendationsOperations	Interface representing a BenefitRecommendations operations.
BenefitResource	The benefit resource model definition.
BenefitUtilizationSummariesListByBillingAccountIdOptionalParams	Optional parameters.
BenefitUtilizationSummariesListByBillingProfileIdOptionalParams	Optional parameters.
BenefitUtilizationSummariesListBySavingsPlanIdOptionalParams	Optional parameters.
BenefitUtilizationSummariesListBySavingsPlanOrderOptionalParams	Optional parameters.
BenefitUtilizationSummariesOperationStatus	Status of a benefit utilization summaries report. Provides Async Benefit Utilization Summaries Request input, status, and report sas url.
BenefitUtilizationSummariesOperations	Interface representing a BenefitUtilizationSummaries operations.
BenefitUtilizationSummariesRequest	Properties of an async benefit utilization summaries request.
BenefitUtilizationSummary	Benefit utilization summary resource.
BenefitUtilizationSummaryProperties	The properties of a benefit utilization summary.
BlobInfo	The blob information generated by this operation.
Budget	A budget resource.
BudgetComparisonExpression	The comparison expression to be used in the budgets.
BudgetFilter	May be used to filter budgets by user-specified dimensions and/or tags. Supported for CategoryType(s): Cost, ReservationUtilization.
BudgetFilterProperties	The Dimensions or Tags to filter a budget by. Supported for CategoryType(s): Cost, ReservationUtilization.
BudgetProperties	The properties of the budget.
BudgetTimePeriod	The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate. Supported for CategoryType(s): Cost, ReservationUtilization. Required for CategoryType(s): Cost, ReservationUtilization.
BudgetsCreateOrUpdateOptionalParams	Optional parameters.
BudgetsDeleteOptionalParams	Optional parameters.
BudgetsGetOptionalParams	Optional parameters.
BudgetsListOptionalParams	Optional parameters.
BudgetsOperations	Interface representing a Budgets operations.
CheckNameAvailabilityRequest	The check availability request body.
CheckNameAvailabilityResponse	The check availability result.
CommonExportProperties	The common properties of the export.
CostAllocationProportion	Target resources and allocation
CostAllocationResource	Common values for resources for cost allocation
CostAllocationRuleCheckNameAvailabilityRequest	The cost allocation rule check name availability request
CostAllocationRuleCheckNameAvailabilityResponse	The cost allocation rule check name availability response
CostAllocationRuleDefinition	The cost allocation rule model definition
CostAllocationRuleDetails	Resource details of the cost allocation rule
CostAllocationRuleProperties	The properties of a cost allocation rule
CostAllocationRulesCheckNameAvailabilityOptionalParams	Optional parameters.
CostAllocationRulesCreateOrUpdateOptionalParams	Optional parameters.
CostAllocationRulesDeleteOptionalParams	Optional parameters.
CostAllocationRulesGetOptionalParams	Optional parameters.
CostAllocationRulesListOptionalParams	Optional parameters.
CostAllocationRulesOperations	Interface representing a CostAllocationRules operations.
CostDetailsOperationResults	The result of the long running operation for cost details Api.
CostDetailsTimePeriod	The start and end date for pulling data for the cost detailed report. API only allows data to be pulled for 1 month or less and no older than 13 months.
CostManagementClientOptionalParams	Optional parameters for the client.
CostManagementOperation	A Cost management REST API operation.
CostManagementProxyResource	The Resource model definition.
CostManagementResource	The Resource model definition.
CurrentSpend	The current amount of cost which is being tracked for a budget. Supported for CategoryType(s): Cost.
Dimension	List of Dimension.
DimensionProperties	Dimension properties.
DimensionsListByExternalCloudProviderTypeOptionalParams	Optional parameters.
DimensionsListOptionalParams	Optional parameters.
DimensionsOperations	Interface representing a Dimensions operations.
DismissAlertPayload	The request payload to update an alert
DownloadURL	The URL to download the generated report.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorDetails	The details of the error.
ErrorDetailsWithNestedDetails	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. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.
ErrorResponseWithNestedDetails	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.
Export	An export resource.
ExportDataset	The definition for data in the export.
ExportDatasetConfiguration	This is on path to deprecation and will not be supported going forward.
ExportDefinition	The definition of an export.
ExportDeliveryDestination	This represents the blob storage account location where exports of costs will be delivered. There are two ways to configure the destination. The approach recommended for most customers is to specify the resourceId of the storage account. This requires a one-time registration of the account's subscription with the Microsoft.CostManagementExports resource provider in order to give Cost Management services access to the storage. When creating an export in the Azure portal this registration is performed automatically but API users may need to register the subscription explicitly (for more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Another way to configure the destination is available ONLY to Partners with a Microsoft Partner Agreement plan who are global admins of their billing account. These Partners, instead of specifying the resourceId of a storage account, can specify the storage account name along with a SAS token for the account. This allows exports of costs to a storage account in any tenant. The SAS token should be created for the blob service with Service/Container/Object resource types and with Read/Write/Delete/List/Add/Create permissions (for more information see https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).
ExportDeliveryInfo	The delivery information associated with a export.
ExportExecutionListResult	Result of listing the run history of an export.
ExportListResult	Result of listing exports. It contains a list of available exports in the scope provided.
ExportProperties	The properties of the export.
ExportRecurrencePeriod	The start and end date for recurrence schedule.
ExportRun	An export run.
ExportRunProperties	The properties of the export run.
ExportRunRequest	The export run request.
ExportSchedule	The schedule associated with the export.
ExportSuspensionContext	The properties of the export run. This is not populated currently.
ExportTimePeriod	The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 1 calendar month.
ExportsCreateOrUpdateOptionalParams	Optional parameters.
ExportsDeleteOptionalParams	Optional parameters.
ExportsExecuteOptionalParams	Optional parameters.
ExportsGetExecutionHistoryOptionalParams	Optional parameters.
ExportsGetOptionalParams	Optional parameters.
ExportsListOptionalParams	Optional parameters.
ExportsOperations	Interface representing a Exports operations.
ExtensionResource	The base extension resource.
FileDestination	Destination of the view data. This is optional. Currently only CSV format is supported.
FilterItems	Will contain the filter name and value to operate on. This is currently only supported for Export Definition type of ReservationRecommendations.
ForecastAggregation	The aggregation expression to be used in the forecast.
ForecastColumn	Forecast column properties
ForecastComparisonExpression	The comparison expression to be used in the forecast.
ForecastDataset	The definition of data present in the forecast.
ForecastDatasetConfiguration	The configuration of dataset in the forecast.
ForecastDefinition	The definition of a forecast.
ForecastExternalCloudProviderUsageOptionalParams	Optional parameters.
ForecastFilter	The filter expression to be used in the export.
ForecastOperations	Interface representing a Forecast operations.
ForecastProperties	Forecast properties
ForecastResult	Result of forecast. It contains all columns listed under groupings and aggregation.
ForecastSpend	The forecasted cost which is being tracked for a budget. Supported for CategoryType(s): Cost.
ForecastTimePeriod	Has time period for pulling data for the forecast.
ForecastUsageOptionalParams	Optional parameters.
GenerateBenefitUtilizationSummariesReportGenerateByBillingAccountOptionalParams	Optional parameters.
GenerateBenefitUtilizationSummariesReportGenerateByBillingProfileOptionalParams	Optional parameters.
GenerateBenefitUtilizationSummariesReportGenerateByReservationIdOptionalParams	Optional parameters.
GenerateBenefitUtilizationSummariesReportGenerateByReservationOrderIdOptionalParams	Optional parameters.
GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanIdOptionalParams	Optional parameters.
GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanOrderIdOptionalParams	Optional parameters.
GenerateBenefitUtilizationSummariesReportOperations	Interface representing a GenerateBenefitUtilizationSummariesReport operations.
GenerateCostDetailsReportCreateOperationOptionalParams	Optional parameters.
GenerateCostDetailsReportErrorResponse	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: 400 Bad Request - Invalid Request Payload. Request payload provided is not in a json format or had an invalid member not accepted in the request payload. 400 Bad Request - Invalid request payload: can only have either timePeriod or invoiceId or billingPeriod. API only allows data to be pulled for either timePeriod or invoiceId or billingPeriod. Customer should provide only one of these parameters. 400 Bad Request - Start date must be after . API only allows data to be pulled no older than 13 months from now. 400 Bad Request - The maximum allowed date range is 1 months. API only allows data to be pulled for 1 month or less. 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "retry-after" header. 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.
GenerateCostDetailsReportGetOperationResultsOptionalParams	Optional parameters.
GenerateCostDetailsReportOperations	Interface representing a GenerateCostDetailsReport operations.
GenerateCostDetailsReportRequestDefinition	The definition of a cost detailed report.
GenerateDetailedCostReportCreateOperationOptionalParams	Optional parameters.
GenerateDetailedCostReportDefinition	The definition of a cost detailed report.
GenerateDetailedCostReportErrorResponse	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: 413 Request Entity Too Large - Request is throttled. The amount of data required to fulfill the request exceeds the maximum size permitted of 2Gb. Please utilize our Exports feature instead. 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.
GenerateDetailedCostReportOperationResult	The result of the long running operation for cost detailed report.
GenerateDetailedCostReportOperationResultsGetOptionalParams	Optional parameters.
GenerateDetailedCostReportOperationResultsOperations	Interface representing a GenerateDetailedCostReportOperationResults operations.
GenerateDetailedCostReportOperationStatusGetOptionalParams	Optional parameters.
GenerateDetailedCostReportOperationStatusOperations	Interface representing a GenerateDetailedCostReportOperationStatus operations.
GenerateDetailedCostReportOperationStatuses	The status of the long running operation for cost detailed report.
GenerateDetailedCostReportOperations	Interface representing a GenerateDetailedCostReport operations.
GenerateDetailedCostReportTimePeriod	The start and end date for pulling data for the cost detailed report.
GenerateReservationDetailsReportByBillingAccountIdOptionalParams	Optional parameters.
GenerateReservationDetailsReportByBillingProfileIdOptionalParams	Optional parameters.
GenerateReservationDetailsReportOperations	Interface representing a GenerateReservationDetailsReport operations.
IncludedQuantityUtilizationSummary	Included Quantity utilization summary resource.
IncludedQuantityUtilizationSummaryProperties	Included Quantity utilization summary properties.
KpiProperties	Each KPI must contain a 'type' and 'enabled' key.
MCAPriceSheetProperties	The properties of the price sheet.
Notification	The notification associated with a budget. Supported for CategoryType(s): Cost, ReservationUtilization.
NotificationProperties	The properties of the scheduled action notification.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an 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.
PivotProperties	Each pivot must contain a 'type' and 'name'.
PriceSheetDownloadByBillingAccountOptionalParams	Optional parameters.
PriceSheetDownloadByBillingProfileOptionalParams	Optional parameters.
PriceSheetDownloadByInvoiceOptionalParams	Optional parameters.
PriceSheetOperations	Interface representing a PriceSheet operations.
PricesheetDownloadProperties	The URL to download the generated report.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
QueryAggregation	The aggregation expression to be used in the query.
QueryColumn	QueryColumn properties
QueryComparisonExpression	The comparison expression to be used in the query.
QueryDataset	The definition of data present in the query.
QueryDatasetConfiguration	The configuration of dataset in the query.
QueryDefinition	The definition of a query.
QueryFilter	The filter expression to be used in the export.
QueryGrouping	The group by expression to be used in the query.
QueryOperations	Interface representing a Query operations.
QueryProperties	Query properties
QueryResult	Result of query. It contains all columns listed under groupings and aggregation.
QueryTimePeriod	The start and end date for pulling data for the query.
QueryUsageByExternalCloudProviderTypeOptionalParams	Optional parameters.
QueryUsageOptionalParams	Optional parameters.
RecommendationUsageDetails	On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.
ReportConfigAggregation	The aggregation expression to be used in the report.
ReportConfigComparisonExpression	The comparison expression to be used in the report.
ReportConfigDataset	The definition of data present in the report.
ReportConfigDatasetConfiguration	The configuration of dataset in the report.
ReportConfigDefinition	The definition of a report config.
ReportConfigFilter	The filter expression to be used in the report.
ReportConfigGrouping	The group by expression to be used in the report.
ReportConfigSorting	The order by expression to be used in the report.
ReportConfigTimePeriod	The start and end date for pulling data for the report.
ReportManifest	The manifest of the report generated by the operation.
ReportURL	The URL to download the generated report.
RequestContext	The context of the Cost Details request.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SavingsPlanUtilizationSummary	Savings plan utilization summary resource.
SavingsPlanUtilizationSummaryProperties	Savings plan utilization summary properties.
ScheduleProperties	The properties of the schedule.
ScheduledAction	Scheduled action definition.
ScheduledActionProperties	The properties of the scheduled action.
ScheduledActionsCheckNameAvailabilityByScopeOptionalParams	Optional parameters.
ScheduledActionsCheckNameAvailabilityOptionalParams	Optional parameters.
ScheduledActionsCreateOrUpdateByScopeOptionalParams	Optional parameters.
ScheduledActionsCreateOrUpdateOptionalParams	Optional parameters.
ScheduledActionsDeleteByScopeOptionalParams	Optional parameters.
ScheduledActionsDeleteOptionalParams	Optional parameters.
ScheduledActionsGetByScopeOptionalParams	Optional parameters.
ScheduledActionsGetOptionalParams	Optional parameters.
ScheduledActionsListByScopeOptionalParams	Optional parameters.
ScheduledActionsListOptionalParams	Optional parameters.
ScheduledActionsOperations	Interface representing a ScheduledActions operations.
ScheduledActionsRunByScopeOptionalParams	Optional parameters.
ScheduledActionsRunOptionalParams	Optional parameters.
Setting	Setting definition.
SettingsCreateOrUpdateByScopeOptionalParams	Optional parameters.
SettingsDeleteByScopeOptionalParams	Optional parameters.
SettingsGetByScopeOptionalParams	Optional parameters.
SettingsListOptionalParams	Optional parameters.
SettingsListResult	Setting list result. It contains a list of settings.
SettingsOperations	Interface representing a Settings operations.
SharedScopeBenefitRecommendationProperties	The properties of the benefit recommendation when scope is 'Shared'.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SingleScopeBenefitRecommendationProperties	The properties of the benefit recommendations when scope is 'Single'.
SourceCostAllocationResource	Source resources for cost allocation
Status	The status of the long running operation.
SystemAssignedServiceIdentity	Managed service identity (either system assigned, or none)
SystemData	Metadata pertaining to creation and last modification of the resource.
TagInheritanceProperties	The properties of the tag inheritance setting.
TagInheritanceSetting	Tag Inheritance Setting definition.
TargetCostAllocationResource	Target resources for cost allocation.
View	States and configurations of Cost Analysis.
ViewProperties	The properties of the view.
ViewsCreateOrUpdateByScopeOptionalParams	Optional parameters.
ViewsCreateOrUpdateOptionalParams	Optional parameters.
ViewsDeleteByScopeOptionalParams	Optional parameters.
ViewsDeleteOptionalParams	Optional parameters.
ViewsGetByScopeOptionalParams	Optional parameters.
ViewsGetOptionalParams	Optional parameters.
ViewsListByScopeOptionalParams	Optional parameters.
ViewsListOptionalParams	Optional parameters.
ViewsOperations	Interface representing a Views operations.

Type Aliases

AccumulatedType	Show costs accumulated over time. KnownAccumulatedType can be used interchangeably with AccumulatedType, this enum contains the known values that the service supports. Known values supported by the service true false
ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AlertCategory	Alert category KnownAlertCategory can be used interchangeably with AlertCategory, this enum contains the known values that the service supports. Known values supported by the service Cost Usage Billing System
AlertCriteria	Criteria that triggered alert KnownAlertCriteria can be used interchangeably with AlertCriteria, this enum contains the known values that the service supports. Known values supported by the service CostThresholdExceeded UsageThresholdExceeded CreditThresholdApproaching CreditThresholdReached QuotaThresholdApproaching QuotaThresholdReached MultiCurrency ForecastCostThresholdExceeded ForecastUsageThresholdExceeded InvoiceDueDateApproaching InvoiceDueDateReached CrossCloudNewDataAvailable CrossCloudCollectionError GeneralThresholdError
AlertOperator	operator used to compare currentSpend with amount KnownAlertOperator can be used interchangeably with AlertOperator, this enum contains the known values that the service supports. Known values supported by the service None EqualTo GreaterThan GreaterThanOrEqualTo LessThan LessThanOrEqualTo
AlertSource	Source of alert KnownAlertSource can be used interchangeably with AlertSource, this enum contains the known values that the service supports. Known values supported by the service Preset User
AlertStatus	alert status KnownAlertStatus can be used interchangeably with AlertStatus, this enum contains the known values that the service supports. Known values supported by the service None Active Overridden Resolved Dismissed
AlertTimeGrainType	Type of timegrain cadence KnownAlertTimeGrainType can be used interchangeably with AlertTimeGrainType, this enum contains the known values that the service supports. Known values supported by the service None Monthly Quarterly Annually BillingMonth BillingQuarter BillingAnnual
AlertType	type of alert KnownAlertType can be used interchangeably with AlertType, this enum contains the known values that the service supports. Known values supported by the service Budget Invoice Credit Quota General xCloud BudgetForecast
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BenefitKind	Kind/type of the benefit. KnownBenefitKind can be used interchangeably with BenefitKind, this enum contains the known values that the service supports. Known values supported by the service IncludedQuantity: Benefit is IncludedQuantity. Reservation: Benefit is Reservation. SavingsPlan: Benefit is SavingsPlan.
BenefitRecommendationPropertiesUnion	Alias for BenefitRecommendationPropertiesUnion
BenefitUtilizationSummaryReportSchema	The CSV file from the reportUrl and secondaryReportUrl blob link will consist of the following columns of benefit utilization data. UtilizedPercentage will be 0 for savings plans reports and non data bricks reservations. Utilization percentages will be 0 for data bricks reservations. KnownBenefitUtilizationSummaryReportSchema can be used interchangeably with BenefitUtilizationSummaryReportSchema, this enum contains the known values that the service supports. Known values supported by the service Kind AvgUtilizationPercentage BenefitOrderId BenefitId BenefitType MaxUtilizationPercentage MinUtilizationPercentage UsageDate UtilizedPercentage
BenefitUtilizationSummaryUnion	Alias for BenefitUtilizationSummaryUnion
BudgetNotificationOperatorType	The comparison operator. Supported for CategoryType(s): Cost, ReservationUtilization. Supported operators for CategoryType: Cost GreaterThan GreaterThanOrEqualTo Supported operators for CategoryType: ReservationUtilization LessThan KnownBudgetNotificationOperatorType can be used interchangeably with BudgetNotificationOperatorType, this enum contains the known values that the service supports. Known values supported by the service EqualTo: Notification 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. Supported for CategoryType(s): Cost. GreaterThan: Notification will be triggered if the evaluated cost is greater than the threshold value. Note: This is the recommended OperatorType while configuring Budget Alert. Supported for CategoryType(s): Cost. GreaterThanOrEqualTo: Notification will be triggered if the evaluated cost is greater than or equal to the threshold value. Supported for CategoryType(s): Cost. LessThan: Notification will be triggered if any Reservations in the scope of the Reservation Utilization Alert Rule have a utilization less than the threshold percentage. Supported for CategoryType(s): ReservationUtilization.
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. 'Cost' defines a Budget. 'ReservationUtilization' defines a Reservation Utilization Alert Rule. KnownCategoryType can be used interchangeably with CategoryType, this enum contains the known values that the service supports. Known values supported by the service Cost: A Budget that evaluates monetary cost of Azure resources against an amount, and alerts based on a configured notification threshold. ReservationUtilization: An Alert Rule that evaluates the utilization percentage of Azure Reservations, and alerts based on a configured notification threshold.
ChartType	Chart type of the main view in Cost Analysis. Required. KnownChartType can be used interchangeably with ChartType, this enum contains the known values that the service supports. Known values supported by the service Area Line StackedColumn GroupedColumn Table
CheckNameAvailabilityReason	Possible reasons for a name not being available. KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports. Known values supported by the service Invalid: Name is invalid. AlreadyExists: Name already exists.
CompressionModeType	Allow customers to select compress data for exports. This setting will enable destination file compression scheme at runtime. By default set to None. Gzip is for csv and snappy for parquet. KnownCompressionModeType can be used interchangeably with CompressionModeType, this enum contains the known values that the service supports. Known values supported by the service gzip snappy none
ContinuablePage	An interface that describes a page of results.
CostAllocationPolicyType	Method to use for allocating cost. FixedProportion indicates that cost will be split based on specified percentage values. KnownCostAllocationPolicyType can be used interchangeably with CostAllocationPolicyType, this enum contains the known values that the service supports. Known values supported by the service FixedProportion
CostAllocationResourceType	Category of resource to use for allocation. KnownCostAllocationResourceType can be used interchangeably with CostAllocationResourceType, this enum contains the known values that the service supports. Known values supported by the service Dimension: Indicates an Azure dimension such as a subscription id or resource group name is being used for allocation. Tag: Allocates cost based on Azure Tag key value pairs.
CostDetailsDataFormat	The data format of the report KnownCostDetailsDataFormat can be used interchangeably with CostDetailsDataFormat, this enum contains the known values that the service supports. Known values supported by the service Csv: Csv data format.
CostDetailsMetricType	The type of the detailed report. By default ActualCost is provided KnownCostDetailsMetricType can be used interchangeably with CostDetailsMetricType, this enum contains the known values that the service supports. Known values supported by the service ActualCost: Actual cost data. AmortizedCost: Amortized cost data.
CostDetailsStatusType	The status of the cost details operation KnownCostDetailsStatusType can be used interchangeably with CostDetailsStatusType, this enum contains the known values that the service supports. Known values supported by the service Completed: Operation is Completed. NoDataFound: Operation is Completed and no cost data found. Failed: Operation Failed.
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, Supported for CategoryType(s): Cost, ReservationUtilization. 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
DataOverwriteBehaviorType	Allow customers to select overwrite data(OverwritePreviousReport) for exports. This setting will enable overwrite data for the same month in customer storage account. By default set to CreateNewReport. KnownDataOverwriteBehaviorType can be used interchangeably with DataOverwriteBehaviorType, this enum contains the known values that the service supports. Known values supported by the service OverwritePreviousReport CreateNewReport
DaysOfWeek	Days of Week. KnownDaysOfWeek can be used interchangeably with DaysOfWeek, this enum contains the known values that the service supports. Known values supported by the service Monday Tuesday Wednesday Thursday Friday Saturday Sunday
DestinationType	The export delivery destination type. Currently only 'AzureBlob' is supported. KnownDestinationType can be used interchangeably with DestinationType, this enum contains the known values that the service supports. Known values supported by the service AzureBlob
ExecutionStatus	The last known status of the export run. KnownExecutionStatus can be used interchangeably with ExecutionStatus, this enum contains the known values that the service supports. Known values supported by the service Queued InProgress Completed Failed Timeout NewDataNotAvailable DataNotAvailable
ExecutionType	The type of the export run. KnownExecutionType can be used interchangeably with ExecutionType, this enum contains the known values that the service supports. Known values supported by the service OnDemand Scheduled
ExportType	The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations. KnownExportType can be used interchangeably with ExportType, this enum contains the known values that the service supports. Known values supported by the service Usage ActualCost AmortizedCost FocusCost PriceSheet ReservationTransactions ReservationRecommendations ReservationDetails
ExternalCloudProviderType	Type of ExternalCloudProviderType
FileFormat	Destination of the view data. Currently only CSV format is supported. KnownFileFormat can be used interchangeably with FileFormat, this enum contains the known values that the service supports. Known values supported by the service Csv
FilterItemNames	The name of the filter. This is currently only supported for Export Definition type of ReservationRecommendations. Supported names are ['ReservationScope', 'LookBackPeriod', 'ResourceType'] KnownFilterItemNames can be used interchangeably with FilterItemNames, this enum contains the known values that the service supports. Known values supported by the service ReservationScope ResourceType LookBackPeriod
ForecastOperatorType	The operator to use for comparison. KnownForecastOperatorType can be used interchangeably with ForecastOperatorType, this enum contains the known values that the service supports. Known values supported by the service In
ForecastTimeframe	The time frame for pulling data for the forecast. KnownForecastTimeframe can be used interchangeably with ForecastTimeframe, this enum contains the known values that the service supports. Known values supported by the service Custom
ForecastType	The type of the forecast. KnownForecastType can be used interchangeably with ForecastType, this enum contains the known values that the service supports. Known values supported by the service Usage ActualCost AmortizedCost
FormatType	The format of the export being delivered. KnownFormatType can be used interchangeably with FormatType, this enum contains the known values that the service supports. Known values supported by the service Csv Parquet
Frequency	Frequency of a notification. Represents how long the notification will be silent after triggering an alert for a threshold breach. If not specified, the frequency will be set by default based on the timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days). Supported for CategoryType(s): ReservationUtilization. KnownFrequency can be used interchangeably with Frequency, this enum contains the known values that the service supports. Known values supported by the service Daily: After the threshold breaches and an Alert is fired, no further alerts will be sent until the next calendar day. Weekly: After the threshold breaches and an Alert is fired, no further alerts will be sent for 7 calendar days. Monthly: After the threshold breaches and an Alert is fired, no further alerts will be sent for 30 calendar days.
FunctionName	The name of the column to aggregate. KnownFunctionName can be used interchangeably with FunctionName, this enum contains the known values that the service supports. Known values supported by the service PreTaxCostUSD Cost CostUSD PreTaxCost
FunctionType	The name of the aggregation function to use. KnownFunctionType can be used interchangeably with FunctionType, this enum contains the known values that the service supports. Known values supported by the service Sum
GenerateDetailedCostReportMetricType	The type of the detailed report. By default ActualCost is provided KnownGenerateDetailedCostReportMetricType can be used interchangeably with GenerateDetailedCostReportMetricType, this enum contains the known values that the service supports. Known values supported by the service ActualCost AmortizedCost
Grain	Grain which corresponds to value. KnownGrain can be used interchangeably with Grain, this enum contains the known values that the service supports. Known values supported by the service Hourly: Hourly grain corresponds to value per hour. Daily: Hourly grain corresponds to value per day. Monthly: Hourly grain corresponds to value per month.
GrainParameter	Type of GrainParameter
GranularityType	The granularity of rows in the export. Currently 'Daily' is supported for most cases. KnownGranularityType can be used interchangeably with GranularityType, this enum contains the known values that the service supports. Known values supported by the service Daily Monthly
KpiType	KPI type (Forecast, Budget). KnownKpiType can be used interchangeably with KpiType, this enum contains the known values that the service supports. Known values supported by the service Forecast Budget
LookBackPeriod	The number of days used to look back. KnownLookBackPeriod can be used interchangeably with LookBackPeriod, this enum contains the known values that the service supports. Known values supported by the service Last7Days: 7 days used to look back. Last30Days: 30 days used to look back. Last60Days: 60 days used to look back.
MetricType	Metric to use when displaying costs. KnownMetricType can be used interchangeably with MetricType, this enum contains the known values that the service supports. Known values supported by the service ActualCost AmortizedCost AHUB
OperationStatusType	Enum representing the status of an async 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 operator to use for comparison. KnownOperatorType can be used interchangeably with OperatorType, this enum contains the known values that the service supports. Known values supported by the service In Contains
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
PivotType	Data type to show in view. KnownPivotType can be used interchangeably with PivotType, this enum contains the known values that the service supports. Known values supported by the service Dimension TagKey
QueryColumnType	The type of the column in the report. KnownQueryColumnType can be used interchangeably with QueryColumnType, this enum contains the known values that the service supports. Known values supported by the service TagKey: The tag associated with the cost data. Dimension: The dimension of cost data.
QueryOperatorType	The operator to use for comparison. KnownQueryOperatorType can be used interchangeably with QueryOperatorType, this enum contains the known values that the service supports. Known values supported by the service In
Reason	The reason this name is not available. KnownReason can be used interchangeably with Reason, this enum contains the known values that the service supports. Known values supported by the service Invalid AlreadyExists Valid
RecurrenceType	The schedule recurrence. KnownRecurrenceType can be used interchangeably with RecurrenceType, this enum contains the known values that the service supports. Known values supported by the service Daily Weekly Monthly Annually
ReportConfigSortingType	Direction of sort. KnownReportConfigSortingType can be used interchangeably with ReportConfigSortingType, this enum contains the known values that the service supports. Known values supported by the service Ascending Descending
ReportGranularityType	The granularity of rows in the report. KnownReportGranularityType can be used interchangeably with ReportGranularityType, this enum contains the known values that the service supports. Known values supported by the service Daily Monthly
ReportOperationStatusType	The status of the long running operation. KnownReportOperationStatusType can be used interchangeably with ReportOperationStatusType, this enum contains the known values that the service supports. Known values supported by the service InProgress Completed Failed Queued NoDataFound ReadyToDownload TimedOut
ReportTimeframeType	The time frame for pulling data for the report. If custom, then a specific time period must be provided. KnownReportTimeframeType can be used interchangeably with ReportTimeframeType, this enum contains the known values that the service supports. Known values supported by the service WeekToDate MonthToDate YearToDate Custom
ReportType	The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates. KnownReportType can be used interchangeably with ReportType, this enum contains the known values that the service supports. Known values supported by the service Usage
ReservationReportSchema	The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity KnownReservationReportSchema can be used interchangeably with ReservationReportSchema, this enum contains the known values that the service supports. Known values supported by the service InstanceFlexibilityGroup InstanceFlexibilityRatio InstanceId Kind ReservationId ReservationOrderId ReservedHours SkuName TotalReservedQuantity UsageDate UsedHours
RuleStatus	Current status of the rule. KnownRuleStatus can be used interchangeably with RuleStatus, this enum contains the known values that the service supports. Known values supported by the service NotActive: Rule is saved but not used to allocate costs. Active: Rule is saved and impacting cost allocation. Processing: Rule is saved and cost allocation is being updated. Readonly value that cannot be submitted in a put request.
ScheduleFrequency	Frequency of the schedule. KnownScheduleFrequency can be used interchangeably with ScheduleFrequency, this enum contains the known values that the service supports. Known values supported by the service Daily: Cost analysis data will be emailed every day. Weekly: Cost analysis data will be emailed every week. Monthly: Cost analysis data will be emailed every month.
ScheduledActionKind	Kind of the scheduled action. KnownScheduledActionKind can be used interchangeably with ScheduledActionKind, this enum contains the known values that the service supports. Known values supported by the service Email: Cost analysis data will be emailed. InsightAlert: Cost anomaly information will be emailed. Available only on subscription scope at daily frequency. If no anomaly is detected on the resource, an email won't be sent.
ScheduledActionStatus	Status of the scheduled action. KnownScheduledActionStatus can be used interchangeably with ScheduledActionStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled: Scheduled action is saved and will be run. Expired: Scheduled action is expired. Disabled: Scheduled action is saved but will not be run.
Scope	Kind of the recommendation scope. KnownScope can be used interchangeably with Scope, this enum contains the known values that the service supports. Known values supported by the service Single: Single scope recommendation. Shared: Shared scope recommendation.
SettingType	Type of SettingType
SettingUnion	Alias for SettingUnion
SettingsKind	Specifies the kind of settings. KnownSettingsKind can be used interchangeably with SettingsKind, this enum contains the known values that the service supports. Known values supported by the service taginheritance
StatusType	The status of the export's schedule. If 'Inactive', the export's schedule is paused. To enable export set the status to be Active and then make a PUT request. KnownStatusType can be used interchangeably with StatusType, this enum contains the known values that the service supports. Known values supported by the service Active Inactive
SystemAssignedServiceIdentityType	Type of managed service identity (either system assigned, or none). KnownSystemAssignedServiceIdentityType can be used interchangeably with SystemAssignedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed system identity. SystemAssigned: System assigned managed system identity.
Term	Grain which corresponds to value. KnownTerm can be used interchangeably with Term, this enum contains the known values that the service supports. Known values supported by the service P1Y: Benefit term is 1 year. P3Y: Benefit term is 3 years.
ThresholdType	The type of threshold. Supported for CategoryType(s): Cost. 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. Supported for CategoryType(s): Cost, ReservationUtilization. Supported timeGrainTypes for CategoryType: Cost Monthly Quarterly Annually BillingMonth* BillingQuarter* BillingAnnual* *only supported for Web Direct customers. Supported timeGrainTypes for CategoryType: ReservationUtilization Last7Days Last30Days Required for CategoryType(s): Cost, ReservationUtilization. KnownTimeGrainType can be used interchangeably with TimeGrainType, this enum contains the known values that the service supports. Known values supported by the service Monthly: The budget will track costs in the current calendar month against the amount. Supported for CategoryType: Cost only. Quarterly: The budget will track costs in the current calendar quarter against the amount. Supported for CategoryType: Cost only. Annually: The budget will track costs in the current calendar year against the amount. Supported for CategoryType: Cost only. BillingMonth: The budget will track costs in the current billing month against the amount. Supported for CategoryType: Cost and Web Direct customers only. BillingQuarter: The budget will track costs in the current billing quarter against the amount. Supported for CategoryType: Cost and Web Direct customers only. BillingAnnual: The budget will track costs in the current billing year against the amount. Supported for CategoryType: Cost and Web Direct customers only. Last7Days: The Reservation Utilization Alert Rule will evaluate reservations based on their 7-Day utilization percentage. Supported for CategoryType: ReservationUtilization only. Last30Days: The Reservation Utilization Alert Rule will evaluate reservations based on their 30-Day utilization percentage. Supported for CategoryType: ReservationUtilization only.
TimeframeType	The time frame for pulling data for the export. If custom, then a specific time period must be provided. KnownTimeframeType can be used interchangeably with TimeframeType, this enum contains the known values that the service supports. Known values supported by the service MonthToDate BillingMonthToDate TheLastMonth TheLastBillingMonth WeekToDate Custom TheCurrentMonth
WeeksOfMonth	Weeks of month. KnownWeeksOfMonth can be used interchangeably with WeeksOfMonth, this enum contains the known values that the service supports. Known values supported by the service First Second Third Fourth Last

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAccumulatedType	Show costs accumulated over time.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAlertCategory	Alert category
KnownAlertCriteria	Criteria that triggered alert
KnownAlertOperator	operator used to compare currentSpend with amount
KnownAlertSource	Source of alert
KnownAlertStatus	alert status
KnownAlertTimeGrainType	Type of timegrain cadence
KnownAlertType	type of alert
KnownBenefitKind	Kind/type of the benefit.
KnownBenefitUtilizationSummaryReportSchema	The CSV file from the reportUrl and secondaryReportUrl blob link will consist of the following columns of benefit utilization data. UtilizedPercentage will be 0 for savings plans reports and non data bricks reservations. Utilization percentages will be 0 for data bricks reservations.
KnownBudgetNotificationOperatorType	The comparison operator. Supported for CategoryType(s): Cost, ReservationUtilization. Supported operators for CategoryType: Cost GreaterThan GreaterThanOrEqualTo Supported operators for CategoryType: ReservationUtilization LessThan
KnownBudgetOperatorType	The operator to use for comparison.
KnownCategoryType	The category of the budget. 'Cost' defines a Budget. 'ReservationUtilization' defines a Reservation Utilization Alert Rule.
KnownChartType	Chart type of the main view in Cost Analysis. Required.
KnownCheckNameAvailabilityReason	Possible reasons for a name not being available.
KnownCompressionModeType	Allow customers to select compress data for exports. This setting will enable destination file compression scheme at runtime. By default set to None. Gzip is for csv and snappy for parquet.
KnownCostAllocationPolicyType	Method to use for allocating cost. FixedProportion indicates that cost will be split based on specified percentage values.
KnownCostAllocationResourceType	Category of resource to use for allocation.
KnownCostDetailsDataFormat	The data format of the report
KnownCostDetailsMetricType	The type of the detailed report. By default ActualCost is provided
KnownCostDetailsStatusType	The status of the cost details operation
KnownCreatedByType	The kind of entity that created the resource.
KnownCultureCode	Language in which the recipient will receive the notification, Supported for CategoryType(s): Cost, ReservationUtilization.
KnownDataOverwriteBehaviorType	Allow customers to select overwrite data(OverwritePreviousReport) for exports. This setting will enable overwrite data for the same month in customer storage account. By default set to CreateNewReport.
KnownDaysOfWeek	Days of Week.
KnownDestinationType	The export delivery destination type. Currently only 'AzureBlob' is supported.
KnownExecutionStatus	The last known status of the export run.
KnownExecutionType	The type of the export run.
KnownExportType	The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations.
KnownExternalCloudProviderType	Known values of ExternalCloudProviderType that the service accepts.
KnownFileFormat	Destination of the view data. Currently only CSV format is supported.
KnownFilterItemNames	The name of the filter. This is currently only supported for Export Definition type of ReservationRecommendations. Supported names are ['ReservationScope', 'LookBackPeriod', 'ResourceType']
KnownForecastOperatorType	The operator to use for comparison.
KnownForecastTimeframe	The time frame for pulling data for the forecast.
KnownForecastType	The type of the forecast.
KnownFormatType	The format of the export being delivered.
KnownFrequency	Frequency of a notification. Represents how long the notification will be silent after triggering an alert for a threshold breach. If not specified, the frequency will be set by default based on the timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days). Supported for CategoryType(s): ReservationUtilization.
KnownFunctionName	The name of the column to aggregate.
KnownFunctionType	The name of the aggregation function to use.
KnownGenerateDetailedCostReportMetricType	The type of the detailed report. By default ActualCost is provided
KnownGrain	Grain which corresponds to value.
KnownGrainParameter	Known values of GrainParameter that the service accepts.
KnownGranularityType	The granularity of rows in the export. Currently 'Daily' is supported for most cases.
KnownKpiType	KPI type (Forecast, Budget).
KnownLookBackPeriod	The number of days used to look back.
KnownMetricType	Metric to use when displaying costs.
KnownOperationStatusType	Enum representing the status of an async operation.
KnownOperatorType	The operator to use for comparison.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPivotType	Data type to show in view.
KnownQueryColumnType	The type of the column in the report.
KnownQueryOperatorType	The operator to use for comparison.
KnownReason	The reason this name is not available.
KnownRecurrenceType	The schedule recurrence.
KnownReportConfigSortingType	Direction of sort.
KnownReportGranularityType	The granularity of rows in the report.
KnownReportOperationStatusType	The status of the long running operation.
KnownReportTimeframeType	The time frame for pulling data for the report. If custom, then a specific time period must be provided.
KnownReportType	The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates.
KnownReservationReportSchema	The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity
KnownRuleStatus	Current status of the rule.
KnownScheduleFrequency	Frequency of the schedule.
KnownScheduledActionKind	Kind of the scheduled action.
KnownScheduledActionStatus	Status of the scheduled action.
KnownScope	Kind of the recommendation scope.
KnownSettingType	Known values of SettingType that the service accepts.
KnownSettingsKind	Specifies the kind of settings.
KnownStatusType	The status of the export's schedule. If 'Inactive', the export's schedule is paused. To enable export set the status to be Active and then make a PUT request.
KnownSystemAssignedServiceIdentityType	Type of managed service identity (either system assigned, or none).
KnownTerm	Grain which corresponds to value.
KnownThresholdType	The type of threshold. Supported for CategoryType(s): Cost.
KnownTimeGrainType	The time covered by a budget. Tracking of the amount will be reset based on the time grain. Supported for CategoryType(s): Cost, ReservationUtilization. Supported timeGrainTypes for CategoryType: Cost Monthly Quarterly Annually BillingMonth* BillingQuarter* BillingAnnual* *only supported for Web Direct customers. Supported timeGrainTypes for CategoryType: ReservationUtilization Last7Days Last30Days Required for CategoryType(s): Cost, ReservationUtilization.
KnownTimeframeType	The time frame for pulling data for the export. If custom, then a specific time period must be provided.
KnownVersions	The available API versions.
KnownWeeksOfMonth	Weeks of month.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(CostManagementClient, 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>(CostManagementClient, 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: CostManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

CostManagementClient

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