Azure.ResourceManager.CostManagement.Models Namespace

Classes

AlertPropertiesDefinition

defines the type of alert.

AlertPropertiesDetails

Alert details.

AllSavingsBenefitDetails

Benefit recommendation details.

AllSavingsList

The list of all benefit recommendations with the recommendation details.

ArmCostManagementModelFactory

Model factory for models.

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. Please note BenefitRecommendationProperties is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SharedScopeBenefitRecommendationProperties and SingleScopeBenefitRecommendationProperties.

BenefitUtilizationSummariesContent

Properties of an async benefit utilization summaries request.

BenefitUtilizationSummariesOperationStatus

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

BenefitUtilizationSummary

Benefit utilization summary resource. Please note BenefitUtilizationSummary is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include IncludedQuantityUtilizationSummary and SavingsPlanUtilizationSummary.

CommonExportProperties

The common properties of the export.

CostManagementAlertPatch

The request payload to update an alert.

CostManagementDimension

List of Dimension.

CostManagementNameAvailabilityContent

The check availability request body.

CostManagementNameAvailabilityResult

The check availability result.

DownloadURL

The URL to download the generated report.

ExportDataset

The definition for data in the export.

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.

ExportRecurrencePeriod

The start and end date for recurrence schedule.

ExportRun

An export run.

ExportRunErrorDetails

The details of the error.

ExportSchedule

The schedule associated with the export.

ExportTimePeriod

The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months.

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.

ForecastDefinition

The definition of a forecast.

ForecastFilter

The filter expression to be used in the export.

ForecastResult

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

ForecastTimePeriod

Has time period for pulling data for the forecast.

IncludedQuantityUtilizationSummary

Included Quantity utilization summary resource.

NotificationProperties

The properties of the scheduled action notification.

OperationStatus

The status of the long running operation.

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.

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.

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.

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.

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.

SavingsPlanUtilizationSummary

Savings plan utilization summary resource.

ScheduleProperties

The properties of the schedule.

SharedScopeBenefitRecommendationProperties

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

SingleScopeBenefitRecommendationProperties

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

TenantResourceByExternalCloudProviderTypeDimensionsOptions

The TenantResourceByExternalCloudProviderTypeDimensionsOptions.

ViewKpiProperties

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

ViewPivotProperties

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

Structs

AccumulatedType

Show costs accumulated over time.

AlertCriterion

Criteria that triggered alert.

AlertTimeGrainType

Type of timegrain cadence.

BenefitRecommendationPeriodTerm

Grain which corresponds to value.

BenefitRecommendationUsageGrain

Grain which corresponds to value.

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.

BillingAccountBenefitKind

Kind/type of the benefit.

ComparisonOperatorType

The operator to use for comparison.

CostManagementAlertCategory

Alert category.

CostManagementAlertOperator

operator used to compare currentSpend with amount.

CostManagementAlertSource

Source of alert.

CostManagementAlertStatus

alert status.

CostManagementAlertType

type of alert.

CostManagementUnavailabilityReason

The reason why the given name is not available.

ExportFormatType

The format of the export being delivered. Currently only 'Csv' is supported.

ExportRunExecutionStatus

The last known status of the export run.

ExportRunExecutionType

The type of the export run.

ExportScheduleRecurrenceType

The schedule recurrence.

ExportScheduleStatusType

The status of the export's schedule. If 'Inactive', the export's schedule is paused.

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.

ExternalCloudProviderType

The ExternalCloudProviderType.

ForecastOperatorType

The operator to use for comparison.

ForecastTimeframe

The time frame for pulling data for the forecast.

ForecastType

The type of the forecast.

FunctionName

The name of the column to aggregate.

FunctionType

The name of the aggregation function to use.

GrainContent

The GrainContent.

GranularityType

The granularity of rows in the export. Currently only 'Daily' is supported.

LookBackPeriod

The number of days used to look back.

OperationStatusType

Enum representing the status of an async operation.

QueryColumnType

The type of the column in the report.

QueryOperatorType

The operator to use for comparison.

ReportConfigSortingType

Direction of sort.

ReportGranularityType

The granularity of rows in the report.

ReportTimeframeType

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

ReservationReportSchema

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

ScheduledActionDaysOfWeek

Days of Week.

ScheduledActionFileFormat

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

ScheduledActionKind

Kind of the scheduled action.

ScheduledActionStatus

Status of the scheduled action.

ScheduledActionWeeksOfMonth

Weeks of month.

ScheduleFrequency

Frequency of the schedule.

TimeframeType

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

ViewChartType

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

ViewKpiType

KPI type (Forecast, Budget).

ViewMetricType

Metric to use when displaying costs.

ViewPivotType

Data type to show in view.

ViewReportType

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.