enrollmentaccounts

package
v0.20241126.2320 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

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

Client Initialization

client := enrollmentaccounts.NewEnrollmentAccountsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EnrollmentAccountsClient.GetByEnrollmentAccountId

ctx := context.TODO()
id := enrollmentaccounts.NewEnrollmentAccountID("billingAccountName", "enrollmentAccountName")

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

Example Usage: EnrollmentAccountsClient.ListByBillingAccountName

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

// alternatively `client.ListByBillingAccountName(ctx, id, enrollmentaccounts.DefaultListByBillingAccountNameOperationOptions())` can be used to do batched pagination
items, err := client.ListByBillingAccountNameComplete(ctx, id, enrollmentaccounts.DefaultListByBillingAccountNameOperationOptions())
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 ValidateEnrollmentAccountID 

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

ValidateEnrollmentAccountID checks that 'input' can be parsed as a Enrollment Account 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 Department 

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

type DepartmentProperties 

type DepartmentProperties struct {
	CostCenter         *string              `json:"costCenter,omitempty"`
	DepartmentName     *string              `json:"departmentName,omitempty"`
	EnrollmentAccounts *[]EnrollmentAccount `json:"enrollmentAccounts,omitempty"`
	Status             *string              `json:"status,omitempty"`
}

type EnrollmentAccount 

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

type EnrollmentAccountId 

type EnrollmentAccountId struct {
	BillingAccountName    string
	EnrollmentAccountName string
}

EnrollmentAccountId is a struct representing the Resource ID for a Enrollment Account

func NewEnrollmentAccountID 

func NewEnrollmentAccountID(billingAccountName string, enrollmentAccountName string) EnrollmentAccountId

NewEnrollmentAccountID returns a new EnrollmentAccountId struct

func ParseEnrollmentAccountID 

func ParseEnrollmentAccountID(input string) (*EnrollmentAccountId, error)

ParseEnrollmentAccountID parses 'input' into a EnrollmentAccountId

func ParseEnrollmentAccountIDInsensitively 

func ParseEnrollmentAccountIDInsensitively(input string) (*EnrollmentAccountId, error)

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

func (*EnrollmentAccountId) FromParseResult 

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

func (EnrollmentAccountId) ID 

func (id EnrollmentAccountId) ID() string

ID returns the formatted Enrollment Account ID

func (EnrollmentAccountId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Enrollment Account ID

func (EnrollmentAccountId) String 

func (id EnrollmentAccountId) String() string

String returns a human-readable description of this Enrollment Account ID

type EnrollmentAccountOperationPredicate 

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

func (EnrollmentAccountOperationPredicate) Matches 

func (p EnrollmentAccountOperationPredicate) Matches(input EnrollmentAccount) bool

type EnrollmentAccountProperties 

type EnrollmentAccountProperties struct {
	AccountName  *string     `json:"accountName,omitempty"`
	AccountOwner *string     `json:"accountOwner,omitempty"`
	CostCenter   *string     `json:"costCenter,omitempty"`
	Department   *Department `json:"department,omitempty"`
	EndDate      *string     `json:"endDate,omitempty"`
	StartDate    *string     `json:"startDate,omitempty"`
	Status       *string     `json:"status,omitempty"`
}

func (*EnrollmentAccountProperties) GetEndDateAsTime 

func (o *EnrollmentAccountProperties) GetEndDateAsTime() (*time.Time, error)

func (*EnrollmentAccountProperties) GetStartDateAsTime 

func (o *EnrollmentAccountProperties) GetStartDateAsTime() (*time.Time, error)

func (*EnrollmentAccountProperties) SetEndDateAsTime 

func (o *EnrollmentAccountProperties) SetEndDateAsTime(input time.Time)

func (*EnrollmentAccountProperties) SetStartDateAsTime 

func (o *EnrollmentAccountProperties) SetStartDateAsTime(input time.Time)

type EnrollmentAccountsClient 

type EnrollmentAccountsClient struct {
	Client *resourcemanager.Client
}

func NewEnrollmentAccountsClientWithBaseURI 

func NewEnrollmentAccountsClientWithBaseURI(sdkApi sdkEnv.Api) (*EnrollmentAccountsClient, error)

func (EnrollmentAccountsClient) GetByEnrollmentAccountId 

func (c EnrollmentAccountsClient) GetByEnrollmentAccountId(ctx context.Context, id EnrollmentAccountId, options GetByEnrollmentAccountIdOperationOptions) (result GetByEnrollmentAccountIdOperationResponse, err error)

GetByEnrollmentAccountId ...

func (EnrollmentAccountsClient) ListByBillingAccountName 

func (c EnrollmentAccountsClient) ListByBillingAccountName(ctx context.Context, id BillingAccountId, options ListByBillingAccountNameOperationOptions) (result ListByBillingAccountNameOperationResponse, err error)

ListByBillingAccountName ...

func (EnrollmentAccountsClient) ListByBillingAccountNameComplete 

func (c EnrollmentAccountsClient) ListByBillingAccountNameComplete(ctx context.Context, id BillingAccountId, options ListByBillingAccountNameOperationOptions) (ListByBillingAccountNameCompleteResult, error)

ListByBillingAccountNameComplete retrieves all the results into a single object

func (EnrollmentAccountsClient) ListByBillingAccountNameCompleteMatchingPredicate 

func (c EnrollmentAccountsClient) ListByBillingAccountNameCompleteMatchingPredicate(ctx context.Context, id BillingAccountId, options ListByBillingAccountNameOperationOptions, predicate EnrollmentAccountOperationPredicate) (result ListByBillingAccountNameCompleteResult, err error)

ListByBillingAccountNameCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetByEnrollmentAccountIdOperationOptions 

type GetByEnrollmentAccountIdOperationOptions struct {
	Expand *string
	Filter *string
}

func DefaultGetByEnrollmentAccountIdOperationOptions 

func DefaultGetByEnrollmentAccountIdOperationOptions() GetByEnrollmentAccountIdOperationOptions

func (GetByEnrollmentAccountIdOperationOptions) ToHeaders 

func (o GetByEnrollmentAccountIdOperationOptions) ToHeaders() *client.Headers

func (GetByEnrollmentAccountIdOperationOptions) ToOData 

func (o GetByEnrollmentAccountIdOperationOptions) ToOData() *odata.Query

func (GetByEnrollmentAccountIdOperationOptions) ToQuery 

func (o GetByEnrollmentAccountIdOperationOptions) ToQuery() *client.QueryParams

type GetByEnrollmentAccountIdOperationResponse 

type GetByEnrollmentAccountIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EnrollmentAccount
}

type ListByBillingAccountNameCompleteResult 

type ListByBillingAccountNameCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []EnrollmentAccount
}

type ListByBillingAccountNameCustomPager 

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

type ListByBillingAccountNameOperationOptions 

type ListByBillingAccountNameOperationOptions struct {
	Expand *string
	Filter *string
}

func DefaultListByBillingAccountNameOperationOptions 

func DefaultListByBillingAccountNameOperationOptions() ListByBillingAccountNameOperationOptions

func (ListByBillingAccountNameOperationOptions) ToHeaders 

func (o ListByBillingAccountNameOperationOptions) ToHeaders() *client.Headers

func (ListByBillingAccountNameOperationOptions) ToOData 

func (o ListByBillingAccountNameOperationOptions) ToOData() *odata.Query

func (ListByBillingAccountNameOperationOptions) ToQuery 

func (o ListByBillingAccountNameOperationOptions) ToQuery() *client.QueryParams

type ListByBillingAccountNameOperationResponse 

type ListByBillingAccountNameOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]EnrollmentAccount
}

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.