Azure.ResourceManager.CostManagement.Models Namespace

defines the type of alert.

Alert details.

Benefit recommendation details.

The list of all benefit recommendations with the recommendation details.

A factory class for creating instances of the models for mocking.

Object representing the report url and valid until date of the async report generated.

The benefit resource model definition.

benefit plan recommendation details.

The properties of the benefit recommendations. Please note this is the abstract base class. The derived classes available for instantiation are: SingleScopeBenefitRecommendationProperties and SharedScopeBenefitRecommendationProperties.

Properties of an async benefit utilization summaries request.

Status of a benefit utilization summaries report. Provides Async Benefit Utilization Summaries Request input, status, and report sas url.

Benefit utilization summary resource.

The comparison expression to be used in the budgets.

May be used to filter budgets by user-specified dimensions and/or tags. Supported for CategoryType(s): Cost, ReservationUtilization.

The Dimensions or Tags to filter a budget by. Supported for CategoryType(s): Cost, ReservationUtilization.

The notification associated with a budget. Supported for CategoryType(s): Cost, ReservationUtilization.

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.

The common properties of the export.

Common values for resources for cost allocation.

Target resources and allocation.

Resource details of the cost allocation rule.

The properties of a cost allocation rule.

The result of the long running operation for cost details Api.

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.

The request payload to update an alert.

List of Dimension.

The check availability request body.

The check availability result.

The current amount of cost which is being tracked for a budget. Supported for CategoryType(s): Cost.

The URL to download the generated report.

The details of the error.

The blob information generated by this operation.

The definition for data in the export.

The definition of an export.

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 ).

The delivery information associated with a export.

The properties of the export.

The start and end date for recurrence schedule.

An export run.

The export run request.

The details of the error.

The schedule associated with the export.

The properties of the export run. This is not populated currently.

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.

Will contain the filter name and value to operate on. This is currently only supported for Export Definition type of ReservationRecommendations.

The aggregation expression to be used in the forecast.

Forecast column properties.

The comparison expression to be used in the forecast.

The definition of data present in the forecast.

The definition of a forecast.

The filter expression to be used in the export.

Result of forecast. It contains all columns listed under groupings and aggregation.

The forecasted cost which is being tracked for a budget. Supported for CategoryType(s): Cost.

Has time period for pulling data for the forecast.

The definition of a cost detailed report.

The definition of a cost detailed report.

The start and end date for pulling data for the cost detailed report.

Included Quantity utilization summary resource.

The properties of the price sheet.

The properties of the scheduled action notification.

The status of the long running operation.

The URL to download the generated report.

The aggregation expression to be used in the query.

QueryColumn properties.

The comparison expression to be used in the query.

The definition of data present in the query.

The definition of a query.

The filter expression to be used in the export.

The group by expression to be used in the query.

Result of query. It contains all columns listed under groupings and aggregation.

The start and end date for pulling data for the query.

On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.

The aggregation expression to be used in the report.

The comparison expression to be used in the report.

The definition of data present in the report.

The filter expression to be used in the report.

The group by expression to be used in the report.

The order by expression to be used in the report.

The start and end date for pulling data for the report.

Savings plan utilization summary resource.

The properties of the schedule.

The properties of the benefit recommendation when scope is 'Shared'.

The properties of the benefit recommendations when scope is 'Single'.

Source resources for cost allocation.

Tag Inheritance Setting definition.

Target resources for cost allocation.

Each KPI must contain a 'type' and 'enabled' key.

Each pivot must contain a 'type' and 'name'.

Show costs accumulated over time.

Criteria that triggered alert.

Type of timegrain cadence.

Grain which corresponds to value.

Grain which corresponds to value.

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.

Kind/type of the benefit.

The comparison operator. Supported for CategoryType(s): Cost, ReservationUtilization. Supported operators for CategoryType: Cost

• GreaterThan
• GreaterThanOrEqualTo

• LessThan

The operator to use for comparison.

The category of the budget.

• 'Cost' defines a Budget.
• 'ReservationUtilization' defines a Reservation Utilization Alert Rule.

The operator to use for comparison.

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.

Method to use for allocating cost. FixedProportion indicates that cost will be split based on specified percentage values.

Category of resource to use for allocation.

The data format of the report.

The type of the detailed report. By default ActualCost is provided.

The status of the cost details operation.

Alert category.

operator used to compare currentSpend with amount.

Source of alert.

alert status.

type of alert.

Possible reasons for a name not being available.

Language in which the recipient will receive the notification, Supported for CategoryType(s): Cost, ReservationUtilization.

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.

The export delivery destination type. Currently only 'AzureBlob' is supported.

The format of the export being delivered.

The last known status of the export run.

The type of the export run.

The schedule recurrence.

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.

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.

The name of the filter. This is currently only supported for Export Definition type of ReservationRecommendations. Supported names are ['ReservationScope', 'LookBackPeriod', 'ResourceType'].

The operator to use for comparison.

The time frame for pulling data for the forecast.

The type of the forecast.

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.

The name of the column to aggregate.

The name of the aggregation function to use.

The type of the detailed report. By default ActualCost is provided.

The granularity of rows in the export. Currently 'Daily' is supported for most cases.

The number of days used to look back.

Enum representing the status of an async operation.

The type of the column in the report.

The operator to use for comparison.

Direction of sort.

The granularity of rows in the report.

The status of the long running operation.

The time frame for pulling data for the report. If custom, then a specific time period must be provided.

The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity.

Current status of the rule.

Days of Week.

Destination of the view data. Currently only CSV format is supported.

Kind of the scheduled action.

Status of the scheduled action.

Weeks of month.

Frequency of the schedule.

The type of threshold. Supported for CategoryType(s): Cost.

The time frame for pulling data for the export. If custom, then a specific time period must be provided.

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*

• Last7Days
• Last30Days

Chart type of the main view in Cost Analysis. Required.

KPI type (Forecast, Budget).

Metric to use when displaying costs.

Data type to show in view.

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.