View interface

Package:
@azure/arm-costmanagement

States and configurations of Cost Analysis.

Extends
ProxyResource

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

Date range of the current view.
displayName

User input name of the view. Required.
eTag

eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
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.
query

Query body configuration. Required.
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.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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

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

eTag

eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.

eTag?: string

Property Value

string

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[]

query

Query body configuration. Required.

query?: ReportConfigDefinition

Property Value

ReportConfigDefinition

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

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type