billingroleassignments

package
v0.20241004.1180715 Latest Latest
Warning

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

Go to latest
Published: Oct 4, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

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

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

Client Initialization

client := billingroleassignments.NewBillingRoleAssignmentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BillingRoleAssignmentsClient.DeleteByBillingAccount

ctx := context.TODO()
id := billingroleassignments.NewBillingRoleAssignmentID("billingAccountName", "billingRoleAssignmentName")

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

Example Usage: BillingRoleAssignmentsClient.DeleteByBillingProfile

ctx := context.TODO()
id := billingroleassignments.NewBillingProfileBillingRoleAssignmentID("billingAccountName", "billingProfileName", "billingRoleAssignmentName")

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

Example Usage: BillingRoleAssignmentsClient.DeleteByInvoiceSection

ctx := context.TODO()
id := billingroleassignments.NewInvoiceSectionBillingRoleAssignmentID("billingAccountName", "billingProfileName", "invoiceSectionName", "billingRoleAssignmentName")

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

Example Usage: BillingRoleAssignmentsClient.GetByBillingAccount

ctx := context.TODO()
id := billingroleassignments.NewBillingRoleAssignmentID("billingAccountName", "billingRoleAssignmentName")

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: BillingRoleAssignmentsClient.GetByBillingProfile

ctx := context.TODO()
id := billingroleassignments.NewBillingProfileBillingRoleAssignmentID("billingAccountName", "billingProfileName", "billingRoleAssignmentName")

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: BillingRoleAssignmentsClient.GetByInvoiceSection

ctx := context.TODO()
id := billingroleassignments.NewInvoiceSectionBillingRoleAssignmentID("billingAccountName", "billingProfileName", "invoiceSectionName", "billingRoleAssignmentName")

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: BillingRoleAssignmentsClient.ListByBillingAccount

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

ctx := context.TODO()
id := billingroleassignments.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: BillingRoleAssignmentsClient.ListByInvoiceSection

ctx := context.TODO()
id := billingroleassignments.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 ValidateBillingProfileBillingRoleAssignmentID

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

ValidateBillingProfileBillingRoleAssignmentID checks that 'input' can be parsed as a Billing Profile Billing Role Assignment 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 ValidateBillingRoleAssignmentID

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

ValidateBillingRoleAssignmentID checks that 'input' can be parsed as a Billing Role Assignment ID

func ValidateInvoiceSectionBillingRoleAssignmentID

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

ValidateInvoiceSectionBillingRoleAssignmentID checks that 'input' can be parsed as a Invoice Section Billing Role Assignment 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 BillingProfileBillingRoleAssignmentId

type BillingProfileBillingRoleAssignmentId struct {
	BillingAccountName        string
	BillingProfileName        string
	BillingRoleAssignmentName string
}

BillingProfileBillingRoleAssignmentId is a struct representing the Resource ID for a Billing Profile Billing Role Assignment

func NewBillingProfileBillingRoleAssignmentID

func NewBillingProfileBillingRoleAssignmentID(billingAccountName string, billingProfileName string, billingRoleAssignmentName string) BillingProfileBillingRoleAssignmentId

NewBillingProfileBillingRoleAssignmentID returns a new BillingProfileBillingRoleAssignmentId struct

func ParseBillingProfileBillingRoleAssignmentID

func ParseBillingProfileBillingRoleAssignmentID(input string) (*BillingProfileBillingRoleAssignmentId, error)

ParseBillingProfileBillingRoleAssignmentID parses 'input' into a BillingProfileBillingRoleAssignmentId

func ParseBillingProfileBillingRoleAssignmentIDInsensitively

func ParseBillingProfileBillingRoleAssignmentIDInsensitively(input string) (*BillingProfileBillingRoleAssignmentId, error)

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

func (*BillingProfileBillingRoleAssignmentId) FromParseResult

func (BillingProfileBillingRoleAssignmentId) ID

ID returns the formatted Billing Profile Billing Role Assignment ID

func (BillingProfileBillingRoleAssignmentId) Segments

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

func (BillingProfileBillingRoleAssignmentId) String

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

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

type BillingRoleAssignmentId

type BillingRoleAssignmentId struct {
	BillingAccountName        string
	BillingRoleAssignmentName string
}

BillingRoleAssignmentId is a struct representing the Resource ID for a Billing Role Assignment

func NewBillingRoleAssignmentID

func NewBillingRoleAssignmentID(billingAccountName string, billingRoleAssignmentName string) BillingRoleAssignmentId

NewBillingRoleAssignmentID returns a new BillingRoleAssignmentId struct

func ParseBillingRoleAssignmentID

func ParseBillingRoleAssignmentID(input string) (*BillingRoleAssignmentId, error)

ParseBillingRoleAssignmentID parses 'input' into a BillingRoleAssignmentId

func ParseBillingRoleAssignmentIDInsensitively

func ParseBillingRoleAssignmentIDInsensitively(input string) (*BillingRoleAssignmentId, error)

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

func (*BillingRoleAssignmentId) FromParseResult

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

func (BillingRoleAssignmentId) ID

ID returns the formatted Billing Role Assignment ID

func (BillingRoleAssignmentId) Segments

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

func (BillingRoleAssignmentId) String

func (id BillingRoleAssignmentId) String() string

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

type BillingRoleAssignmentOperationPredicate

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

func (BillingRoleAssignmentOperationPredicate) Matches

