billingroledefinitions

package
v0.20241212.1154051 Latest Latest
Warning

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

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

README

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

The billingroledefinitions SDK allows for interaction with Azure Resource Manager 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/billingroledefinitions"

Client Initialization

client := billingroledefinitions.NewBillingRoleDefinitionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BillingRoleDefinitionsClient.GetByBillingAccount

ctx := context.TODO()
id := billingroledefinitions.NewBillingRoleDefinitionID("billingAccountName", "billingRoleDefinitionName")

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

Example Usage: BillingRoleDefinitionsClient.GetByBillingProfile

ctx := context.TODO()
id := billingroledefinitions.NewBillingProfileBillingRoleDefinitionID("billingAccountName", "billingProfileName", "billingRoleDefinitionName")

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

Example Usage: BillingRoleDefinitionsClient.GetByInvoiceSection

ctx := context.TODO()
id := billingroledefinitions.NewInvoiceSectionBillingRoleDefinitionID("billingAccountName", "billingProfileName", "invoiceSectionName", "billingRoleDefinitionName")

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

Example Usage: BillingRoleDefinitionsClient.ListByBillingAccount

ctx := context.TODO()
id := billingroledefinitions.NewBillingAccountID("billingAccountName")

// 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: BillingRoleDefinitionsClient.ListByBillingProfile

ctx := context.TODO()
id := billingroledefinitions.NewBillingProfileID("billingAccountName", "billingProfileName")

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

Example Usage: BillingRoleDefinitionsClient.ListByInvoiceSection

ctx := context.TODO()
id := billingroledefinitions.NewInvoiceSectionID("billingAccountName", "billingProfileName", "invoiceSectionName")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

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 ValidateBillingProfileBillingRoleDefinitionID 

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

ValidateBillingProfileBillingRoleDefinitionID checks that 'input' can be parsed as a Billing Profile Billing Role Definition 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 ValidateBillingRoleDefinitionID 

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

ValidateBillingRoleDefinitionID checks that 'input' can be parsed as a Billing Role Definition ID

func ValidateInvoiceSectionBillingRoleDefinitionID 

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

ValidateInvoiceSectionBillingRoleDefinitionID checks that 'input' can be parsed as a Invoice Section Billing Role Definition 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 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 BillingPermissionsProperties 

type BillingPermissionsProperties struct {
	Actions    *[]string `json:"actions,omitempty"`
	NotActions *[]string `json:"notActions,omitempty"`
}

type BillingProfileBillingRoleDefinitionId 

type BillingProfileBillingRoleDefinitionId struct {
	BillingAccountName        string
	BillingProfileName        string
	BillingRoleDefinitionName string
}

BillingProfileBillingRoleDefinitionId is a struct representing the Resource ID for a Billing Profile Billing Role Definition

func NewBillingProfileBillingRoleDefinitionID 

func NewBillingProfileBillingRoleDefinitionID(billingAccountName string, billingProfileName string, billingRoleDefinitionName string) BillingProfileBillingRoleDefinitionId

NewBillingProfileBillingRoleDefinitionID returns a new BillingProfileBillingRoleDefinitionId struct

func ParseBillingProfileBillingRoleDefinitionID 

func ParseBillingProfileBillingRoleDefinitionID(input string) (*BillingProfileBillingRoleDefinitionId, error)

ParseBillingProfileBillingRoleDefinitionID parses 'input' into a BillingProfileBillingRoleDefinitionId

func ParseBillingProfileBillingRoleDefinitionIDInsensitively 

func ParseBillingProfileBillingRoleDefinitionIDInsensitively(input string) (*BillingProfileBillingRoleDefinitionId, error)

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

func (*BillingProfileBillingRoleDefinitionId) FromParseResult 

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

func (BillingProfileBillingRoleDefinitionId) ID 

func (id BillingProfileBillingRoleDefinitionId) ID() string

ID returns the formatted Billing Profile Billing Role Definition ID

func (BillingProfileBillingRoleDefinitionId) Segments 

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

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

func (BillingProfileBillingRoleDefinitionId) String 

func (id BillingProfileBillingRoleDefinitionId) String() string

