README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/consumption/2023-11-01/lots
Documentation
The lots
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/lots"
Client Initialization
client := lots.NewLotsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: LotsClient.ListByBillingAccount
ctx := context.TODO()
id := lots.NewBillingAccountID("billingAccountIdValue")
// alternatively `client.ListByBillingAccount(ctx, id, lots.DefaultListByBillingAccountOperationOptions())` can be used to do batched pagination
items, err := client.ListByBillingAccountComplete(ctx, id, lots.DefaultListByBillingAccountOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: LotsClient.ListByBillingProfile
ctx := context.TODO()
id := lots.NewBillingProfileID("billingAccountIdValue", "billingProfileIdValue")
// alternatively `client.ListByBillingProfile(ctx, id)` can be used to do batched pagination
items, err := client.ListByBillingProfileComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: LotsClient.ListByCustomer
ctx := context.TODO()
id := lots.NewCustomerID("billingAccountIdValue", "customerIdValue")
// alternatively `client.ListByCustomer(ctx, id, lots.DefaultListByCustomerOperationOptions())` can be used to do batched pagination
items, err := client.ListByCustomerComplete(ctx, id, lots.DefaultListByCustomerOperationOptions())
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func PossibleValuesForLotSource() []string
- func PossibleValuesForOrganizationType() []string
- func PossibleValuesForStatus() []string
- func ValidateBillingAccountID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateBillingProfileID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateCustomerID(input interface{}, key string) (warnings []string, errors []error)
- type Amount
- type AmountWithExchangeRate
- type BillingAccountId
- type BillingProfileId
- type CustomerId
- type ListByBillingAccountCompleteResult
- type ListByBillingAccountOperationOptions
- type ListByBillingAccountOperationResponse
- type ListByBillingProfileCompleteResult
- type ListByBillingProfileOperationResponse
- type ListByCustomerCompleteResult
- type ListByCustomerOperationOptions
- type ListByCustomerOperationResponse
- type LotProperties
- func (o *LotProperties) GetExpirationDateAsTime() (*time.Time, error)
- func (o *LotProperties) GetPurchasedDateAsTime() (*time.Time, error)
- func (o *LotProperties) GetStartDateAsTime() (*time.Time, error)
- func (o *LotProperties) SetExpirationDateAsTime(input time.Time)
- func (o *LotProperties) SetPurchasedDateAsTime(input time.Time)
- func (o *LotProperties) SetStartDateAsTime(input time.Time)
- type LotSource
- type LotSummary
- type LotSummaryOperationPredicate
- type LotsClient
- func (c LotsClient) ListByBillingAccount(ctx context.Context, id BillingAccountId, ...) (result ListByBillingAccountOperationResponse, err error)
- func (c LotsClient) ListByBillingAccountComplete(ctx context.Context, id BillingAccountId, ...) (ListByBillingAccountCompleteResult, error)
- func (c LotsClient) ListByBillingAccountCompleteMatchingPredicate(ctx context.Context, id BillingAccountId, ...) (result ListByBillingAccountCompleteResult, err error)
- func (c LotsClient) ListByBillingProfile(ctx context.Context, id BillingProfileId) (result ListByBillingProfileOperationResponse, err error)
- func (c LotsClient) ListByBillingProfileComplete(ctx context.Context, id BillingProfileId) (ListByBillingProfileCompleteResult, error)
- func (c LotsClient) ListByBillingProfileCompleteMatchingPredicate(ctx context.Context, id BillingProfileId, ...) (result ListByBillingProfileCompleteResult, err error)
- func (c LotsClient) ListByCustomer(ctx context.Context, id CustomerId, options ListByCustomerOperationOptions) (result ListByCustomerOperationResponse, err error)
- func (c LotsClient) ListByCustomerComplete(ctx context.Context, id CustomerId, options ListByCustomerOperationOptions) (ListByCustomerCompleteResult, error)
- func (c LotsClient) ListByCustomerCompleteMatchingPredicate(ctx context.Context, id CustomerId, options ListByCustomerOperationOptions, ...) (result ListByCustomerCompleteResult, err error)
- type OrganizationType
- type Reseller
- type Status
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForLotSource ¶
func PossibleValuesForLotSource() []string
func PossibleValuesForOrganizationType ¶ added in v0.20231010.1121732
func PossibleValuesForOrganizationType() []string
func PossibleValuesForStatus ¶
func PossibleValuesForStatus() []string
func ValidateBillingAccountID ¶
ValidateBillingAccountID checks that 'input' can be parsed as a Billing Account ID
func ValidateBillingProfileID ¶
ValidateBillingProfileID checks that 'input' can be parsed as a Billing Profile ID
func ValidateCustomerID ¶
ValidateCustomerID checks that 'input' can be parsed as a Customer ID
Types ¶
type AmountWithExchangeRate ¶
type BillingAccountId ¶
type BillingAccountId struct {
BillingAccountId string
}
BillingAccountId is a struct representing the Resource ID for a Billing Account
func NewBillingAccountID ¶
func NewBillingAccountID(billingAccountId string) BillingAccountId
NewBillingAccountID returns a new BillingAccountId struct
func ParseBillingAccountID ¶
func ParseBillingAccountID(input string) (*BillingAccountId, error)
ParseBillingAccountID parses 'input' into a BillingAccountId
func ParseBillingAccountIDInsensitively ¶
func ParseBillingAccountIDInsensitively(input string) (*BillingAccountId, error)
ParseBillingAccountIDInsensitively parses 'input' case-insensitively into a BillingAccountId note: this method should only be used for API response data and not user input
func (BillingAccountId) ID ¶
func (id BillingAccountId) ID() string
ID returns the formatted Billing Account ID
func (BillingAccountId) Segments ¶
func (id BillingAccountId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Billing Account ID
func (BillingAccountId) String ¶
func (id BillingAccountId) String() string
String returns a human-readable description of this Billing Account ID
type BillingProfileId ¶
BillingProfileId is a struct representing the Resource ID for a Billing Profile
func NewBillingProfileID ¶
func NewBillingProfileID(billingAccountId string, billingProfileId string) BillingProfileId
NewBillingProfileID returns a new BillingProfileId struct
func ParseBillingProfileID ¶
func ParseBillingProfileID(input string) (*BillingProfileId, error)
ParseBillingProfileID parses 'input' into a BillingProfileId
func ParseBillingProfileIDInsensitively ¶
func ParseBillingProfileIDInsensitively(input string) (*BillingProfileId, error)
ParseBillingProfileIDInsensitively parses 'input' case-insensitively into a BillingProfileId note: this method should only be used for API response data and not user input
func (BillingProfileId) ID ¶
func (id BillingProfileId) ID() string
ID returns the formatted Billing Profile ID
func (BillingProfileId) Segments ¶
func (id BillingProfileId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Billing Profile ID
func (BillingProfileId) String ¶
func (id BillingProfileId) String() string
String returns a human-readable description of this Billing Profile ID
type CustomerId ¶
CustomerId is a struct representing the Resource ID for a Customer
func NewCustomerID ¶
func NewCustomerID(billingAccountId string, customerId string) CustomerId
NewCustomerID returns a new CustomerId struct
func ParseCustomerID ¶
func ParseCustomerID(input string) (*CustomerId, error)
ParseCustomerID parses 'input' into a CustomerId
func ParseCustomerIDInsensitively ¶
func ParseCustomerIDInsensitively(input string) (*CustomerId, error)
ParseCustomerIDInsensitively parses 'input' case-insensitively into a CustomerId note: this method should only be used for API response data and not user input
func (CustomerId) Segments ¶
func (id CustomerId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Customer ID
func (CustomerId) String ¶
func (id CustomerId) String() string
String returns a human-readable description of this Customer ID
type ListByBillingAccountCompleteResult ¶
type ListByBillingAccountCompleteResult struct {
Items []LotSummary
}
type ListByBillingAccountOperationOptions ¶
type ListByBillingAccountOperationOptions struct {
Filter *string
}
func DefaultListByBillingAccountOperationOptions ¶
func DefaultListByBillingAccountOperationOptions() ListByBillingAccountOperationOptions
func (ListByBillingAccountOperationOptions) ToHeaders ¶
func (o ListByBillingAccountOperationOptions) ToHeaders() *client.Headers
func (ListByBillingAccountOperationOptions) ToOData ¶
func (o ListByBillingAccountOperationOptions) ToOData() *odata.Query
func (ListByBillingAccountOperationOptions) ToQuery ¶
func (o ListByBillingAccountOperationOptions) ToQuery() *client.QueryParams
type ListByBillingAccountOperationResponse ¶
type ListByBillingAccountOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]LotSummary }
type ListByBillingProfileCompleteResult ¶
type ListByBillingProfileCompleteResult struct {
Items []LotSummary
}
type ListByBillingProfileOperationResponse ¶
type ListByBillingProfileOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]LotSummary }
type ListByCustomerCompleteResult ¶
type ListByCustomerCompleteResult struct {
Items []LotSummary
}
type ListByCustomerOperationOptions ¶
type ListByCustomerOperationOptions struct {
Filter *string
}
func DefaultListByCustomerOperationOptions ¶
func DefaultListByCustomerOperationOptions() ListByCustomerOperationOptions
func (ListByCustomerOperationOptions) ToHeaders ¶
func (o ListByCustomerOperationOptions) ToHeaders() *client.Headers
func (ListByCustomerOperationOptions) ToOData ¶
func (o ListByCustomerOperationOptions) ToOData() *odata.Query
func (ListByCustomerOperationOptions) ToQuery ¶
func (o ListByCustomerOperationOptions) ToQuery() *client.QueryParams
type ListByCustomerOperationResponse ¶
type ListByCustomerOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]LotSummary }
type LotProperties ¶
type LotProperties struct { BillingCurrency *string `json:"billingCurrency,omitempty"` ClosedBalance *Amount `json:"closedBalance,omitempty"` ClosedBalanceInBillingCurrency *AmountWithExchangeRate `json:"closedBalanceInBillingCurrency,omitempty"` CreditCurrency *string `json:"creditCurrency,omitempty"` ETag *string `json:"eTag,omitempty"` ExpirationDate *string `json:"expirationDate,omitempty"` IsEstimatedBalance *bool `json:"isEstimatedBalance,omitempty"` OrganizationType *OrganizationType `json:"OrganizationType,omitempty"` OriginalAmount *Amount `json:"originalAmount,omitempty"` OriginalAmountInBillingCurrency *AmountWithExchangeRate `json:"originalAmountInBillingCurrency,omitempty"` PoNumber *string `json:"poNumber,omitempty"` PurchasedDate *string `json:"purchasedDate,omitempty"` Reseller *Reseller `json:"reseller,omitempty"` Source *LotSource `json:"source,omitempty"` StartDate *string `json:"startDate,omitempty"` Status *Status `json:"status,omitempty"` UsedAmount *Amount `json:"usedAmount,omitempty"` }
func (*LotProperties) GetExpirationDateAsTime ¶
func (o *LotProperties) GetExpirationDateAsTime() (*time.Time, error)
func (*LotProperties) GetPurchasedDateAsTime ¶
func (o *LotProperties) GetPurchasedDateAsTime() (*time.Time, error)
func (*LotProperties) GetStartDateAsTime ¶
func (o *LotProperties) GetStartDateAsTime() (*time.Time, error)
func (*LotProperties) SetExpirationDateAsTime ¶
func (o *LotProperties) SetExpirationDateAsTime(input time.Time)
func (*LotProperties) SetPurchasedDateAsTime ¶
func (o *LotProperties) SetPurchasedDateAsTime(input time.Time)
func (*LotProperties) SetStartDateAsTime ¶
func (o *LotProperties) SetStartDateAsTime(input time.Time)
type LotSummary ¶
type LotSummary struct { ETag *string `json:"eTag,omitempty"` Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *LotProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type LotSummaryOperationPredicate ¶
func (LotSummaryOperationPredicate) Matches ¶
func (p LotSummaryOperationPredicate) Matches(input LotSummary) bool
type LotsClient ¶
type LotsClient struct {
Client *resourcemanager.Client
}
func NewLotsClientWithBaseURI ¶
func NewLotsClientWithBaseURI(sdkApi sdkEnv.Api) (*LotsClient, error)
func (LotsClient) ListByBillingAccount ¶
func (c LotsClient) ListByBillingAccount(ctx context.Context, id BillingAccountId, options ListByBillingAccountOperationOptions) (result ListByBillingAccountOperationResponse, err error)
ListByBillingAccount ...
func (LotsClient) ListByBillingAccountComplete ¶
func (c LotsClient) ListByBillingAccountComplete(ctx context.Context, id BillingAccountId, options ListByBillingAccountOperationOptions) (ListByBillingAccountCompleteResult, error)
ListByBillingAccountComplete retrieves all the results into a single object
func (LotsClient) ListByBillingAccountCompleteMatchingPredicate ¶
func (c LotsClient) ListByBillingAccountCompleteMatchingPredicate(ctx context.Context, id BillingAccountId, options ListByBillingAccountOperationOptions, predicate LotSummaryOperationPredicate) (result ListByBillingAccountCompleteResult, err error)
ListByBillingAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (LotsClient) ListByBillingProfile ¶
func (c LotsClient) ListByBillingProfile(ctx context.Context, id BillingProfileId) (result ListByBillingProfileOperationResponse, err error)
ListByBillingProfile ...
func (LotsClient) ListByBillingProfileComplete ¶
func (c LotsClient) ListByBillingProfileComplete(ctx context.Context, id BillingProfileId) (ListByBillingProfileCompleteResult, error)
ListByBillingProfileComplete retrieves all the results into a single object
func (LotsClient) ListByBillingProfileCompleteMatchingPredicate ¶
func (c LotsClient) ListByBillingProfileCompleteMatchingPredicate(ctx context.Context, id BillingProfileId, predicate LotSummaryOperationPredicate) (result ListByBillingProfileCompleteResult, err error)
ListByBillingProfileCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (LotsClient) ListByCustomer ¶
func (c LotsClient) ListByCustomer(ctx context.Context, id CustomerId, options ListByCustomerOperationOptions) (result ListByCustomerOperationResponse, err error)
ListByCustomer ...
func (LotsClient) ListByCustomerComplete ¶
func (c LotsClient) ListByCustomerComplete(ctx context.Context, id CustomerId, options ListByCustomerOperationOptions) (ListByCustomerCompleteResult, error)
ListByCustomerComplete retrieves all the results into a single object
func (LotsClient) ListByCustomerCompleteMatchingPredicate ¶
func (c LotsClient) ListByCustomerCompleteMatchingPredicate(ctx context.Context, id CustomerId, options ListByCustomerOperationOptions, predicate LotSummaryOperationPredicate) (result ListByCustomerCompleteResult, err error)
ListByCustomerCompleteMatchingPredicate retrieves all the results and then applies the predicate
type OrganizationType ¶ added in v0.20231010.1121732
type OrganizationType string
const ( OrganizationTypeContributor OrganizationType = "Contributor" OrganizationTypePrimary OrganizationType = "Primary" )
func (*OrganizationType) UnmarshalJSON ¶ added in v0.20231010.1121732
func (s *OrganizationType) UnmarshalJSON(bytes []byte) error
Source Files ¶
- client.go
- constants.go
- id_billingaccount.go
- id_billingprofile.go
- id_customer.go
- method_listbybillingaccount.go
- method_listbybillingprofile.go
- method_listbycustomer.go
- model_amount.go
- model_amountwithexchangerate.go
- model_lotproperties.go
- model_lotsummary.go
- model_reseller.go
- predicates.go
- version.go