reservationsummaries

package
v0.20241111.1164443 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 11, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/consumption/2024-08-01/reservationsummaries Documentation

The reservationsummaries SDK allows for interaction with Azure Resource Manager consumption (API Version 2024-08-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/2024-08-01/reservationsummaries"

Client Initialization

client := reservationsummaries.NewReservationSummariesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReservationSummariesClient.ReservationsSummariesList

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

// alternatively `client.ReservationsSummariesList(ctx, id, reservationsummaries.DefaultReservationsSummariesListOperationOptions())` can be used to do batched pagination
items, err := client.ReservationsSummariesListComplete(ctx, id, reservationsummaries.DefaultReservationsSummariesListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ReservationSummariesClient.ReservationsSummariesListByReservationOrder

ctx := context.TODO()
id := reservationsummaries.NewReservationOrderID("reservationOrderId")

// alternatively `client.ReservationsSummariesListByReservationOrder(ctx, id, reservationsummaries.DefaultReservationsSummariesListByReservationOrderOperationOptions())` can be used to do batched pagination
items, err := client.ReservationsSummariesListByReservationOrderComplete(ctx, id, reservationsummaries.DefaultReservationsSummariesListByReservationOrderOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ReservationSummariesClient.ReservationsSummariesListByReservationOrderAndReservation

ctx := context.TODO()
id := reservationsummaries.NewReservationID("reservationOrderId", "reservationId")

// alternatively `client.ReservationsSummariesListByReservationOrderAndReservation(ctx, id, reservationsummaries.DefaultReservationsSummariesListByReservationOrderAndReservationOperationOptions())` can be used to do batched pagination
items, err := client.ReservationsSummariesListByReservationOrderAndReservationComplete(ctx, id, reservationsummaries.DefaultReservationsSummariesListByReservationOrderAndReservationOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDatagrain 

func PossibleValuesForDatagrain() []string

func ValidateReservationID 

func ValidateReservationID(input interface{}, key string) (warnings []string, errors []error)

ValidateReservationID checks that 'input' can be parsed as a Reservation ID

func ValidateReservationOrderID 

func ValidateReservationOrderID(input interface{}, key string) (warnings []string, errors []error)

ValidateReservationOrderID checks that 'input' can be parsed as a Reservation Order ID

Types

type Datagrain 

type Datagrain string
const (
	DatagrainDaily   Datagrain = "daily"
	DatagrainMonthly Datagrain = "monthly"
)

func (*Datagrain) UnmarshalJSON 

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

type ReservationId 

type ReservationId struct {
	ReservationOrderId string
	ReservationId      string
}

ReservationId is a struct representing the Resource ID for a Reservation

func NewReservationID 

func NewReservationID(reservationOrderId string, reservationId string) ReservationId

NewReservationID returns a new ReservationId struct

func ParseReservationID 

func ParseReservationID(input string) (*ReservationId, error)

ParseReservationID parses 'input' into a ReservationId

func ParseReservationIDInsensitively 

func ParseReservationIDInsensitively(input string) (*ReservationId, error)

ParseReservationIDInsensitively parses 'input' case-insensitively into a ReservationId note: this method should only be used for API response data and not user input

func (*ReservationId) FromParseResult 

func (id *ReservationId) FromParseResult(input resourceids.ParseResult) error

func (ReservationId) ID 

func (id ReservationId) ID() string

ID returns the formatted Reservation ID

func (ReservationId) Segments 

func (id ReservationId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Reservation ID

func (ReservationId) String 

func (id ReservationId) String() string

String returns a human-readable description of this Reservation ID

type ReservationOrderId 

type ReservationOrderId struct {
	ReservationOrderId string
}

ReservationOrderId is a struct representing the Resource ID for a Reservation Order

func NewReservationOrderID 

func NewReservationOrderID(reservationOrderId string) ReservationOrderId

NewReservationOrderID returns a new ReservationOrderId struct

func ParseReservationOrderID 

func ParseReservationOrderID(input string) (*ReservationOrderId, error)

ParseReservationOrderID parses 'input' into a ReservationOrderId

func ParseReservationOrderIDInsensitively 

func ParseReservationOrderIDInsensitively(input string) (*ReservationOrderId, error)

ParseReservationOrderIDInsensitively parses 'input' case-insensitively into a ReservationOrderId note: this method should only be used for API response data and not user input

func (*ReservationOrderId) FromParseResult 

func (id *ReservationOrderId) FromParseResult(input resourceids.ParseResult) error

func (ReservationOrderId) ID 

func (id ReservationOrderId) ID() string

ID returns the formatted Reservation Order ID

func (ReservationOrderId) Segments 

func (id ReservationOrderId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Reservation Order ID

func (ReservationOrderId) String 

func (id ReservationOrderId) String() string

String returns a human-readable description of this Reservation Order ID

type ReservationSummariesClient 

type ReservationSummariesClient struct {
	Client *resourcemanager.Client
}

func NewReservationSummariesClientWithBaseURI 

func NewReservationSummariesClientWithBaseURI(sdkApi sdkEnv.Api) (*ReservationSummariesClient, error)

func (ReservationSummariesClient) ReservationsSummariesList 

func (c ReservationSummariesClient) ReservationsSummariesList(ctx context.Context, id commonids.ScopeId, options ReservationsSummariesListOperationOptions) (result ReservationsSummariesListOperationResponse, err error)

ReservationsSummariesList ...

func (ReservationSummariesClient) ReservationsSummariesListByReservationOrder 

func (c ReservationSummariesClient) ReservationsSummariesListByReservationOrder(ctx context.Context, id ReservationOrderId, options ReservationsSummariesListByReservationOrderOperationOptions) (result ReservationsSummariesListByReservationOrderOperationResponse, err error)

ReservationsSummariesListByReservationOrder ...

func (ReservationSummariesClient) ReservationsSummariesListByReservationOrderAndReservation 

func (c ReservationSummariesClient) ReservationsSummariesListByReservationOrderAndReservation(ctx context.Context, id ReservationId, options ReservationsSummariesListByReservationOrderAndReservationOperationOptions) (result ReservationsSummariesListByReservationOrderAndReservationOperationResponse, err error)

ReservationsSummariesListByReservationOrderAndReservation ...

func (ReservationSummariesClient) ReservationsSummariesListByReservationOrderAndReservationComplete 

func (c ReservationSummariesClient) ReservationsSummariesListByReservationOrderAndReservationComplete(ctx context.Context, id ReservationId, options ReservationsSummariesListByReservationOrderAndReservationOperationOptions) (ReservationsSummariesListByReservationOrderAndReservationCompleteResult, error)

ReservationsSummariesListByReservationOrderAndReservationComplete retrieves all the results into a single object

func (ReservationSummariesClient) ReservationsSummariesListByReservationOrderAndReservationCompleteMatchingPredicate 

func (c ReservationSummariesClient) ReservationsSummariesListByReservationOrderAndReservationCompleteMatchingPredicate(ctx context.Context, id ReservationId, options ReservationsSummariesListByReservationOrderAndReservationOperationOptions, predicate ReservationSummaryOperationPredicate) (result ReservationsSummariesListByReservationOrderAndReservationCompleteResult, err error)

ReservationsSummariesListByReservationOrderAndReservationCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ReservationSummariesClient) ReservationsSummariesListByReservationOrderComplete 

func (c ReservationSummariesClient) ReservationsSummariesListByReservationOrderComplete(ctx context.Context, id ReservationOrderId, options ReservationsSummariesListByReservationOrderOperationOptions) (ReservationsSummariesListByReservationOrderCompleteResult, error)

ReservationsSummariesListByReservationOrderComplete retrieves all the results into a single object

func (ReservationSummariesClient) ReservationsSummariesListByReservationOrderCompleteMatchingPredicate 

func (c ReservationSummariesClient) ReservationsSummariesListByReservationOrderCompleteMatchingPredicate(ctx context.Context, id ReservationOrderId, options ReservationsSummariesListByReservationOrderOperationOptions, predicate ReservationSummaryOperationPredicate) (result ReservationsSummariesListByReservationOrderCompleteResult, err error)

ReservationsSummariesListByReservationOrderCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ReservationSummariesClient) ReservationsSummariesListComplete 

func (c ReservationSummariesClient) ReservationsSummariesListComplete(ctx context.Context, id commonids.ScopeId, options ReservationsSummariesListOperationOptions) (ReservationsSummariesListCompleteResult, error)

ReservationsSummariesListComplete retrieves all the results into a single object

func (ReservationSummariesClient) ReservationsSummariesListCompleteMatchingPredicate 

func (c ReservationSummariesClient) ReservationsSummariesListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options ReservationsSummariesListOperationOptions, predicate ReservationSummaryOperationPredicate) (result ReservationsSummariesListCompleteResult, err error)

ReservationsSummariesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ReservationSummary 

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

type ReservationSummaryOperationPredicate 

type ReservationSummaryOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (ReservationSummaryOperationPredicate) Matches 

func (p ReservationSummaryOperationPredicate) Matches(input ReservationSummary) bool

type ReservationSummaryProperties 

type ReservationSummaryProperties struct {
	AvgUtilizationPercentage *float64 `json:"avgUtilizationPercentage,omitempty"`
	Kind                     *string  `json:"kind,omitempty"`
	MaxUtilizationPercentage *float64 `json:"maxUtilizationPercentage,omitempty"`
	MinUtilizationPercentage *float64 `json:"minUtilizationPercentage,omitempty"`
	PurchasedQuantity        *float64 `json:"purchasedQuantity,omitempty"`
	RemainingQuantity        *float64 `json:"remainingQuantity,omitempty"`
	ReservationId            *string  `json:"reservationId,omitempty"`
	ReservationOrderId       *string  `json:"reservationOrderId,omitempty"`
	ReservedHours            *float64 `json:"reservedHours,omitempty"`
	SkuName                  *string  `json:"skuName,omitempty"`
	TotalReservedQuantity    *float64 `json:"totalReservedQuantity,omitempty"`
	UsageDate                *string  `json:"usageDate,omitempty"`
	UsedHours                *float64 `json:"usedHours,omitempty"`
	UsedQuantity             *float64 `json:"usedQuantity,omitempty"`
	UtilizedPercentage       *float64 `json:"utilizedPercentage,omitempty"`
}

func (*ReservationSummaryProperties) GetUsageDateAsTime 

func (o *ReservationSummaryProperties) GetUsageDateAsTime() (*time.Time, error)

func (*ReservationSummaryProperties) SetUsageDateAsTime 

func (o *ReservationSummaryProperties) SetUsageDateAsTime(input time.Time)

type ReservationsSummariesListByReservationOrderAndReservationCompleteResult 

type ReservationsSummariesListByReservationOrderAndReservationCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ReservationSummary
}

type ReservationsSummariesListByReservationOrderAndReservationCustomPager 

type ReservationsSummariesListByReservationOrderAndReservationCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ReservationsSummariesListByReservationOrderAndReservationCustomPager) NextPageLink() *odata.Link

type ReservationsSummariesListByReservationOrderAndReservationOperationOptions 

type ReservationsSummariesListByReservationOrderAndReservationOperationOptions struct {
	Filter *string
	Grain  *Datagrain
}

func DefaultReservationsSummariesListByReservationOrderAndReservationOperationOptions 

func DefaultReservationsSummariesListByReservationOrderAndReservationOperationOptions() ReservationsSummariesListByReservationOrderAndReservationOperationOptions

func (ReservationsSummariesListByReservationOrderAndReservationOperationOptions) ToHeaders 

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

func (ReservationsSummariesListByReservationOrderAndReservationOperationOptions) ToOData 

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

func (ReservationsSummariesListByReservationOrderAndReservationOperationOptions) ToQuery 

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

type ReservationsSummariesListByReservationOrderAndReservationOperationResponse 

type ReservationsSummariesListByReservationOrderAndReservationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ReservationSummary
}