type BillingRoleAssignmentProperties

type BillingRoleAssignmentProperties struct {
	CreatedByPrincipalId       *string `json:"createdByPrincipalId,omitempty"`
	CreatedByPrincipalTenantId *string `json:"createdByPrincipalTenantId,omitempty"`
	CreatedByUserEmailAddress  *string `json:"createdByUserEmailAddress,omitempty"`
	CreatedOn                  *string `json:"createdOn,omitempty"`
	PrincipalId                *string `json:"principalId,omitempty"`
	PrincipalTenantId          *string `json:"principalTenantId,omitempty"`
	RoleDefinitionId           *string `json:"roleDefinitionId,omitempty"`
	Scope                      *string `json:"scope,omitempty"`
	UserAuthenticationType     *string `json:"userAuthenticationType,omitempty"`
	UserEmailAddress           *string `json:"userEmailAddress,omitempty"`
}

type BillingRoleAssignmentsClient

type BillingRoleAssignmentsClient struct {
	Client *resourcemanager.Client
}

func NewBillingRoleAssignmentsClientWithBaseURI

func NewBillingRoleAssignmentsClientWithBaseURI(sdkApi sdkEnv.Api) (*BillingRoleAssignmentsClient, error)

func (BillingRoleAssignmentsClient) DeleteByBillingAccount

DeleteByBillingAccount ...

func (BillingRoleAssignmentsClient) DeleteByBillingProfile

DeleteByBillingProfile ...

func (BillingRoleAssignmentsClient) DeleteByInvoiceSection

DeleteByInvoiceSection ...

func (BillingRoleAssignmentsClient) GetByBillingAccount

GetByBillingAccount ...

func (BillingRoleAssignmentsClient) GetByBillingProfile

GetByBillingProfile ...

func (BillingRoleAssignmentsClient) GetByInvoiceSection

GetByInvoiceSection ...

func (BillingRoleAssignmentsClient) ListByBillingAccount

ListByBillingAccount ...

func (BillingRoleAssignmentsClient) ListByBillingAccountComplete

ListByBillingAccountComplete retrieves all the results into a single object

func (BillingRoleAssignmentsClient) ListByBillingAccountCompleteMatchingPredicate

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

ListByBillingAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BillingRoleAssignmentsClient) ListByBillingProfile

ListByBillingProfile ...

func (BillingRoleAssignmentsClient) ListByBillingProfileComplete

ListByBillingProfileComplete retrieves all the results into a single object

func (BillingRoleAssignmentsClient) ListByBillingProfileCompleteMatchingPredicate

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

ListByBillingProfileCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (BillingRoleAssignmentsClient) ListByInvoiceSection

ListByInvoiceSection ...

func (BillingRoleAssignmentsClient) ListByInvoiceSectionComplete

ListByInvoiceSectionComplete retrieves all the results into a single object

func (BillingRoleAssignmentsClient) ListByInvoiceSectionCompleteMatchingPredicate

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

ListByInvoiceSectionCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DeleteByBillingAccountOperationResponse

type DeleteByBillingAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BillingRoleAssignment
}

type DeleteByBillingProfileOperationResponse

type DeleteByBillingProfileOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BillingRoleAssignment
}

type DeleteByInvoiceSectionOperationResponse

type DeleteByInvoiceSectionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BillingRoleAssignment
}

type GetByBillingAccountOperationResponse

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

type GetByBillingProfileOperationResponse

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

type GetByInvoiceSectionOperationResponse

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

type InvoiceSectionBillingRoleAssignmentId

type InvoiceSectionBillingRoleAssignmentId struct {
	BillingAccountName        string
	BillingProfileName        string
	InvoiceSectionName        string
	BillingRoleAssignmentName string
}

InvoiceSectionBillingRoleAssignmentId is a struct representing the Resource ID for a Invoice Section Billing Role Assignment

func NewInvoiceSectionBillingRoleAssignmentID

func NewInvoiceSectionBillingRoleAssignmentID(billingAccountName string, billingProfileName string, invoiceSectionName string, billingRoleAssignmentName string) InvoiceSectionBillingRoleAssignmentId

NewInvoiceSectionBillingRoleAssignmentID returns a new InvoiceSectionBillingRoleAssignmentId struct

func ParseInvoiceSectionBillingRoleAssignmentID

func ParseInvoiceSectionBillingRoleAssignmentID(input string) (*InvoiceSectionBillingRoleAssignmentId, error)

ParseInvoiceSectionBillingRoleAssignmentID parses 'input' into a InvoiceSectionBillingRoleAssignmentId

func ParseInvoiceSectionBillingRoleAssignmentIDInsensitively

func ParseInvoiceSectionBillingRoleAssignmentIDInsensitively(input string) (*InvoiceSectionBillingRoleAssignmentId, error)

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

func (*InvoiceSectionBillingRoleAssignmentId) FromParseResult

func (InvoiceSectionBillingRoleAssignmentId) ID

ID returns the formatted Invoice Section Billing Role Assignment ID

func (InvoiceSectionBillingRoleAssignmentId) Segments

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

func (InvoiceSectionBillingRoleAssignmentId) String

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

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        *[]BillingRoleAssignment
}

type ListByBillingProfileCompleteResult

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

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        *[]BillingRoleAssignment
}

type ListByInvoiceSectionCompleteResult

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

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        *[]BillingRoleAssignment
}

Jump to

Keyboard shortcuts

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