View Interface

  • Reference
Package:
com.azure.resourcemanager.costmanagement.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-costmanagement:1.0.0-beta.6

public interface View

An immutable client-side representation of View.

Method Summary

Modifier and Type Method and Description
abstract AccumulatedType accumulated()

Gets the accumulated property: Show costs accumulated over time.
abstract ChartType chart()

Gets the chart property: Chart type of the main view in Cost Analysis.
abstract OffsetDateTime createdOn()

Gets the createdOn property: Date the user created this view.
abstract String currency()

Gets the currency property: Currency of the current view.
abstract ReportConfigDataset dataSet()

Gets the dataSet property: Has definition for data in this report config.
abstract String dateRange()

Gets the dateRange property: Date range of the current view.
abstract String displayName()

Gets the displayName property: User input name of the view.
abstract String etag()

Gets the etag property: eTag of the resource.
abstract String id()

Gets the id property: Fully qualified resource Id for the resource.
abstract Boolean includeMonetaryCommitment()

Gets the includeMonetaryCommitment property: If true, report includes monetary commitment.
abstract ViewInner innerModel()

Gets the inner com.azure.resourcemanager.costmanagement.fluent.models.ViewInner object.
abstract List<KpiProperties> kpis()

Gets the kpis property: List of KPIs to show in Cost Analysis UI.
abstract MetricType metric()

Gets the metric property: Metric to use when displaying costs.
abstract OffsetDateTime modifiedOn()

Gets the modifiedOn property: Date when the user last modified this view.
abstract String name()

Gets the name property: The name of the resource.
abstract List<PivotProperties> pivots()

Gets the pivots property: Configuration of 3 sub-views in the Cost Analysis UI.
abstract View refresh()

Refreshes the resource to sync with Azure.
abstract View refresh(Context context)

Refreshes the resource to sync with Azure.
abstract String scope()

Gets the scope property: Cost Management scope to save the view on.
abstract ReportConfigTimePeriod timePeriod()

Gets the timePeriod property: Has time period for pulling data for the report.
abstract ReportTimeframeType timeframe()

Gets the timeframe property: The time frame for pulling data for the report.
abstract String type()

Gets the type property: The type of the resource.
abstract ReportType typePropertiesType()

Gets the typePropertiesType property: The type of the report.
abstract Update update()

Begins update for the View resource.

Method Details

accumulated

public abstract AccumulatedType accumulated()

Gets the accumulated property: Show costs accumulated over time.

Returns:

the accumulated value.

chart

public abstract ChartType chart()

Gets the chart property: Chart type of the main view in Cost Analysis. Required.

Returns:

the chart value.

createdOn

public abstract OffsetDateTime createdOn()

Gets the createdOn property: Date the user created this view.

Returns:

the createdOn value.

currency

public abstract String currency()

Gets the currency property: Currency of the current view.

Returns:

the currency value.

dataSet

public abstract ReportConfigDataset dataSet()

Gets the dataSet property: Has definition for data in this report config.

Returns:

the dataSet value.

dateRange

public abstract String dateRange()

Gets the dateRange property: Date range of the current view.

Returns:

the dateRange value.

displayName

public abstract String displayName()

Gets the displayName property: User input name of the view. Required.

Returns:

the displayName value.

etag

public abstract String etag()

Gets the etag property: 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.

Returns:

the etag value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

includeMonetaryCommitment

public abstract Boolean includeMonetaryCommitment()

Gets the includeMonetaryCommitment property: If true, report includes monetary commitment.

Returns:

the includeMonetaryCommitment value.

innerModel

public abstract ViewInner innerModel()

Gets the inner com.azure.resourcemanager.costmanagement.fluent.models.ViewInner object.

Returns:

the inner object.

kpis

public abstract List kpis()

Gets the kpis property: List of KPIs to show in Cost Analysis UI.

Returns:

the kpis value.

metric

public abstract MetricType metric()

Gets the metric property: Metric to use when displaying costs.

Returns:

the metric value.

modifiedOn

public abstract OffsetDateTime modifiedOn()

Gets the modifiedOn property: Date when the user last modified this view.

Returns:

the modifiedOn value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

pivots

public abstract List pivots()

Gets the pivots property: Configuration of 3 sub-views in the Cost Analysis UI.

Returns:

the pivots value.

refresh

public abstract View refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract View refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

scope

public abstract String scope()

Gets the scope property: 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.

Returns:

the scope value.

timePeriod

public abstract ReportConfigTimePeriod timePeriod()

Gets the timePeriod property: Has time period for pulling data for the report.

Returns:

the timePeriod value.

timeframe

public abstract ReportTimeframeType timeframe()

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

Returns:

the timeframe value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

typePropertiesType

public abstract ReportType typePropertiesType()

Gets the typePropertiesType property: 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.

Returns:

the typePropertiesType value.

update

public abstract View.Update update()

Begins update for the View resource.

Returns:

the stage of resource update.

Applies to