ViewProperties interface

Package:

@azure/arm-costmanagement

The properties of the view.

Properties

accumulated	Show costs accumulated over time.
chart	Chart type of the main view in Cost Analysis. Required.
createdOn	Date the user created this view.
currency	Currency of the current view.
dataSet	Has definition for data in this report config.
dateRange	Date range of the current view.
displayName	User input name of the view. Required.
includeMonetaryCommitment	If true, report includes monetary commitment.
kpis	List of KPIs to show in Cost Analysis UI.
metric	Metric to use when displaying costs.
modifiedOn	Date when the user last modified this view.
pivots	Configuration of 3 sub-views in the Cost Analysis UI.
scope	Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.
timeframe	The time frame for pulling data for the report. If custom, then a specific time period must be provided.
timePeriod	Has time period for pulling data for the report.
type	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.

Property Details

accumulated

Show costs accumulated over time.

accumulated?: string

Property Value

string

chart

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

chart?: string

Property Value

string

createdOn

Date the user created this view.

createdOn?: Date

Property Value

Date

currency

Currency of the current view.

currency?: string

Property Value

string

dataSet

Has definition for data in this report config.

dataSet?: ReportConfigDataset

Property Value

ReportConfigDataset

dateRange

Date range of the current view.

dateRange?: string

Property Value

string

displayName

User input name of the view. Required.

displayName?: string

Property Value

string

includeMonetaryCommitment

If true, report includes monetary commitment.

includeMonetaryCommitment?: boolean

Property Value

boolean

kpis

List of KPIs to show in Cost Analysis UI.

kpis?: KpiProperties[]

Property Value

KpiProperties[]

metric

Metric to use when displaying costs.

metric?: string

Property Value

string

modifiedOn

Date when the user last modified this view.

modifiedOn?: Date

Property Value

Date

pivots

Configuration of 3 sub-views in the Cost Analysis UI.

pivots?: PivotProperties[]

Property Value

PivotProperties[]

scope

Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.

scope?: string

Property Value

string

timeframe

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

timeframe?: string

Property Value

string

timePeriod

Has time period for pulling data for the report.

timePeriod?: ReportConfigTimePeriod

Property Value

ReportConfigTimePeriod

type

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.

type?: string

Property Value

string