reservationdetails

package
v0.20230823.1052657 Latest Latest
Warning

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

 Go to latest Published: Aug 23, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/consumption/2021-10-01/reservationdetails Documentation

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

Client Initialization

client := reservationdetails.NewReservationDetailsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReservationDetailsClient.ReservationsDetailsList

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

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

Example Usage: ReservationDetailsClient.ReservationsDetailsListByReservationOrder

ctx := context.TODO()
id := reservationdetails.NewReservationOrderID("reservationOrderIdValue")

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

Example Usage: ReservationDetailsClient.ReservationsDetailsListByReservationOrderAndReservation

ctx := context.TODO()
id := reservationdetails.NewReservationID("reservationOrderIdValue", "reservationIdValue")

// alternatively `client.ReservationsDetailsListByReservationOrderAndReservation(ctx, id, reservationdetails.DefaultReservationsDetailsListByReservationOrderAndReservationOperationOptions())` can be used to do batched pagination
items, err := client.ReservationsDetailsListByReservationOrderAndReservationComplete(ctx, id, reservationdetails.DefaultReservationsDetailsListByReservationOrderAndReservationOperationOptions())
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 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 ReservationDetail 

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

type ReservationDetailOperationPredicate 

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

func (ReservationDetailOperationPredicate) Matches 

func (p ReservationDetailOperationPredicate) Matches(input ReservationDetail) bool

type ReservationDetailProperties 

type ReservationDetailProperties struct {
	InstanceFlexibilityGroup *string  `json:"instanceFlexibilityGroup,omitempty"`
	InstanceFlexibilityRatio *string  `json:"instanceFlexibilityRatio,omitempty"`
	InstanceId               *string  `json:"instanceId,omitempty"`
	Kind                     *string  `json:"kind,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"`
}

func (*ReservationDetailProperties) GetUsageDateAsTime 

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

func (*ReservationDetailProperties) SetUsageDateAsTime 

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

type ReservationDetailsClient 

type ReservationDetailsClient struct {
	Client *resourcemanager.Client
}

func NewReservationDetailsClientWithBaseURI 

func NewReservationDetailsClientWithBaseURI(sdkApi sdkEnv.Api) (*ReservationDetailsClient, error)

func (ReservationDetailsClient) ReservationsDetailsList 

func (c ReservationDetailsClient) ReservationsDetailsList(ctx context.Context, id commonids.ScopeId, options ReservationsDetailsListOperationOptions) (result ReservationsDetailsListOperationResponse, err error)

ReservationsDetailsList ...

func (ReservationDetailsClient) ReservationsDetailsListByReservationOrder 

func (c ReservationDetailsClient) ReservationsDetailsListByReservationOrder(ctx context.Context, id ReservationOrderId, options ReservationsDetailsListByReservationOrderOperationOptions) (result ReservationsDetailsListByReservationOrderOperationResponse, err error)

ReservationsDetailsListByReservationOrder ...

func (ReservationDetailsClient) ReservationsDetailsListByReservationOrderAndReservation 

func (c ReservationDetailsClient) ReservationsDetailsListByReservationOrderAndReservation(ctx context.Context, id ReservationId, options ReservationsDetailsListByReservationOrderAndReservationOperationOptions) (result ReservationsDetailsListByReservationOrderAndReservationOperationResponse, err error)

ReservationsDetailsListByReservationOrderAndReservation ...

func (ReservationDetailsClient) ReservationsDetailsListByReservationOrderAndReservationComplete 

func (c ReservationDetailsClient) ReservationsDetailsListByReservationOrderAndReservationComplete(ctx context.Context, id ReservationId, options ReservationsDetailsListByReservationOrderAndReservationOperationOptions) (ReservationsDetailsListByReservationOrderAndReservationCompleteResult, error)

ReservationsDetailsListByReservationOrderAndReservationComplete retrieves all the results into a single object

func (ReservationDetailsClient) ReservationsDetailsListByReservationOrderAndReservationCompleteMatchingPredicate 

func (c ReservationDetailsClient) ReservationsDetailsListByReservationOrderAndReservationCompleteMatchingPredicate(ctx context.Context, id ReservationId, options ReservationsDetailsListByReservationOrderAndReservationOperationOptions, predicate ReservationDetailOperationPredicate) (result ReservationsDetailsListByReservationOrderAndReservationCompleteResult, err error)

ReservationsDetailsListByReservationOrderAndReservationCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ReservationDetailsClient) ReservationsDetailsListByReservationOrderComplete 

