forecasts

README

github.com/hashicorp/go-azure-sdk/resource-manager/consumption/2019-10-01/forecasts Documentation

The forecasts SDK allows for interaction with Azure Resource Manager consumption (API Version 2019-10-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/consumption/2019-10-01/forecasts"

Client Initialization

client := forecasts.NewForecastsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ForecastsClient.List

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

read, err := client.List(ctx, id, forecasts.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func PossibleValuesForBound() []string
• func PossibleValuesForChargeType() []string
• func PossibleValuesForGrain() []string
• type Bound
  • func (s *Bound) UnmarshalJSON(bytes []byte) error
• type ChargeType
  • func (s *ChargeType) UnmarshalJSON(bytes []byte) error
• type Forecast
• type ForecastProperties
• type ForecastPropertiesConfidenceLevelsInlined
• type ForecastsClient
  • func NewForecastsClientWithBaseURI(sdkApi sdkEnv.Api) (*ForecastsClient, error)
  • func (c ForecastsClient) List(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (result ListOperationResponse, err error)
• type ForecastsListResult
• type Grain
  • func (s *Grain) UnmarshalJSON(bytes []byte) error
• type ListOperationOptions
  • func DefaultListOperationOptions() ListOperationOptions
  • func (o ListOperationOptions) ToHeaders() *client.Headers
  • func (o ListOperationOptions) ToOData() *odata.Query
  • func (o ListOperationOptions) ToQuery() *client.QueryParams
• type ListOperationResponse

Functions

func PossibleValuesForBound

func PossibleValuesForBound() []string

func PossibleValuesForChargeType

func PossibleValuesForChargeType() []string

func PossibleValuesForGrain

func PossibleValuesForGrain() []string

Types

type Bound

type Bound string

const (
	BoundLower Bound = "Lower"
	BoundUpper Bound = "Upper"
)

func (*Bound) UnmarshalJSON

func (s *Bound) UnmarshalJSON(bytes []byte) error

type ChargeType

type ChargeType string

const (
	ChargeTypeActual   ChargeType = "Actual"
	ChargeTypeForecast ChargeType = "Forecast"
)

func (*ChargeType) UnmarshalJSON

func (s *ChargeType) UnmarshalJSON(bytes []byte) error

type Forecast

type Forecast struct {
	Etag       *string             `json:"etag,omitempty"`
	Id         *string             `json:"id,omitempty"`
	Name       *string             `json:"name,omitempty"`
	Properties *ForecastProperties `json:"properties,omitempty"`
	Tags       *map[string]string  `json:"tags,omitempty"`
	Type       *string             `json:"type,omitempty"`
}

type ForecastProperties

type ForecastProperties struct {
	Charge           *float64                                     `json:"charge,omitempty"`
	ChargeType       *ChargeType                                  `json:"chargeType,omitempty"`
	ConfidenceLevels *[]ForecastPropertiesConfidenceLevelsInlined `json:"confidenceLevels,omitempty"`
	Currency         *string                                      `json:"currency,omitempty"`
	Grain            *Grain                                       `json:"grain,omitempty"`
	UsageDate        *string                                      `json:"usageDate,omitempty"`
}

type ForecastPropertiesConfidenceLevelsInlined

type ForecastPropertiesConfidenceLevelsInlined struct {
	Bound      *Bound   `json:"bound,omitempty"`
	Percentage *float64 `json:"percentage,omitempty"`
	Value      *float64 `json:"value,omitempty"`
}

type ForecastsClient

type ForecastsClient struct {
	Client *resourcemanager.Client
}

func NewForecastsClientWithBaseURI

func NewForecastsClientWithBaseURI(sdkApi sdkEnv.Api) (*ForecastsClient, error)

func (ForecastsClient) List

func (c ForecastsClient) List(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

type ForecastsListResult

type ForecastsListResult struct {
	Value *[]Forecast `json:"value,omitempty"`
}

type Grain

type Grain string

const (
	GrainDaily   Grain = "Daily"
	GrainMonthly Grain = "Monthly"
	GrainYearly  Grain = "Yearly"
)

func (*Grain) UnmarshalJSON

func (s *Grain) UnmarshalJSON(bytes []byte) error

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ForecastsListResult
}