type ReservationsSummariesListByReservationOrderCompleteResult 

type ReservationsSummariesListByReservationOrderCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ReservationSummary
}

type ReservationsSummariesListByReservationOrderCustomPager 

type ReservationsSummariesListByReservationOrderCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ReservationsSummariesListByReservationOrderCustomPager) NextPageLink() *odata.Link

type ReservationsSummariesListByReservationOrderOperationOptions 

type ReservationsSummariesListByReservationOrderOperationOptions struct {
	Filter *string
	Grain  *Datagrain
}

func DefaultReservationsSummariesListByReservationOrderOperationOptions 

func DefaultReservationsSummariesListByReservationOrderOperationOptions() ReservationsSummariesListByReservationOrderOperationOptions

func (ReservationsSummariesListByReservationOrderOperationOptions) ToHeaders 

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

func (ReservationsSummariesListByReservationOrderOperationOptions) ToOData 

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

func (ReservationsSummariesListByReservationOrderOperationOptions) ToQuery 

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

type ReservationsSummariesListByReservationOrderOperationResponse 

type ReservationsSummariesListByReservationOrderOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ReservationSummary
}

type ReservationsSummariesListCompleteResult 

type ReservationsSummariesListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ReservationSummary
}

type ReservationsSummariesListCustomPager 

type ReservationsSummariesListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ReservationsSummariesListCustomPager) NextPageLink() *odata.Link

type ReservationsSummariesListOperationOptions 

type ReservationsSummariesListOperationOptions struct {
	EndDate            *string
	Filter             *string
	Grain              *Datagrain
	ReservationId      *string
	ReservationOrderId *string
	StartDate          *string
}

func DefaultReservationsSummariesListOperationOptions 

func DefaultReservationsSummariesListOperationOptions() ReservationsSummariesListOperationOptions

func (ReservationsSummariesListOperationOptions) ToHeaders 

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

func (ReservationsSummariesListOperationOptions) ToOData 

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

func (ReservationsSummariesListOperationOptions) ToQuery 

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

type ReservationsSummariesListOperationResponse 

type ReservationsSummariesListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ReservationSummary
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.