func (c ReservationDetailsClient) ReservationsDetailsListByReservationOrderComplete(ctx context.Context, id ReservationOrderId, options ReservationsDetailsListByReservationOrderOperationOptions) (ReservationsDetailsListByReservationOrderCompleteResult, error)

ReservationsDetailsListByReservationOrderComplete retrieves all the results into a single object

func (ReservationDetailsClient) ReservationsDetailsListByReservationOrderCompleteMatchingPredicate 

func (c ReservationDetailsClient) ReservationsDetailsListByReservationOrderCompleteMatchingPredicate(ctx context.Context, id ReservationOrderId, options ReservationsDetailsListByReservationOrderOperationOptions, predicate ReservationDetailOperationPredicate) (result ReservationsDetailsListByReservationOrderCompleteResult, err error)

ReservationsDetailsListByReservationOrderCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ReservationDetailsClient) ReservationsDetailsListComplete 

func (c ReservationDetailsClient) ReservationsDetailsListComplete(ctx context.Context, id commonids.ScopeId, options ReservationsDetailsListOperationOptions) (ReservationsDetailsListCompleteResult, error)

ReservationsDetailsListComplete retrieves all the results into a single object

func (ReservationDetailsClient) ReservationsDetailsListCompleteMatchingPredicate 

func (c ReservationDetailsClient) ReservationsDetailsListCompleteMatchingPredicate(ctx context.Context, id commonids.ScopeId, options ReservationsDetailsListOperationOptions, predicate ReservationDetailOperationPredicate) (result ReservationsDetailsListCompleteResult, err error)

ReservationsDetailsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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) 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) 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 ReservationsDetailsListByReservationOrderAndReservationCompleteResult 

type ReservationsDetailsListByReservationOrderAndReservationCompleteResult struct {
	Items []ReservationDetail
}

type ReservationsDetailsListByReservationOrderAndReservationOperationOptions 

type ReservationsDetailsListByReservationOrderAndReservationOperationOptions struct {
	Filter *string
}

func DefaultReservationsDetailsListByReservationOrderAndReservationOperationOptions 

func DefaultReservationsDetailsListByReservationOrderAndReservationOperationOptions() ReservationsDetailsListByReservationOrderAndReservationOperationOptions

func (ReservationsDetailsListByReservationOrderAndReservationOperationOptions) ToHeaders added in v0.20230411.1183115 

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

func (ReservationsDetailsListByReservationOrderAndReservationOperationOptions) ToOData added in v0.20230411.1183115 

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

func (ReservationsDetailsListByReservationOrderAndReservationOperationOptions) ToQuery added in v0.20230411.1183115 

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

type ReservationsDetailsListByReservationOrderAndReservationOperationResponse 

type ReservationsDetailsListByReservationOrderAndReservationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ReservationDetail
}

type ReservationsDetailsListByReservationOrderCompleteResult 

type ReservationsDetailsListByReservationOrderCompleteResult struct {
	Items []ReservationDetail
}

type ReservationsDetailsListByReservationOrderOperationOptions 

type ReservationsDetailsListByReservationOrderOperationOptions struct {
	Filter *string
}

func DefaultReservationsDetailsListByReservationOrderOperationOptions 

func DefaultReservationsDetailsListByReservationOrderOperationOptions() ReservationsDetailsListByReservationOrderOperationOptions

func (ReservationsDetailsListByReservationOrderOperationOptions) ToHeaders added in v0.20230411.1183115 

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

func (ReservationsDetailsListByReservationOrderOperationOptions) ToOData added in v0.20230411.1183115 

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

func (ReservationsDetailsListByReservationOrderOperationOptions) ToQuery added in v0.20230411.1183115 

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

type ReservationsDetailsListByReservationOrderOperationResponse 

type ReservationsDetailsListByReservationOrderOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ReservationDetail
}

type ReservationsDetailsListCompleteResult 

type ReservationsDetailsListCompleteResult struct {
	Items []ReservationDetail
}

type ReservationsDetailsListOperationOptions 

type ReservationsDetailsListOperationOptions struct {
	EndDate            *string
	Filter             *string
	ReservationId      *string
	ReservationOrderId *string
	StartDate          *string
}

func DefaultReservationsDetailsListOperationOptions 

func DefaultReservationsDetailsListOperationOptions() ReservationsDetailsListOperationOptions

func (ReservationsDetailsListOperationOptions) ToHeaders added in v0.20230411.1183115 

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

func (ReservationsDetailsListOperationOptions) ToOData added in v0.20230411.1183115 

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

func (ReservationsDetailsListOperationOptions) ToQuery added in v0.20230411.1183115 

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

type ReservationsDetailsListOperationResponse 

type ReservationsDetailsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ReservationDetail
}

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.