String returns a human-readable description of this Billing Profile Billing Role Definition 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 BillingRoleDefinition 

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

type BillingRoleDefinitionId 

type BillingRoleDefinitionId struct {
	BillingAccountName        string
	BillingRoleDefinitionName string
}

BillingRoleDefinitionId is a struct representing the Resource ID for a Billing Role Definition

func NewBillingRoleDefinitionID 

func NewBillingRoleDefinitionID(billingAccountName string, billingRoleDefinitionName string) BillingRoleDefinitionId

NewBillingRoleDefinitionID returns a new BillingRoleDefinitionId struct

func ParseBillingRoleDefinitionID 

func ParseBillingRoleDefinitionID(input string) (*BillingRoleDefinitionId, error)

ParseBillingRoleDefinitionID parses 'input' into a BillingRoleDefinitionId

func ParseBillingRoleDefinitionIDInsensitively 

func ParseBillingRoleDefinitionIDInsensitively(input string) (*BillingRoleDefinitionId, error)

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

func (*BillingRoleDefinitionId) FromParseResult 

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

func (BillingRoleDefinitionId) ID 

func (id BillingRoleDefinitionId) ID() string

ID returns the formatted Billing Role Definition ID

func (BillingRoleDefinitionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Billing Role Definition ID

func (BillingRoleDefinitionId) String 

func (id BillingRoleDefinitionId) String() string

String returns a human-readable description of this Billing Role Definition ID

type BillingRoleDefinitionOperationPredicate 

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

func (BillingRoleDefinitionOperationPredicate) Matches 

func (p BillingRoleDefinitionOperationPredicate) Matches(input BillingRoleDefinition) bool

type BillingRoleDefinitionProperties 

type BillingRoleDefinitionProperties struct {
	Description *string                         `json:"description,omitempty"`
	Permissions *[]BillingPermissionsProperties `json:"permissions,omitempty"`
	RoleName    *string                         `json:"roleName,omitempty"`
}

type BillingRoleDefinitionsClient 

type BillingRoleDefinitionsClient struct {
	Client *resourcemanager.Client
}

func NewBillingRoleDefinitionsClientWithBaseURI 

func NewBillingRoleDefinitionsClientWithBaseURI(sdkApi sdkEnv.Api) (*BillingRoleDefinitionsClient, error)

func (BillingRoleDefinitionsClient) GetByBillingAccount 

func (c BillingRoleDefinitionsClient) GetByBillingAccount(ctx context.Context, id BillingRoleDefinitionId) (result GetByBillingAccountOperationResponse, err error)

GetByBillingAccount ...

func (BillingRoleDefinitionsClient) GetByBillingProfile 

func (c BillingRoleDefinitionsClient) GetByBillingProfile(ctx context.Context, id BillingProfileBillingRoleDefinitionId) (result GetByBillingProfileOperationResponse, err error)

GetByBillingProfile ...

func (BillingRoleDefinitionsClient) GetByInvoiceSection 

func (c BillingRoleDefinitionsClient) GetByInvoiceSection(ctx context.Context, id InvoiceSectionBillingRoleDefinitionId) (result GetByInvoiceSectionOperationResponse, err error)

GetByInvoiceSection ...

func (BillingRoleDefinitionsClient) ListByBillingAccount 

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

ListByBillingAccount ...

func (BillingRoleDefinitionsClient) ListByBillingAccountComplete 

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

ListByBillingAccountComplete retrieves all the results into a single object

func (BillingRoleDefinitionsClient) ListByBillingAccountCompleteMatchingPredicate 

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

ListByBillingAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BillingRoleDefinitionsClient) ListByBillingProfile 

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

ListByBillingProfile ...

func (BillingRoleDefinitionsClient) ListByBillingProfileComplete 

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

ListByBillingProfileComplete retrieves all the results into a single object

func (BillingRoleDefinitionsClient) ListByBillingProfileCompleteMatchingPredicate 

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

ListByBillingProfileCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BillingRoleDefinitionsClient) ListByInvoiceSection 

