billingsubscriptions

package
v0.20240215.1143935 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 15, 2024 License: MPL-2.0 Imports: 10 Imported by: 1

README

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

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

Client Initialization

client := billingsubscriptions.NewBillingSubscriptionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BillingSubscriptionsClient.Get

ctx := context.TODO()
id := billingsubscriptions.NewInvoiceSectionBillingSubscriptionID("billingAccountValue", "billingProfileValue", "invoiceSectionValue", "billingSubscriptionValue")

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
}

Example Usage: BillingSubscriptionsClient.GetByCustomer

ctx := context.TODO()
id := billingsubscriptions.NewCustomerBillingSubscriptionID("billingAccountValue", "customerValue", "billingSubscriptionValue")

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

Example Usage: BillingSubscriptionsClient.ListByBillingAccount

ctx := context.TODO()
id := billingsubscriptions.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: BillingSubscriptionsClient.ListByBillingProfile

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

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

Example Usage: BillingSubscriptionsClient.ListByCustomer

ctx := context.TODO()
id := billingsubscriptions.NewCustomerID("billingAccountValue", "customerValue")

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

Example Usage: BillingSubscriptionsClient.ListByInvoiceSection

ctx := context.TODO()
id := billingsubscriptions.NewInvoiceSectionID("billingAccountValue", "billingProfileValue", "invoiceSectionValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForBillingSubscriptionStatusType

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

func ValidateCustomerBillingSubscriptionID

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

ValidateCustomerBillingSubscriptionID checks that 'input' can be parsed as a Customer Billing Subscription ID

func ValidateCustomerID

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

ValidateCustomerID checks that 'input' can be parsed as a Customer ID

func ValidateInvoiceSectionBillingSubscriptionID

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

ValidateInvoiceSectionBillingSubscriptionID checks that 'input' can be parsed as a Invoice Section Billing Subscription ID

func ValidateInvoiceSectionID

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

ValidateInvoiceSectionID checks that 'input' can be parsed as a Invoice Section ID

Types

type Amount

type Amount struct {
	Currency *string  `json:"currency,omitempty"`
	Value    *float64 `json:"value,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 BillingSubscription

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

type BillingSubscriptionOperationPredicate

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

func (BillingSubscriptionOperationPredicate) Matches

type BillingSubscriptionProperties

type BillingSubscriptionProperties struct {
	BillingProfileDisplayName *string                        `json:"billingProfileDisplayName,omitempty"`
	BillingProfileId          *string                        `json:"billingProfileId,omitempty"`
	CustomerDisplayName       *string                        `json:"customerDisplayName,omitempty"`
	CustomerId                *string                        `json:"customerId,omitempty"`
	DisplayName               *string                        `json:"displayName,omitempty"`
	InvoiceSectionDisplayName *string                        `json:"invoiceSectionDisplayName,omitempty"`
	InvoiceSectionId          *string                        `json:"invoiceSectionId,omitempty"`
	LastMonthCharges          *Amount                        `json:"lastMonthCharges,omitempty"`
	MonthToDateCharges        *Amount                        `json:"monthToDateCharges,omitempty"`
	Reseller                  *Reseller                      `json:"reseller,omitempty"`
	SkuDescription            *string                        `json:"skuDescription,omitempty"`
	SkuId                     *string                        `json:"skuId,omitempty"`
	SubscriptionBillingStatus *BillingSubscriptionStatusType `json:"subscriptionBillingStatus,omitempty"`
	SubscriptionId            *string                        `json:"subscriptionId,omitempty"`
}

type BillingSubscriptionStatusType

type BillingSubscriptionStatusType string
const (
	BillingSubscriptionStatusTypeAbandoned BillingSubscriptionStatusType = "Abandoned"
	BillingSubscriptionStatusTypeActive    BillingSubscriptionStatusType = "Active"
	BillingSubscriptionStatusTypeDeleted   BillingSubscriptionStatusType = "Deleted"
	BillingSubscriptionStatusTypeInactive  BillingSubscriptionStatusType = "Inactive"
	BillingSubscriptionStatusTypeWarning   BillingSubscriptionStatusType = "Warning"
)

func (*BillingSubscriptionStatusType) UnmarshalJSON

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

type BillingSubscriptionsClient

type BillingSubscriptionsClient struct {
	Client *resourcemanager.Client
}

func NewBillingSubscriptionsClientWithBaseURI

func NewBillingSubscriptionsClientWithBaseURI(sdkApi sdkEnv.Api) (*BillingSubscriptionsClient, error)

func (BillingSubscriptionsClient) Get

Get ...

func (BillingSubscriptionsClient) GetByCustomer

GetByCustomer ...

func (BillingSubscriptionsClient) ListByBillingAccount

ListByBillingAccount ...

func (BillingSubscriptionsClient) ListByBillingAccountComplete

ListByBillingAccountComplete retrieves all the results into a single object

func (BillingSubscriptionsClient) ListByBillingAccountCompleteMatchingPredicate

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

ListByBillingAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BillingSubscriptionsClient) ListByBillingProfile

ListByBillingProfile ...

func (BillingSubscriptionsClient) ListByCustomer

ListByCustomer ...

func (BillingSubscriptionsClient) ListByCustomerComplete

ListByCustomerComplete retrieves all the results into a single object

func (BillingSubscriptionsClient) ListByCustomerCompleteMatchingPredicate

func (c BillingSubscriptionsClient) ListByCustomerCompleteMatchingPredicate(ctx context.Context, id CustomerId, predicate BillingSubscriptionOperationPredicate) (result ListByCustomerCompleteResult, err error)

ListByCustomerCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BillingSubscriptionsClient) ListByInvoiceSection

ListByInvoiceSection ...

type BillingSubscriptionsListResult

type BillingSubscriptionsListResult struct {
	NextLink *string                `json:"nextLink,omitempty"`
	Value    *[]BillingSubscription `json:"value,omitempty"`
}

type CustomerBillingSubscriptionId

type CustomerBillingSubscriptionId struct {
	BillingAccountName      string
	CustomerName            string
	BillingSubscriptionName string
}

CustomerBillingSubscriptionId is a struct representing the Resource ID for a Customer Billing Subscription

func NewCustomerBillingSubscriptionID

func NewCustomerBillingSubscriptionID(billingAccountName string, customerName string, billingSubscriptionName string) CustomerBillingSubscriptionId

NewCustomerBillingSubscriptionID returns a new CustomerBillingSubscriptionId struct

func ParseCustomerBillingSubscriptionID

func ParseCustomerBillingSubscriptionID(input string) (*CustomerBillingSubscriptionId, error)

ParseCustomerBillingSubscriptionID parses 'input' into a CustomerBillingSubscriptionId

func ParseCustomerBillingSubscriptionIDInsensitively

func ParseCustomerBillingSubscriptionIDInsensitively(input string) (*CustomerBillingSubscriptionId, error)

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

func (*CustomerBillingSubscriptionId) FromParseResult

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

func (CustomerBillingSubscriptionId) ID

ID returns the formatted Customer Billing Subscription ID

func (CustomerBillingSubscriptionId) Segments

Segments returns a slice of Resource ID Segments which comprise this Customer Billing Subscription ID

func (CustomerBillingSubscriptionId) String

String returns a human-readable description of this Customer Billing Subscription ID

type CustomerId

type CustomerId struct {
	BillingAccountName string
	CustomerName       string
}

CustomerId is a struct representing the Resource ID for a Customer

func NewCustomerID

func NewCustomerID(billingAccountName string, customerName string) CustomerId

NewCustomerID returns a new CustomerId struct

func ParseCustomerID

func ParseCustomerID(input string) (*CustomerId, error)

ParseCustomerID parses 'input' into a CustomerId

func ParseCustomerIDInsensitively

func ParseCustomerIDInsensitively(input string) (*CustomerId, error)

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

func (*CustomerId) FromParseResult

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

func (CustomerId) ID

func (id CustomerId) ID() string

ID returns the formatted Customer ID

func (CustomerId) Segments

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

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

func (CustomerId) String

func (id CustomerId) String() string

String returns a human-readable description of this Customer ID

type GetByCustomerOperationResponse

type GetByCustomerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BillingSubscription
}

type GetOperationResponse

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

type InvoiceSectionBillingSubscriptionId

type InvoiceSectionBillingSubscriptionId struct {
	BillingAccountName      string
	BillingProfileName      string
	InvoiceSectionName      string
	BillingSubscriptionName string
}

InvoiceSectionBillingSubscriptionId is a struct representing the Resource ID for a Invoice Section Billing Subscription

func NewInvoiceSectionBillingSubscriptionID

func NewInvoiceSectionBillingSubscriptionID(billingAccountName string, billingProfileName string, invoiceSectionName string, billingSubscriptionName string) InvoiceSectionBillingSubscriptionId

NewInvoiceSectionBillingSubscriptionID returns a new InvoiceSectionBillingSubscriptionId struct

func ParseInvoiceSectionBillingSubscriptionID

func ParseInvoiceSectionBillingSubscriptionID(input string) (*InvoiceSectionBillingSubscriptionId, error)

ParseInvoiceSectionBillingSubscriptionID parses 'input' into a InvoiceSectionBillingSubscriptionId

func ParseInvoiceSectionBillingSubscriptionIDInsensitively

func ParseInvoiceSectionBillingSubscriptionIDInsensitively(input string) (*InvoiceSectionBillingSubscriptionId, error)

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

func (*InvoiceSectionBillingSubscriptionId) FromParseResult

func (InvoiceSectionBillingSubscriptionId) ID

ID returns the formatted Invoice Section Billing Subscription ID

func (InvoiceSectionBillingSubscriptionId) Segments

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

func (InvoiceSectionBillingSubscriptionId) String

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

type InvoiceSectionId

type InvoiceSectionId struct {
	BillingAccountName string
	BillingProfileName string
	InvoiceSectionName string
}

InvoiceSectionId is a struct representing the Resource ID for a Invoice Section

func NewInvoiceSectionID

func NewInvoiceSectionID(billingAccountName string, billingProfileName string, invoiceSectionName string) InvoiceSectionId

NewInvoiceSectionID returns a new InvoiceSectionId struct

func ParseInvoiceSectionID

func ParseInvoiceSectionID(input string) (*InvoiceSectionId, error)

ParseInvoiceSectionID parses 'input' into a InvoiceSectionId

func ParseInvoiceSectionIDInsensitively

func ParseInvoiceSectionIDInsensitively(input string) (*InvoiceSectionId, error)

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

func (*InvoiceSectionId) FromParseResult

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

func (InvoiceSectionId) ID

func (id InvoiceSectionId) ID() string

ID returns the formatted Invoice Section ID

func (InvoiceSectionId) Segments

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

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

func (InvoiceSectionId) String

func (id InvoiceSectionId) String() string

String returns a human-readable description of this Invoice Section ID

type ListByBillingAccountCompleteResult

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

type ListByBillingAccountOperationResponse

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

type ListByBillingProfileOperationResponse

type ListByBillingProfileOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BillingSubscriptionsListResult
}

type ListByCustomerCompleteResult

type ListByCustomerCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []BillingSubscription
}

type ListByCustomerOperationResponse

type ListByCustomerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]BillingSubscription
}

type ListByInvoiceSectionOperationResponse

type ListByInvoiceSectionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BillingSubscriptionsListResult
}

type Reseller

type Reseller struct {
	Description *string `json:"description,omitempty"`
	ResellerId  *string `json:"resellerId,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL