pricesheets

README

github.com/hashicorp/go-azure-sdk/resource-manager/costmanagement/2023-03-01/pricesheets Documentation

The pricesheets SDK allows for interaction with the Azure Resource Manager Service costmanagement (API Version 2023-03-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/costmanagement/2023-03-01/pricesheets"

Client Initialization

client := pricesheets.NewPriceSheetsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PriceSheetsClient.PriceSheetDownload

ctx := context.TODO()
id := pricesheets.NewInvoiceID("billingAccountValue", "billingProfileValue", "invoiceValue")

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

Example Usage: PriceSheetsClient.PriceSheetDownloadByBillingProfile

ctx := context.TODO()
id := pricesheets.NewBillingProfileID("billingAccountIdValue", "billingProfileIdValue")

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

Documentation

Index

• func ValidateBillingProfileID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateInvoiceID(input interface{}, key string) (warnings []string, errors []error)
• type BillingProfileId
  • func NewBillingProfileID(billingAccountId string, billingProfileId 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 DownloadUrl
  • func (o *DownloadUrl) GetExpiryTimeAsTime() (*time.Time, error)
  • func (o *DownloadUrl) GetValidTillAsTime() (*time.Time, error)
  • func (o *DownloadUrl) SetValidTillAsTime(input time.Time)
• type InvoiceId
  • func NewInvoiceID(billingAccountName string, billingProfileName string, invoiceName string) InvoiceId
  • func ParseInvoiceID(input string) (*InvoiceId, error)
  • func ParseInvoiceIDInsensitively(input string) (*InvoiceId, error)
  • func (id *InvoiceId) FromParseResult(input resourceids.ParseResult) error
  • func (id InvoiceId) ID() string
  • func (id InvoiceId) Segments() []resourceids.Segment
  • func (id InvoiceId) String() string
• type PriceSheetDownloadByBillingProfileOperationResponse
• type PriceSheetDownloadOperationResponse
• type PriceSheetsClient
  • func NewPriceSheetsClientWithBaseURI(sdkApi sdkEnv.Api) (*PriceSheetsClient, error)
  • func (c PriceSheetsClient) PriceSheetDownload(ctx context.Context, id InvoiceId) (result PriceSheetDownloadOperationResponse, err error)
  • func (c PriceSheetsClient) PriceSheetDownloadByBillingProfile(ctx context.Context, id BillingProfileId) (result PriceSheetDownloadByBillingProfileOperationResponse, err error)
  • func (c PriceSheetsClient) PriceSheetDownloadByBillingProfileThenPoll(ctx context.Context, id BillingProfileId) error
  • func (c PriceSheetsClient) PriceSheetDownloadThenPoll(ctx context.Context, id InvoiceId) 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 ValidateInvoiceID

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

ValidateInvoiceID checks that 'input' can be parsed as a Invoice ID

Types

type BillingProfileId

type BillingProfileId struct {
	BillingAccountId string
	BillingProfileId string
}

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) 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 DownloadUrl

type DownloadUrl struct {
	DownloadUrl *string `json:"downloadUrl,omitempty"`
	ExpiryTime  *string `json:"expiryTime,omitempty"`
	ValidTill   *string `json:"validTill,omitempty"`
}

func (*DownloadUrl) GetExpiryTimeAsTime

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

func (*DownloadUrl) GetValidTillAsTime

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

func (*DownloadUrl) SetValidTillAsTime

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

type InvoiceId

type InvoiceId struct {
	BillingAccountName string
	BillingProfileName string
	InvoiceName        string
}

InvoiceId is a struct representing the Resource ID for a Invoice

func NewInvoiceID

func NewInvoiceID(billingAccountName string, billingProfileName string, invoiceName string) InvoiceId

NewInvoiceID returns a new InvoiceId struct

func ParseInvoiceID

func ParseInvoiceID(input string) (*InvoiceId, error)

ParseInvoiceID parses 'input' into a InvoiceId

func ParseInvoiceIDInsensitively

func ParseInvoiceIDInsensitively(input string) (*InvoiceId, error)

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

func (*InvoiceId) FromParseResult

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

func (InvoiceId) ID

func (id InvoiceId) ID() string

ID returns the formatted Invoice ID

func (InvoiceId) Segments

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

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

func (InvoiceId) String

func (id InvoiceId) String() string

String returns a human-readable description of this Invoice ID

type PriceSheetDownloadByBillingProfileOperationResponse

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

type PriceSheetDownloadOperationResponse

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

type PriceSheetsClient

type PriceSheetsClient struct {
	Client *resourcemanager.Client
}

func NewPriceSheetsClientWithBaseURI

func NewPriceSheetsClientWithBaseURI(sdkApi sdkEnv.Api) (*PriceSheetsClient, error)

func (PriceSheetsClient) PriceSheetDownload

func (c PriceSheetsClient) PriceSheetDownload(ctx context.Context, id InvoiceId) (result PriceSheetDownloadOperationResponse, err error)

PriceSheetDownload ...

func (PriceSheetsClient) PriceSheetDownloadByBillingProfile

func (c PriceSheetsClient) PriceSheetDownloadByBillingProfile(ctx context.Context, id BillingProfileId) (result PriceSheetDownloadByBillingProfileOperationResponse, err error)

PriceSheetDownloadByBillingProfile ...

func (PriceSheetsClient) PriceSheetDownloadByBillingProfileThenPoll

func (c PriceSheetsClient) PriceSheetDownloadByBillingProfileThenPoll(ctx context.Context, id BillingProfileId) error

PriceSheetDownloadByBillingProfileThenPoll performs PriceSheetDownloadByBillingProfile then polls until it's completed

func (PriceSheetsClient) PriceSheetDownloadThenPoll

func (c PriceSheetsClient) PriceSheetDownloadThenPoll(ctx context.Context, id InvoiceId) error

PriceSheetDownloadThenPoll performs PriceSheetDownload then polls until it's completed