func (c BillingRoleDefinitionsClient) ListByInvoiceSection(ctx context.Context, id InvoiceSectionId) (result ListByInvoiceSectionOperationResponse, err error)

ListByInvoiceSection ...

func (BillingRoleDefinitionsClient) ListByInvoiceSectionComplete 

func (c BillingRoleDefinitionsClient) ListByInvoiceSectionComplete(ctx context.Context, id InvoiceSectionId) (ListByInvoiceSectionCompleteResult, error)

ListByInvoiceSectionComplete retrieves all the results into a single object

func (BillingRoleDefinitionsClient) ListByInvoiceSectionCompleteMatchingPredicate 

func (c BillingRoleDefinitionsClient) ListByInvoiceSectionCompleteMatchingPredicate(ctx context.Context, id InvoiceSectionId, predicate BillingRoleDefinitionOperationPredicate) (result ListByInvoiceSectionCompleteResult, err error)

ListByInvoiceSectionCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetByBillingAccountOperationResponse 

type GetByBillingAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BillingRoleDefinition
}

type GetByBillingProfileOperationResponse 

type GetByBillingProfileOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BillingRoleDefinition
}

type GetByInvoiceSectionOperationResponse 

type GetByInvoiceSectionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BillingRoleDefinition
}

type InvoiceSectionBillingRoleDefinitionId 

type InvoiceSectionBillingRoleDefinitionId struct {
	BillingAccountName        string
	BillingProfileName        string
	InvoiceSectionName        string
	BillingRoleDefinitionName string
}

InvoiceSectionBillingRoleDefinitionId is a struct representing the Resource ID for a Invoice Section Billing Role Definition

func NewInvoiceSectionBillingRoleDefinitionID 

func NewInvoiceSectionBillingRoleDefinitionID(billingAccountName string, billingProfileName string, invoiceSectionName string, billingRoleDefinitionName string) InvoiceSectionBillingRoleDefinitionId

NewInvoiceSectionBillingRoleDefinitionID returns a new InvoiceSectionBillingRoleDefinitionId struct

func ParseInvoiceSectionBillingRoleDefinitionID 

func ParseInvoiceSectionBillingRoleDefinitionID(input string) (*InvoiceSectionBillingRoleDefinitionId, error)

ParseInvoiceSectionBillingRoleDefinitionID parses 'input' into a InvoiceSectionBillingRoleDefinitionId

func ParseInvoiceSectionBillingRoleDefinitionIDInsensitively 

func ParseInvoiceSectionBillingRoleDefinitionIDInsensitively(input string) (*InvoiceSectionBillingRoleDefinitionId, error)

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

func (*InvoiceSectionBillingRoleDefinitionId) FromParseResult 

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

func (InvoiceSectionBillingRoleDefinitionId) ID 

func (id InvoiceSectionBillingRoleDefinitionId) ID() string

ID returns the formatted Invoice Section Billing Role Definition ID

func (InvoiceSectionBillingRoleDefinitionId) Segments 

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

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

func (InvoiceSectionBillingRoleDefinitionId) String 

func (id InvoiceSectionBillingRoleDefinitionId) String() string

String returns a human-readable description of this Invoice Section Billing Role Definition 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              []BillingRoleDefinition
}

type ListByBillingAccountCustomPager added in v0.20240628.1153531 

type ListByBillingAccountCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByBillingAccountCustomPager) NextPageLink() *odata.Link

type ListByBillingAccountOperationResponse 

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

type ListByBillingProfileCompleteResult 

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

type ListByBillingProfileCustomPager added in v0.20240628.1153531 

type ListByBillingProfileCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByBillingProfileCustomPager) NextPageLink() *odata.Link

type ListByBillingProfileOperationResponse 

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

type ListByInvoiceSectionCompleteResult 

type ListByInvoiceSectionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []BillingRoleDefinition
}

type ListByInvoiceSectionCustomPager added in v0.20240628.1153531 

type ListByInvoiceSectionCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByInvoiceSectionCustomPager) NextPageLink() *odata.Link

type ListByInvoiceSectionOperationResponse 

type ListByInvoiceSectionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]BillingRoleDefinition
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.