availablebalances

README

github.com/hashicorp/go-azure-sdk/resource-manager/billing/2020-05-01/availablebalances Documentation

The availablebalances SDK allows for interaction with the Azure Resource Manager Service billing (API Version 2020-05-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/2020-05-01/availablebalances"

Client Initialization

client := availablebalances.NewAvailableBalancesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AvailableBalancesClient.Get

ctx := context.TODO()
id := availablebalances.NewBillingProfileID("billingAccountValue", "billingProfileValue")

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

Documentation

Index

• func ValidateBillingProfileID(input interface{}, key string) (warnings []string, errors []error)
• type Amount
• type AvailableBalance
• type AvailableBalanceProperties
• type AvailableBalancesClient
  • func NewAvailableBalancesClientWithBaseURI(sdkApi sdkEnv.Api) (*AvailableBalancesClient, error)
  • func (c AvailableBalancesClient) Get(ctx context.Context, id BillingProfileId) (result GetOperationResponse, err error)
• 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 GetOperationResponse

Functions

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"`
	Type       *string                     `json:"type,omitempty"`
}

type AvailableBalanceProperties

type AvailableBalanceProperties struct {
	Amount *Amount `json:"amount,omitempty"`
}

type AvailableBalancesClient

type AvailableBalancesClient struct {
	Client *resourcemanager.Client
}

func NewAvailableBalancesClientWithBaseURI

func NewAvailableBalancesClientWithBaseURI(sdkApi sdkEnv.Api) (*AvailableBalancesClient, error)

func (AvailableBalancesClient) Get

func (c AvailableBalancesClient) Get(ctx context.Context, id BillingProfileId) (result GetOperationResponse, err error)

Get ...

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 GetOperationResponse

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