pricesheet

README

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

The pricesheet 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/pricesheet"

Client Initialization

client := pricesheet.NewPriceSheetClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PriceSheetClient.Download

ctx := context.TODO()
id := pricesheet.NewBillingProfileInvoiceID("billingAccountValue", "billingProfileValue", "invoiceValue")

if err := client.DownloadThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: PriceSheetClient.DownloadByBillingProfile

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

if err := client.DownloadByBillingProfileThenPoll(ctx, id); err != nil {
	// handle the error
}

Documentation

Index

• func ValidateBillingProfileID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateBillingProfileInvoiceID(input interface{}, key string) (warnings []string, errors []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 BillingProfileInvoiceId
  • func NewBillingProfileInvoiceID(billingAccountName string, billingProfileName string, invoiceName string) BillingProfileInvoiceId
  • func ParseBillingProfileInvoiceID(input string) (*BillingProfileInvoiceId, error)
  • func ParseBillingProfileInvoiceIDInsensitively(input string) (*BillingProfileInvoiceId, error)
  • func (id *BillingProfileInvoiceId) FromParseResult(input resourceids.ParseResult) error
  • func (id BillingProfileInvoiceId) ID() string
  • func (id BillingProfileInvoiceId) Segments() []resourceids.Segment
  • func (id BillingProfileInvoiceId) String() string
• type DownloadByBillingProfileOperationResponse
• type DownloadOperationResponse
• type DownloadUrl
  • func (o *DownloadUrl) GetExpiryTimeAsTime() (*time.Time, error)
  • func (o *DownloadUrl) SetExpiryTimeAsTime(input time.Time)
• type PriceSheetClient
  • func NewPriceSheetClientWithBaseURI(sdkApi sdkEnv.Api) (*PriceSheetClient, error)
  • func (c PriceSheetClient) Download(ctx context.Context, id BillingProfileInvoiceId) (result DownloadOperationResponse, err error)
  • func (c PriceSheetClient) DownloadByBillingProfile(ctx context.Context, id BillingProfileId) (result DownloadByBillingProfileOperationResponse, err error)
  • func (c PriceSheetClient) DownloadByBillingProfileThenPoll(ctx context.Context, id BillingProfileId) error
  • func (c PriceSheetClient) DownloadThenPoll(ctx context.Context, id BillingProfileInvoiceId) error

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

func ValidateBillingProfileInvoiceID

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

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

Types

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 BillingProfileInvoiceId

type BillingProfileInvoiceId struct {
	BillingAccountName string
	BillingProfileName string
	InvoiceName        string
}

BillingProfileInvoiceId is a struct representing the Resource ID for a Billing Profile Invoice

func NewBillingProfileInvoiceID

func NewBillingProfileInvoiceID(billingAccountName string, billingProfileName string, invoiceName string) BillingProfileInvoiceId

NewBillingProfileInvoiceID returns a new BillingProfileInvoiceId struct

func ParseBillingProfileInvoiceID

func ParseBillingProfileInvoiceID(input string) (*BillingProfileInvoiceId, error)

ParseBillingProfileInvoiceID parses 'input' into a BillingProfileInvoiceId

func ParseBillingProfileInvoiceIDInsensitively

func ParseBillingProfileInvoiceIDInsensitively(input string) (*BillingProfileInvoiceId, error)

ParseBillingProfileInvoiceIDInsensitively parses 'input' case-insensitively into a BillingProfileInvoiceId note: this method should only be used for API response data and not user input

func (*BillingProfileInvoiceId) FromParseResult

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

func (BillingProfileInvoiceId) ID

func (id BillingProfileInvoiceId) ID() string

ID returns the formatted Billing Profile Invoice ID

func (BillingProfileInvoiceId) Segments

func (id BillingProfileInvoiceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Billing Profile Invoice ID

func (BillingProfileInvoiceId) String

func (id BillingProfileInvoiceId) String() string

String returns a human-readable description of this Billing Profile Invoice ID

type DownloadByBillingProfileOperationResponse

type DownloadByBillingProfileOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DownloadUrl
}

type DownloadOperationResponse

type DownloadOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DownloadUrl
}

type DownloadUrl

type DownloadUrl struct {
	ExpiryTime *string `json:"expiryTime,omitempty"`
	Url        *string `json:"url,omitempty"`
}

func (*DownloadUrl) GetExpiryTimeAsTime

func (o *DownloadUrl) GetExpiryTimeAsTime() (*time.Time, error)

func (*DownloadUrl) SetExpiryTimeAsTime

func (o *DownloadUrl) SetExpiryTimeAsTime(input time.Time)

type PriceSheetClient

type PriceSheetClient struct {
	Client *resourcemanager.Client
}

func NewPriceSheetClientWithBaseURI

func NewPriceSheetClientWithBaseURI(sdkApi sdkEnv.Api) (*PriceSheetClient, error)

func (PriceSheetClient) Download

func (c PriceSheetClient) Download(ctx context.Context, id BillingProfileInvoiceId) (result DownloadOperationResponse, err error)

Download ...

func (PriceSheetClient) DownloadByBillingProfile

func (c PriceSheetClient) DownloadByBillingProfile(ctx context.Context, id BillingProfileId) (result DownloadByBillingProfileOperationResponse, err error)

DownloadByBillingProfile ...

func (PriceSheetClient) DownloadByBillingProfileThenPoll

func (c PriceSheetClient) DownloadByBillingProfileThenPoll(ctx context.Context, id BillingProfileId) error

DownloadByBillingProfileThenPoll performs DownloadByBillingProfile then polls until it's completed

func (PriceSheetClient) DownloadThenPoll

func (c PriceSheetClient) DownloadThenPoll(ctx context.Context, id BillingProfileInvoiceId) error

DownloadThenPoll performs Download then polls until it's completed