Share via


ForecastDefinition Class

Definition

The definition of a forecast.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.ForecastDefinitionTypeConverter))]
public class ForecastDefinition : Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IForecastDefinition, Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IForecastDefinitionInternal
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.ForecastDefinitionTypeConverter))>]
type ForecastDefinition = class
    interface IForecastDefinition
    interface IJsonSerializable
    interface IForecastDefinitionInternal
Public Class ForecastDefinition
Implements IForecastDefinition, IForecastDefinitionInternal
Inheritance
ForecastDefinition
Attributes
Implements

Constructors

ForecastDefinition()

Creates an new ForecastDefinition instance.

Properties

ConfigurationColumn

Array of column names to be included in the forecast. Any valid forecast column name is allowed. If not provided, then forecast includes all columns.

DatasetAggregation

Dictionary of aggregation expression to use in the forecast. The key of each item in the dictionary is the alias for the aggregated column. forecast can have up to 2 aggregation clauses.

DatasetGranularity

The granularity of rows in the forecast.

DimensionName

The name of the column to use in comparison.

DimensionOperator

The operator to use for comparison.

DimensionValue

Array of values to use for comparison

FilterAnd

The logical "AND" expression. Must have at least 2 items.

FilterOr

The logical "OR" expression. Must have at least 2 items.

IncludeActualCost

A boolean determining if actualCost will be included.

IncludeFreshPartialCost

A boolean determining if FreshPartialCost will be included.

TagName

The name of the column to use in comparison.

TagOperator

The operator to use for comparison.

TagValue

Array of values to use for comparison

Timeframe

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

TimePeriodFrom

The start date to pull data from.

TimePeriodTo

The end date to pull data to.

Type

The type of the forecast.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of ForecastDefinition.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of ForecastDefinition.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.CostManagement.Models.Api20211001.IForecastDefinition.

FromJsonString(String)

Creates a new instance of ForecastDefinition, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of ForecastDefinition into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Explicit Interface Implementations

IForecastDefinitionInternal.Dataset

Internal Acessors for Dataset

IForecastDefinitionInternal.DatasetConfiguration

Internal Acessors for DatasetConfiguration

IForecastDefinitionInternal.DatasetFilter

Internal Acessors for DatasetFilter

IForecastDefinitionInternal.DimensionOperator

Internal Acessors for DimensionOperator

IForecastDefinitionInternal.FilterDimension

Internal Acessors for FilterDimension

IForecastDefinitionInternal.FilterTag

Internal Acessors for FilterTag

IForecastDefinitionInternal.TagOperator

Internal Acessors for TagOperator

IForecastDefinitionInternal.Timeframe

Internal Acessors for Timeframe

IForecastDefinitionInternal.TimePeriod

Internal Acessors for TimePeriod

Applies to