paymentmethods

README

github.com/hashicorp/go-azure-sdk/resource-manager/billing/2019-10-01-preview/paymentmethods Documentation

The paymentmethods SDK allows for interaction with the Azure Resource Manager Service billing (API Version 2019-10-01-preview).

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/2019-10-01-preview/paymentmethods"

Client Initialization

client := paymentmethods.NewPaymentMethodsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PaymentMethodsClient.ListByBillingAccount

ctx := context.TODO()
id := paymentmethods.NewBillingAccountID("billingAccountValue")

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

Example Usage: PaymentMethodsClient.ListByBillingProfile

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

// 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
}

Documentation

Index

• func PossibleValuesForPaymentMethodType() []string
• func ValidateBillingAccountID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateBillingProfileID(input interface{}, key string) (warnings []string, errors []error)
• 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 ListByBillingAccountCompleteResult
• type ListByBillingAccountOperationResponse
• type ListByBillingProfileCompleteResult
• type ListByBillingProfileOperationResponse
• type PaymentMethod
• type PaymentMethodOperationPredicate
  • func (p PaymentMethodOperationPredicate) Matches(input PaymentMethod) bool
• type PaymentMethodProperties
• type PaymentMethodType
  • func (s *PaymentMethodType) UnmarshalJSON(bytes []byte) error
• type PaymentMethodsClient
  • func NewPaymentMethodsClientWithBaseURI(sdkApi sdkEnv.Api) (*PaymentMethodsClient, error)
  • func (c PaymentMethodsClient) ListByBillingAccount(ctx context.Context, id BillingAccountId) (result ListByBillingAccountOperationResponse, err error)
  • func (c PaymentMethodsClient) ListByBillingAccountComplete(ctx context.Context, id BillingAccountId) (ListByBillingAccountCompleteResult, error)
  • func (c PaymentMethodsClient) ListByBillingAccountCompleteMatchingPredicate(ctx context.Context, id BillingAccountId, ...) (result ListByBillingAccountCompleteResult, err error)
  • func (c PaymentMethodsClient) ListByBillingProfile(ctx context.Context, id BillingProfileId) (result ListByBillingProfileOperationResponse, err error)
  • func (c PaymentMethodsClient) ListByBillingProfileComplete(ctx context.Context, id BillingProfileId) (ListByBillingProfileCompleteResult, error)
  • func (c PaymentMethodsClient) ListByBillingProfileCompleteMatchingPredicate(ctx context.Context, id BillingProfileId, ...) (result ListByBillingProfileCompleteResult, err error)

Functions

func PossibleValuesForPaymentMethodType

func PossibleValuesForPaymentMethodType() []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 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 ListByBillingAccountCompleteResult

type ListByBillingAccountCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PaymentMethod
}

type ListByBillingAccountOperationResponse

type ListByBillingAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PaymentMethod
}

type ListByBillingProfileCompleteResult

type ListByBillingProfileCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PaymentMethod
}

type ListByBillingProfileOperationResponse

type ListByBillingProfileOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PaymentMethod
}

type PaymentMethod

type PaymentMethod struct {
	Id         *string                  `json:"id,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Properties *PaymentMethodProperties `json:"properties,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type PaymentMethodOperationPredicate

type PaymentMethodOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (PaymentMethodOperationPredicate) Matches

func (p PaymentMethodOperationPredicate) Matches(input PaymentMethod) bool

type PaymentMethodProperties

type PaymentMethodProperties struct {
	Currency          *string            `json:"currency,omitempty"`
	Details           *string            `json:"details,omitempty"`
	Expiration        *string            `json:"expiration,omitempty"`
	PaymentMethodType *PaymentMethodType `json:"paymentMethodType,omitempty"`
}

type PaymentMethodType

type PaymentMethodType string

const (
	PaymentMethodTypeChequeWire PaymentMethodType = "ChequeWire"
	PaymentMethodTypeCredits    PaymentMethodType = "Credits"
)

func (*PaymentMethodType) UnmarshalJSON

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

type PaymentMethodsClient

type PaymentMethodsClient struct {
	Client *resourcemanager.Client
}

func NewPaymentMethodsClientWithBaseURI

func NewPaymentMethodsClientWithBaseURI(sdkApi sdkEnv.Api) (*PaymentMethodsClient, error)

func (PaymentMethodsClient) ListByBillingAccount

func (c PaymentMethodsClient) ListByBillingAccount(ctx context.Context, id BillingAccountId) (result ListByBillingAccountOperationResponse, err error)

ListByBillingAccount ...

func (PaymentMethodsClient) ListByBillingAccountComplete

func (c PaymentMethodsClient) ListByBillingAccountComplete(ctx context.Context, id BillingAccountId) (ListByBillingAccountCompleteResult, error)

ListByBillingAccountComplete retrieves all the results into a single object

func (PaymentMethodsClient) ListByBillingAccountCompleteMatchingPredicate

func (c PaymentMethodsClient) ListByBillingAccountCompleteMatchingPredicate(ctx context.Context, id BillingAccountId, predicate PaymentMethodOperationPredicate) (result ListByBillingAccountCompleteResult, err error)

ListByBillingAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PaymentMethodsClient) ListByBillingProfile

func (c PaymentMethodsClient) ListByBillingProfile(ctx context.Context, id BillingProfileId) (result ListByBillingProfileOperationResponse, err error)

ListByBillingProfile ...

func (PaymentMethodsClient) ListByBillingProfileComplete

func (c PaymentMethodsClient) ListByBillingProfileComplete(ctx context.Context, id BillingProfileId) (ListByBillingProfileCompleteResult, error)

ListByBillingProfileComplete retrieves all the results into a single object

func (PaymentMethodsClient) ListByBillingProfileCompleteMatchingPredicate

func (c PaymentMethodsClient) ListByBillingProfileCompleteMatchingPredicate(ctx context.Context, id BillingProfileId, predicate PaymentMethodOperationPredicate) (result ListByBillingProfileCompleteResult, err error)

ListByBillingProfileCompleteMatchingPredicate retrieves all the results and then applies the predicate