enrollmentaccount

package
v0.20241009.1142232 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/billing/2024-04-01/enrollmentaccount Documentation

The enrollmentaccount SDK allows for interaction with Azure Resource Manager billing (API Version 2024-04-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/2024-04-01/enrollmentaccount"

Client Initialization

client := enrollmentaccount.NewEnrollmentAccountClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EnrollmentAccountClient.Get

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

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: EnrollmentAccountClient.GetByDepartment

ctx := context.TODO()
id := enrollmentaccount.NewDepartmentEnrollmentAccountID("billingAccountName", "departmentName", "enrollmentAccountName")

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

Example Usage: EnrollmentAccountClient.ListByBillingAccount

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

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

Example Usage: EnrollmentAccountClient.ListByDepartment

ctx := context.TODO()
id := enrollmentaccount.NewDepartmentID("billingAccountName", "departmentName")

// alternatively `client.ListByDepartment(ctx, id, enrollmentaccount.DefaultListByDepartmentOperationOptions())` can be used to do batched pagination
items, err := client.ListByDepartmentComplete(ctx, id, enrollmentaccount.DefaultListByDepartmentOperationOptions())
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 ValidateDepartmentEnrollmentAccountID 

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

ValidateDepartmentEnrollmentAccountID checks that 'input' can be parsed as a Department Enrollment Account ID

func ValidateDepartmentID 

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

ValidateDepartmentID checks that 'input' can be parsed as a Department 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 DepartmentEnrollmentAccountId 

type DepartmentEnrollmentAccountId struct {
	BillingAccountName    string
	DepartmentName        string
	EnrollmentAccountName string
}

DepartmentEnrollmentAccountId is a struct representing the Resource ID for a Department Enrollment Account

func NewDepartmentEnrollmentAccountID 

func NewDepartmentEnrollmentAccountID(billingAccountName string, departmentName string, enrollmentAccountName string) DepartmentEnrollmentAccountId

NewDepartmentEnrollmentAccountID returns a new DepartmentEnrollmentAccountId struct

func ParseDepartmentEnrollmentAccountID 

func ParseDepartmentEnrollmentAccountID(input string) (*DepartmentEnrollmentAccountId, error)

ParseDepartmentEnrollmentAccountID parses 'input' into a DepartmentEnrollmentAccountId

func ParseDepartmentEnrollmentAccountIDInsensitively 

func ParseDepartmentEnrollmentAccountIDInsensitively(input string) (*DepartmentEnrollmentAccountId, error)

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

func (*DepartmentEnrollmentAccountId) FromParseResult 

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

func (DepartmentEnrollmentAccountId) ID 

func (id DepartmentEnrollmentAccountId) ID() string

ID returns the formatted Department Enrollment Account ID

func (DepartmentEnrollmentAccountId) Segments 

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

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

func (DepartmentEnrollmentAccountId) String 

func (id DepartmentEnrollmentAccountId) String() string

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

type DepartmentId 

type DepartmentId struct {
	BillingAccountName string
	DepartmentName     string
}

DepartmentId is a struct representing the Resource ID for a Department

func NewDepartmentID 

func NewDepartmentID(billingAccountName string, departmentName string) DepartmentId

NewDepartmentID returns a new DepartmentId struct

func ParseDepartmentID 

func ParseDepartmentID(input string) (*DepartmentId, error)

ParseDepartmentID parses 'input' into a DepartmentId

func ParseDepartmentIDInsensitively 

func ParseDepartmentIDInsensitively(input string) (*DepartmentId, error)

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

func (*DepartmentId) FromParseResult 

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

func (DepartmentId) ID 

func (id DepartmentId) ID() string

ID returns the formatted Department ID

func (DepartmentId) Segments 

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

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

func (DepartmentId) String 

func (id DepartmentId) String() string

String returns a human-readable description of this Department ID

type EnrollmentAccount 

type EnrollmentAccount struct {
	Id         *string                      `json:"id,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties *EnrollmentAccountProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData       `json:"systemData,omitempty"`
	Tags       *map[string]string           `json:"tags,omitempty"`
	Type       *string                      `json:"type,omitempty"`
}

type EnrollmentAccountClient 

type EnrollmentAccountClient struct {
	Client *resourcemanager.Client
}

func NewEnrollmentAccountClientWithBaseURI 

func NewEnrollmentAccountClientWithBaseURI(sdkApi sdkEnv.Api) (*EnrollmentAccountClient, error)

func (EnrollmentAccountClient) Get 

func (c EnrollmentAccountClient) Get(ctx context.Context, id EnrollmentAccountId) (result GetOperationResponse, err error)

Get ...

func (EnrollmentAccountClient) GetByDepartment 

func (c EnrollmentAccountClient) GetByDepartment(ctx context.Context, id DepartmentEnrollmentAccountId) (result GetByDepartmentOperationResponse, err error)

GetByDepartment ...

func (EnrollmentAccountClient) ListByBillingAccount 

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

ListByBillingAccount ...

func (EnrollmentAccountClient) ListByBillingAccountComplete 

func (c EnrollmentAccountClient) ListByBillingAccountComplete(ctx context.Context, id BillingAccountId, options ListByBillingAccountOperationOptions) (ListByBillingAccountCompleteResult, error)

ListByBillingAccountComplete retrieves all the results into a single object

func (EnrollmentAccountClient) ListByBillingAccountCompleteMatchingPredicate 

func (c EnrollmentAccountClient) ListByBillingAccountCompleteMatchingPredicate(ctx context.Context, id BillingAccountId, options ListByBillingAccountOperationOptions, predicate EnrollmentAccountOperationPredicate) (result ListByBillingAccountCompleteResult, err error)

ListByBillingAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EnrollmentAccountClient) ListByDepartment 

func (c EnrollmentAccountClient) ListByDepartment(ctx context.Context, id DepartmentId, options ListByDepartmentOperationOptions) (result ListByDepartmentOperationResponse, err error)

ListByDepartment ...

func (EnrollmentAccountClient) ListByDepartmentComplete 

func (c EnrollmentAccountClient) ListByDepartmentComplete(ctx context.Context, id DepartmentId, options ListByDepartmentOperationOptions) (ListByDepartmentCompleteResult, error)

ListByDepartmentComplete retrieves all the results into a single object

func (EnrollmentAccountClient) ListByDepartmentCompleteMatchingPredicate 

func (c EnrollmentAccountClient) ListByDepartmentCompleteMatchingPredicate(ctx context.Context, id DepartmentId, options ListByDepartmentOperationOptions, predicate EnrollmentAccountOperationPredicate) (result ListByDepartmentCompleteResult, err error)

ListByDepartmentCompleteMatchingPredicate retrieves all the results and then applies the predicate

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 {
	AccountOwner          *string `json:"accountOwner,omitempty"`
	AuthType              *string `json:"authType,omitempty"`
	CostCenter            *string `json:"costCenter,omitempty"`
	DepartmentDisplayName *string `json:"departmentDisplayName,omitempty"`
	DepartmentId          *string `json:"departmentId,omitempty"`
	DisplayName           *string `json:"displayName,omitempty"`
	EndDate               *string `json:"endDate,omitempty"`
	IsDevTestEnabled      *bool   `json:"isDevTestEnabled,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 GetByDepartmentOperationResponse 

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

type GetOperationResponse 

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

type ListByBillingAccountCompleteResult 

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

type ListByBillingAccountCustomPager added in v0.20240628.1153531 

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

type ListByBillingAccountOperationOptions 

type ListByBillingAccountOperationOptions struct {
	Count   *bool
	Filter  *string
	OrderBy *string
	Search  *string
	Skip    *int64
	Top     *int64
}

func DefaultListByBillingAccountOperationOptions 

func DefaultListByBillingAccountOperationOptions() ListByBillingAccountOperationOptions

func (ListByBillingAccountOperationOptions) ToHeaders 

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

func (ListByBillingAccountOperationOptions) ToOData 

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

func (ListByBillingAccountOperationOptions) ToQuery 

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

type ListByBillingAccountOperationResponse 

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

type ListByDepartmentCompleteResult 

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

type ListByDepartmentCustomPager added in v0.20240628.1153531 

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

type ListByDepartmentOperationOptions 

type ListByDepartmentOperationOptions struct {
	Count   *bool
	Filter  *string
	OrderBy *string
	Search  *string
	Skip    *int64
	Top     *int64
}

func DefaultListByDepartmentOperationOptions 

func DefaultListByDepartmentOperationOptions() ListByDepartmentOperationOptions

func (ListByDepartmentOperationOptions) ToHeaders 

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

func (ListByDepartmentOperationOptions) ToOData 

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

func (ListByDepartmentOperationOptions) ToQuery 

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

type ListByDepartmentOperationResponse 

type ListByDepartmentOperationResponse 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.