Package com.azure.resourcemanager.costmanagement.models

Interface View

public interface View
An immutable client-side representation of View.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    View.Definition
    The entirety of the View definition.
    static interface 
    View.DefinitionStages
    The View definition stages.
    static interface 
    View.Update
    The template for View update.
    static interface 
    View.UpdateStages
    The View update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    AccumulatedType
    accumulated()
    Gets the accumulated property: Show costs accumulated over time.
    ChartType
    chart()
    Gets the chart property: Chart type of the main view in Cost Analysis.
    OffsetDateTime
    createdOn()
    Gets the createdOn property: Date the user created this view.
    ReportConfigDataset
    dataset()
    Gets the dataset property: Has definition for data in this report config.
    String
    displayName()
    Gets the displayName property: User input name of the view.
    String
    etag()
    Gets the etag property: eTag of the resource.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    ViewInner
    innerModel()
    Gets the inner com.azure.resourcemanager.costmanagement.fluent.models.ViewInner object.
    List<KpiProperties>
    kpis()
    Gets the kpis property: List of KPIs to show in Cost Analysis UI.
    MetricType
    metric()
    Gets the metric property: Metric to use when displaying costs.
    OffsetDateTime
    modifiedOn()
    Gets the modifiedOn property: Date when the user last modified this view.
    String
    name()
    Gets the name property: The name of the resource.
    List<PivotProperties>
    pivots()
    Gets the pivots property: Configuration of 3 sub-views in the Cost Analysis UI.
    View
    refresh()
    Refreshes the resource to sync with Azure.
    View
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    String
    scope()
    Gets the scope property: Cost Management scope to save the view on.
    ReportTimeframeType
    timeframe()
    Gets the timeframe property: The time frame for pulling data for the report.
    ReportConfigTimePeriod
    timePeriod()
    Gets the timePeriod property: Has time period for pulling data for the report.
    String
    type()
    Gets the type property: The type of the resource.
    ReportType
    typePropertiesType()
    Gets the typePropertiesType property: The type of the report.
    View.Update
    update()
    Begins update for the View resource.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • etag

      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.

    • displayName

      String displayName()
      Gets the displayName property: User input name of the view. Required.
      Returns:
      the displayName value.

    • scope

      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.

    • createdOn

      OffsetDateTime createdOn()
      Gets the createdOn property: Date the user created this view.
      Returns:
      the createdOn value.

    • modifiedOn

      OffsetDateTime modifiedOn()
      Gets the modifiedOn property: Date when the user last modified this view.
      Returns:
      the modifiedOn value.

    • chart

      ChartType chart()
      Gets the chart property: Chart type of the main view in Cost Analysis. Required.
      Returns:
      the chart value.

    • accumulated

      AccumulatedType accumulated()
      Gets the accumulated property: Show costs accumulated over time.
      Returns:
      the accumulated value.

    • metric

      MetricType metric()
      Gets the metric property: Metric to use when displaying costs.
      Returns:
      the metric value.

    • kpis

      List<KpiProperties> kpis()
      Gets the kpis property: List of KPIs to show in Cost Analysis UI.
      Returns:
      the kpis value.

    • pivots

      List<PivotProperties> pivots()
      Gets the pivots property: Configuration of 3 sub-views in the Cost Analysis UI.
      Returns:
      the pivots value.

    • typePropertiesType

      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.

    • timeframe

      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.

    • timePeriod

      ReportConfigTimePeriod timePeriod()
      Gets the timePeriod property: Has time period for pulling data for the report.
      Returns:
      the timePeriod value.

    • dataset

      ReportConfigDataset dataset()
      Gets the dataset property: Has definition for data in this report config.
      Returns:
      the dataset value.

    • innerModel

      ViewInner innerModel()
      Gets the inner com.azure.resourcemanager.costmanagement.fluent.models.ViewInner object.
      Returns:
      the inner object.

    • update

      View.Update update()
      Begins update for the View resource.
      Returns:
      the stage of resource update.

    • refresh

      View refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      View refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.