subscriptionusages

README

github.com/hashicorp/go-azure-sdk/resource-manager/devopsinfrastructure/2024-10-19/subscriptionusages Documentation

The subscriptionusages SDK allows for interaction with Azure Resource Manager devopsinfrastructure (API Version 2024-10-19).

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/devopsinfrastructure/2024-10-19/subscriptionusages"

Client Initialization

client := subscriptionusages.NewSubscriptionUsagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SubscriptionUsagesClient.Usages

ctx := context.TODO()
id := subscriptionusages.NewLocationID("12345678-1234-9876-4563-123456789012", "locationName")

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

Documentation

Index

• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type Quota
• type QuotaName
• type QuotaOperationPredicate
  • func (p QuotaOperationPredicate) Matches(input Quota) bool
• type SubscriptionUsagesClient
  • func NewSubscriptionUsagesClientWithBaseURI(sdkApi sdkEnv.Api) (*SubscriptionUsagesClient, error)
  • func (c SubscriptionUsagesClient) Usages(ctx context.Context, id LocationId) (result UsagesOperationResponse, err error)
  • func (c SubscriptionUsagesClient) UsagesComplete(ctx context.Context, id LocationId) (UsagesCompleteResult, error)
  • func (c SubscriptionUsagesClient) UsagesCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate QuotaOperationPredicate) (result UsagesCompleteResult, err error)
• type UsagesCompleteResult
• type UsagesCustomPager
  • func (p *UsagesCustomPager) NextPageLink() *odata.Link
• type UsagesOperationResponse

Functions

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

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

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type Quota

type Quota struct {
	CurrentValue int64      `json:"currentValue"`
	Id           string     `json:"id"`
	Limit        int64      `json:"limit"`
	Name         *QuotaName `json:"name,omitempty"`
	Unit         string     `json:"unit"`
}

type QuotaName

type QuotaName struct {
	LocalizedValue *string `json:"localizedValue,omitempty"`
	Value          *string `json:"value,omitempty"`
}

type QuotaOperationPredicate

type QuotaOperationPredicate struct {
	CurrentValue *int64
	Id           *string
	Limit        *int64
	Unit         *string
}

func (QuotaOperationPredicate) Matches

func (p QuotaOperationPredicate) Matches(input Quota) bool

type SubscriptionUsagesClient

type SubscriptionUsagesClient struct {
	Client *resourcemanager.Client
}

func NewSubscriptionUsagesClientWithBaseURI

func NewSubscriptionUsagesClientWithBaseURI(sdkApi sdkEnv.Api) (*SubscriptionUsagesClient, error)

func (SubscriptionUsagesClient) Usages

func (c SubscriptionUsagesClient) Usages(ctx context.Context, id LocationId) (result UsagesOperationResponse, err error)

Usages ...

func (SubscriptionUsagesClient) UsagesComplete

func (c SubscriptionUsagesClient) UsagesComplete(ctx context.Context, id LocationId) (UsagesCompleteResult, error)

UsagesComplete retrieves all the results into a single object

func (SubscriptionUsagesClient) UsagesCompleteMatchingPredicate

func (c SubscriptionUsagesClient) UsagesCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate QuotaOperationPredicate) (result UsagesCompleteResult, err error)

UsagesCompleteMatchingPredicate retrieves all the results and then applies the predicate

type UsagesCompleteResult

type UsagesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Quota
}

type UsagesCustomPager

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

func (*UsagesCustomPager) NextPageLink

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

type UsagesOperationResponse

type UsagesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Quota
}