View Class

States and configurations of Cost Analysis.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.costmanagement.models._models_py3.ProxyResource

View

Constructor

View(*, e_tag: Optional[str] = None, display_name: Optional[str] = None, scope: Optional[str] = None, chart: Optional[Union[str, azure.mgmt.costmanagement.models._cost_management_client_enums.ChartType]] = None, accumulated: Optional[Union[str, azure.mgmt.costmanagement.models._cost_management_client_enums.AccumulatedType]] = None, metric: Optional[Union[str, azure.mgmt.costmanagement.models._cost_management_client_enums.MetricType]] = None, kpis: Optional[List[azure.mgmt.costmanagement.models._models_py3.KpiProperties]] = None, pivots: Optional[List[azure.mgmt.costmanagement.models._models_py3.PivotProperties]] = None, type_properties_query_type: Optional[Union[str, azure.mgmt.costmanagement.models._cost_management_client_enums.ReportType]] = None, timeframe: Optional[Union[str, azure.mgmt.costmanagement.models._cost_management_client_enums.ReportTimeframeType]] = None, time_period: Optional[azure.mgmt.costmanagement.models._models_py3.ReportConfigTimePeriod] = None, data_set: Optional[azure.mgmt.costmanagement.models._models_py3.ReportConfigDataset] = None, **kwargs)

Parameters

e_tag

str

Required

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.

display_name

str

Required

User input name of the view. Required.

scope

str

Required

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.

chart

str or ChartType

Required

Chart type of the main view in Cost Analysis. Required. Possible values include: "Area", "Line", "StackedColumn", "GroupedColumn", "Table".

accumulated

str or AccumulatedType

Required

Show costs accumulated over time. Possible values include: "true", "false".

metric

str or MetricType

Required

Metric to use when displaying costs. Possible values include: "ActualCost", "AmortizedCost", "AHUB".

kpis

list[KpiProperties]

Required

List of KPIs to show in Cost Analysis UI.

pivots

list[PivotProperties]

Required

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

type_properties_query_type

str or ReportType

Required

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. Possible values include: "Usage".

timeframe

str or ReportTimeframeType

Required

The time frame for pulling data for the report. If custom, then a specific time period must be provided. Possible values include: "WeekToDate", "MonthToDate", "YearToDate", "Custom".

time_period

ReportConfigTimePeriod

Required

Has time period for pulling data for the report.

data_set

ReportConfigDataset

Required

Has definition for data in this report config.

Variables

id

str

Resource Id.

name

str

Resource name.

type

str

Resource type.

created_on

datetime

Date the user created this view.

modified_on

datetime

Date when the user last modified this view.

date_range

str

Selected date range for viewing cost in.

currency

str

Selected currency.

include_monetary_commitment

bool

Include monetary commitment.