reservationrecommendationdetails

README

github.com/hashicorp/go-azure-sdk/resource-manager/consumption/2023-11-01/reservationrecommendationdetails Documentation

The reservationrecommendationdetails SDK allows for interaction with the Azure Resource Manager Service consumption (API Version 2023-11-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-sdk/resource-manager/consumption/2023-11-01/reservationrecommendationdetails"

Client Initialization

client := reservationrecommendationdetails.NewReservationRecommendationDetailsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReservationRecommendationDetailsClient.Get

ctx := context.TODO()
id := reservationrecommendationdetails.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Documentation

Index

• func PossibleValuesForLookBackPeriod() []string
• func PossibleValuesForScope() []string
• func PossibleValuesForTerm() []string
• type GetOperationOptions
  • func DefaultGetOperationOptions() GetOperationOptions
  • func (o GetOperationOptions) ToHeaders() *client.Headers
  • func (o GetOperationOptions) ToOData() *odata.Query
  • func (o GetOperationOptions) ToQuery() *client.QueryParams
• type GetOperationResponse
• type LookBackPeriod
  • func (s *LookBackPeriod) UnmarshalJSON(bytes []byte) error
• type ReservationRecommendationDetailsCalculatedSavingsProperties
• type ReservationRecommendationDetailsClient
  • func NewReservationRecommendationDetailsClientWithBaseURI(sdkApi sdkEnv.Api) (*ReservationRecommendationDetailsClient, error)
  • func (c ReservationRecommendationDetailsClient) Get(ctx context.Context, id commonids.ScopeId, options GetOperationOptions) (result GetOperationResponse, err error)
• type ReservationRecommendationDetailsModel
• type ReservationRecommendationDetailsProperties
• type ReservationRecommendationDetailsResourceProperties
• type ReservationRecommendationDetailsSavingsProperties
• type ReservationRecommendationDetailsUsageProperties
• type Scope
  • func (s *Scope) UnmarshalJSON(bytes []byte) error
• type Term
  • func (s *Term) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForLookBackPeriod

func PossibleValuesForLookBackPeriod() []string

func PossibleValuesForScope

func PossibleValuesForScope() []string

func PossibleValuesForTerm

func PossibleValuesForTerm() []string

Types

type GetOperationOptions

type GetOperationOptions struct {
	Filter         *string
	LookBackPeriod *LookBackPeriod
	Product        *string
	Region         *string
	Scope          *Scope
	Term           *Term
}

func DefaultGetOperationOptions

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders

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

func (GetOperationOptions) ToOData

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

func (GetOperationOptions) ToQuery

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

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ReservationRecommendationDetailsModel
}

type LookBackPeriod

type LookBackPeriod string

const (
	LookBackPeriodLastSevenDays     LookBackPeriod = "Last7Days"
	LookBackPeriodLastSixZeroDays   LookBackPeriod = "Last60Days"
	LookBackPeriodLastThreeZeroDays LookBackPeriod = "Last30Days"
)

func (*LookBackPeriod) UnmarshalJSON

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

type ReservationRecommendationDetailsCalculatedSavingsProperties

type ReservationRecommendationDetailsCalculatedSavingsProperties struct {
	OnDemandCost         *float64 `json:"onDemandCost,omitempty"`
	OverageCost          *float64 `json:"overageCost,omitempty"`
	Quantity             *float64 `json:"quantity,omitempty"`
	ReservationCost      *float64 `json:"reservationCost,omitempty"`
	ReservedUnitCount    *float64 `json:"reservedUnitCount,omitempty"`
	Savings              *float64 `json:"savings,omitempty"`
	TotalReservationCost *float64 `json:"totalReservationCost,omitempty"`
}

type ReservationRecommendationDetailsClient

type ReservationRecommendationDetailsClient struct {
	Client *resourcemanager.Client
}

func NewReservationRecommendationDetailsClientWithBaseURI

func NewReservationRecommendationDetailsClientWithBaseURI(sdkApi sdkEnv.Api) (*ReservationRecommendationDetailsClient, error)

func (ReservationRecommendationDetailsClient) Get

func (c ReservationRecommendationDetailsClient) Get(ctx context.Context, id commonids.ScopeId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

type ReservationRecommendationDetailsModel

type ReservationRecommendationDetailsModel struct {
	Etag       *string                                     `json:"etag,omitempty"`
	Id         *string                                     `json:"id,omitempty"`
	Location   *string                                     `json:"location,omitempty"`
	Name       *string                                     `json:"name,omitempty"`
	Properties *ReservationRecommendationDetailsProperties `json:"properties,omitempty"`
	Sku        *string                                     `json:"sku,omitempty"`
	Tags       *map[string]string                          `json:"tags,omitempty"`
	Type       *string                                     `json:"type,omitempty"`
}

type ReservationRecommendationDetailsProperties

type ReservationRecommendationDetailsProperties struct {
	Currency      *string                                             `json:"currency,omitempty"`
	Resource      *ReservationRecommendationDetailsResourceProperties `json:"resource,omitempty"`
	ResourceGroup *string                                             `json:"resourceGroup,omitempty"`
	Savings       *ReservationRecommendationDetailsSavingsProperties  `json:"savings,omitempty"`
	Scope         *string                                             `json:"scope,omitempty"`
	Usage         *ReservationRecommendationDetailsUsageProperties    `json:"usage,omitempty"`
}

type ReservationRecommendationDetailsResourceProperties

type ReservationRecommendationDetailsResourceProperties struct {
	AppliedScopes   *[]string `json:"appliedScopes,omitempty"`
	OnDemandRate    *float64  `json:"onDemandRate,omitempty"`
	Product         *string   `json:"product,omitempty"`
	Region          *string   `json:"region,omitempty"`
	ReservationRate *float64  `json:"reservationRate,omitempty"`
	ResourceType    *string   `json:"resourceType,omitempty"`
}

type ReservationRecommendationDetailsSavingsProperties

type ReservationRecommendationDetailsSavingsProperties struct {
	CalculatedSavings    *[]ReservationRecommendationDetailsCalculatedSavingsProperties `json:"calculatedSavings,omitempty"`
	LookBackPeriod       *int64                                                         `json:"lookBackPeriod,omitempty"`
	RecommendedQuantity  *float64                                                       `json:"recommendedQuantity,omitempty"`
	ReservationOrderTerm *string                                                        `json:"reservationOrderTerm,omitempty"`
	SavingsType          *string                                                        `json:"savingsType,omitempty"`
	UnitOfMeasure        *string                                                        `json:"unitOfMeasure,omitempty"`
}

type ReservationRecommendationDetailsUsageProperties

type ReservationRecommendationDetailsUsageProperties struct {
	FirstConsumptionDate *string    `json:"firstConsumptionDate,omitempty"`
	LastConsumptionDate  *string    `json:"lastConsumptionDate,omitempty"`
	LookBackUnitType     *string    `json:"lookBackUnitType,omitempty"`
	UsageData            *[]float64 `json:"usageData,omitempty"`
	UsageGrain           *string    `json:"usageGrain,omitempty"`
}

type Scope

type Scope string

const (
	ScopeShared Scope = "Shared"
	ScopeSingle Scope = "Single"
)

func (*Scope) UnmarshalJSON

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

type Term

type Term string

const (
	TermPOneY   Term = "P1Y"
	TermPThreeY Term = "P3Y"
)

func (*Term) UnmarshalJSON

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