plan

README

github.com/hashicorp/go-azure-sdk/resource-manager/newrelic/2024-03-01/plan Documentation

The plan SDK allows for interaction with the Azure Resource Manager Service newrelic (API Version 2024-03-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/newrelic/2024-03-01/plan"

Client Initialization

client := plan.NewPlanClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PlanClient.List

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Documentation

Index

• func PossibleValuesForAccountCreationSource() []string
• func PossibleValuesForOrgCreationSource() []string
• func PossibleValuesForUsageType() []string
• type AccountCreationSource
  • func (s *AccountCreationSource) UnmarshalJSON(bytes []byte) error
• type ListCompleteResult
• type ListCustomPager
  • func (p *ListCustomPager) NextPageLink() *odata.Link
• type ListOperationOptions
  • func DefaultListOperationOptions() ListOperationOptions
  • func (o ListOperationOptions) ToHeaders() *client.Headers
  • func (o ListOperationOptions) ToOData() *odata.Query
  • func (o ListOperationOptions) ToQuery() *client.QueryParams
• type ListOperationResponse
• type OrgCreationSource
  • func (s *OrgCreationSource) UnmarshalJSON(bytes []byte) error
• type PlanClient
  • func NewPlanClientWithBaseURI(sdkApi sdkEnv.Api) (*PlanClient, error)
  • func (c PlanClient) List(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (result ListOperationResponse, err error)
  • func (c PlanClient) ListComplete(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (ListCompleteResult, error)
  • func (c PlanClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, ...) (result ListCompleteResult, err error)
• type PlanData
  • func (o *PlanData) GetEffectiveDateAsTime() (*time.Time, error)
  • func (o *PlanData) SetEffectiveDateAsTime(input time.Time)
• type PlanDataProperties
• type PlanDataResource
• type PlanDataResourceOperationPredicate
  • func (p PlanDataResourceOperationPredicate) Matches(input PlanDataResource) bool
• type UsageType
  • func (s *UsageType) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForAccountCreationSource

func PossibleValuesForAccountCreationSource() []string

func PossibleValuesForOrgCreationSource

func PossibleValuesForOrgCreationSource() []string

func PossibleValuesForUsageType

func PossibleValuesForUsageType() []string

Types

type AccountCreationSource

type AccountCreationSource string

const (
	AccountCreationSourceLIFTR    AccountCreationSource = "LIFTR"
	AccountCreationSourceNEWRELIC AccountCreationSource = "NEWRELIC"
)

func (*AccountCreationSource) UnmarshalJSON

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

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PlanDataResource
}

type ListCustomPager

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListCustomPager) NextPageLink

func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationOptions

type ListOperationOptions struct {
	AccountId      *string
	OrganizationId *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

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

func (ListOperationOptions) ToOData

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

func (ListOperationOptions) ToQuery

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

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PlanDataResource
}

type OrgCreationSource

type OrgCreationSource string

const (
	OrgCreationSourceLIFTR    OrgCreationSource = "LIFTR"
	OrgCreationSourceNEWRELIC OrgCreationSource = "NEWRELIC"
)

func (*OrgCreationSource) UnmarshalJSON

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

type PlanClient

type PlanClient struct {
	Client *resourcemanager.Client
}

func NewPlanClientWithBaseURI

func NewPlanClientWithBaseURI(sdkApi sdkEnv.Api) (*PlanClient, error)

func (PlanClient) List

func (c PlanClient) List(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (PlanClient) ListComplete

func (c PlanClient) ListComplete(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PlanClient) ListCompleteMatchingPredicate

func (c PlanClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, predicate PlanDataResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PlanData

type PlanData struct {
	BillingCycle  *string    `json:"billingCycle,omitempty"`
	EffectiveDate *string    `json:"effectiveDate,omitempty"`
	PlanDetails   *string    `json:"planDetails,omitempty"`
	UsageType     *UsageType `json:"usageType,omitempty"`
}

func (*PlanData) GetEffectiveDateAsTime

func (o *PlanData) GetEffectiveDateAsTime() (*time.Time, error)

func (*PlanData) SetEffectiveDateAsTime

func (o *PlanData) SetEffectiveDateAsTime(input time.Time)

type PlanDataProperties

type PlanDataProperties struct {
	AccountCreationSource *AccountCreationSource `json:"accountCreationSource,omitempty"`
	OrgCreationSource     *OrgCreationSource     `json:"orgCreationSource,omitempty"`
	PlanData              *PlanData              `json:"planData,omitempty"`
}

type PlanDataResource

type PlanDataResource struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *PlanDataProperties    `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type PlanDataResourceOperationPredicate

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

func (PlanDataResourceOperationPredicate) Matches

func (p PlanDataResourceOperationPredicate) Matches(input PlanDataResource) bool

type UsageType

type UsageType string

const (
	UsageTypeCOMMITTED UsageType = "COMMITTED"
	UsageTypePAYG      UsageType = "PAYG"
)

func (*UsageType) UnmarshalJSON

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