availablebalance

README

github.com/hashicorp/go-azure-sdk/resource-manager/billing/2024-04-01/availablebalance Documentation

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

Client Initialization

client := availablebalance.NewAvailableBalanceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AvailableBalanceClient.GetByBillingAccount

ctx := context.TODO()
id := availablebalance.NewBillingAccountID("billingAccountName")

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

Example Usage: AvailableBalanceClient.GetByBillingProfile

ctx := context.TODO()
id := availablebalance.NewBillingProfileID("billingAccountName", "billingProfileName")

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

Documentation

Index

• func PossibleValuesForPaymentMethodFamily() []string
• func ValidateBillingAccountID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateBillingProfileID(input interface{}, key string) (warnings []string, errors []error)
• type Amount
• type AvailableBalance
• type AvailableBalanceClient
  • func NewAvailableBalanceClientWithBaseURI(sdkApi sdkEnv.Api) (*AvailableBalanceClient, error)
  • func (c AvailableBalanceClient) GetByBillingAccount(ctx context.Context, id BillingAccountId) (result GetByBillingAccountOperationResponse, err error)
  • func (c AvailableBalanceClient) GetByBillingProfile(ctx context.Context, id BillingProfileId) (result GetByBillingProfileOperationResponse, err error)
• type AvailableBalanceProperties
• type BillingAccountId
  • func NewBillingAccountID(billingAccountName string) BillingAccountId
  • func ParseBillingAccountID(input string) (*BillingAccountId, error)
  • func ParseBillingAccountIDInsensitively(input string) (*BillingAccountId, error)
  • func (id *BillingAccountId) FromParseResult(input resourceids.ParseResult) error
  • func (id BillingAccountId) ID() string
  • func (id BillingAccountId) Segments() []resourceids.Segment
  • func (id BillingAccountId) String() string
• type BillingProfileId
  • func NewBillingProfileID(billingAccountName string, billingProfileName string) BillingProfileId
  • func ParseBillingProfileID(input string) (*BillingProfileId, error)
  • func ParseBillingProfileIDInsensitively(input string) (*BillingProfileId, error)
  • func (id *BillingProfileId) FromParseResult(input resourceids.ParseResult) error
  • func (id BillingProfileId) ID() string
  • func (id BillingProfileId) Segments() []resourceids.Segment
  • func (id BillingProfileId) String() string
• type GetByBillingAccountOperationResponse
• type GetByBillingProfileOperationResponse
• type PaymentMethodFamily
  • func (s *PaymentMethodFamily) UnmarshalJSON(bytes []byte) error
• type PaymentOnAccount
  • func (o *PaymentOnAccount) GetDateAsTime() (*time.Time, error)
  • func (o *PaymentOnAccount) SetDateAsTime(input time.Time)

Functions

func PossibleValuesForPaymentMethodFamily

func PossibleValuesForPaymentMethodFamily() []string

func ValidateBillingAccountID

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

ValidateBillingAccountID checks that 'input' can be parsed as a Billing Account ID

func ValidateBillingProfileID

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

ValidateBillingProfileID checks that 'input' can be parsed as a Billing Profile ID

Types

type Amount

type Amount struct {
	Currency *string  `json:"currency,omitempty"`
	Value    *float64 `json:"value,omitempty"`
}

type AvailableBalance

type AvailableBalance struct {
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *AvailableBalanceProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Tags       *map[string]string          `json:"tags,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type AvailableBalanceClient

type AvailableBalanceClient struct {
	Client *resourcemanager.Client
}

func NewAvailableBalanceClientWithBaseURI

func NewAvailableBalanceClientWithBaseURI(sdkApi sdkEnv.Api) (*AvailableBalanceClient, error)

func (AvailableBalanceClient) GetByBillingAccount

func (c AvailableBalanceClient) GetByBillingAccount(ctx context.Context, id BillingAccountId) (result GetByBillingAccountOperationResponse, err error)

GetByBillingAccount ...

func (AvailableBalanceClient) GetByBillingProfile

func (c AvailableBalanceClient) GetByBillingProfile(ctx context.Context, id BillingProfileId) (result GetByBillingProfileOperationResponse, err error)

GetByBillingProfile ...

type AvailableBalanceProperties

type AvailableBalanceProperties struct {
	Amount                 *Amount             `json:"amount,omitempty"`
	PaymentsOnAccount      *[]PaymentOnAccount `json:"paymentsOnAccount,omitempty"`
	TotalPaymentsOnAccount *Amount             `json:"totalPaymentsOnAccount,omitempty"`
}

type BillingAccountId

type BillingAccountId struct {
	BillingAccountName string
}

BillingAccountId is a struct representing the Resource ID for a Billing Account

func NewBillingAccountID

func NewBillingAccountID(billingAccountName 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) FromParseResult

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

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

type BillingProfileId struct {
	BillingAccountName string
	BillingProfileName string
}

BillingProfileId is a struct representing the Resource ID for a Billing Profile

func NewBillingProfileID

func NewBillingProfileID(billingAccountName string, billingProfileName 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) FromParseResult

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

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 GetByBillingAccountOperationResponse

type GetByBillingAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AvailableBalance
}

type GetByBillingProfileOperationResponse

type GetByBillingProfileOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AvailableBalance
}

type PaymentMethodFamily

type PaymentMethodFamily string

const (
	PaymentMethodFamilyCheckWire   PaymentMethodFamily = "CheckWire"
	PaymentMethodFamilyCreditCard  PaymentMethodFamily = "CreditCard"
	PaymentMethodFamilyCredits     PaymentMethodFamily = "Credits"
	PaymentMethodFamilyDirectDebit PaymentMethodFamily = "DirectDebit"
	PaymentMethodFamilyEWallet     PaymentMethodFamily = "EWallet"
	PaymentMethodFamilyNone        PaymentMethodFamily = "None"
	PaymentMethodFamilyOther       PaymentMethodFamily = "Other"
	PaymentMethodFamilyTaskOrder   PaymentMethodFamily = "TaskOrder"
)

func (*PaymentMethodFamily) UnmarshalJSON

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

type PaymentOnAccount

type PaymentOnAccount struct {
	Amount                    *Amount              `json:"amount,omitempty"`
	BillingProfileDisplayName *string              `json:"billingProfileDisplayName,omitempty"`
	BillingProfileId          *string              `json:"billingProfileId,omitempty"`
	Date                      *string              `json:"date,omitempty"`
	InvoiceId                 *string              `json:"invoiceId,omitempty"`
	InvoiceName               *string              `json:"invoiceName,omitempty"`
	PaymentMethodType         *PaymentMethodFamily `json:"paymentMethodType,omitempty"`
}

func (*PaymentOnAccount) GetDateAsTime

func (o *PaymentOnAccount) GetDateAsTime() (*time.Time, error)

func (*PaymentOnAccount) SetDateAsTime

func (o *PaymentOnAccount) SetDateAsTime(input time.Time)