usages

README

github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/usages Documentation

The usages SDK allows for interaction with the Azure Resource Manager Service cognitive (API Version 2023-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/cognitive/2023-05-01/usages"

Client Initialization

client := usages.NewUsagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: UsagesClient.List

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

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

Documentation

Index

• func PossibleValuesForQuotaUsageStatus() []string
• func PossibleValuesForUnitType() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type ListCompleteResult
• 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 LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type MetricName
• type QuotaUsageStatus
  • func (s *QuotaUsageStatus) UnmarshalJSON(bytes []byte) error
• type UnitType
  • func (s *UnitType) UnmarshalJSON(bytes []byte) error
• type Usage
• type UsageOperationPredicate
  • func (p UsageOperationPredicate) Matches(input Usage) bool
• type UsagesClient
  • func NewUsagesClientWithBaseURI(api environments.Api) (*UsagesClient, error)
  • func (c UsagesClient) List(ctx context.Context, id LocationId, options ListOperationOptions) (result ListOperationResponse, err error)
  • func (c UsagesClient) ListComplete(ctx context.Context, id LocationId, options ListOperationOptions) (ListCompleteResult, error)
  • func (c UsagesClient) ListCompleteMatchingPredicate(ctx context.Context, id LocationId, options ListOperationOptions, ...) (result ListCompleteResult, err error)

Functions

func PossibleValuesForQuotaUsageStatus

func PossibleValuesForQuotaUsageStatus() []string

func PossibleValuesForUnitType

func PossibleValuesForUnitType() []string

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 ListCompleteResult

type ListCompleteResult struct {
	Items []Usage
}

type ListOperationOptions

type ListOperationOptions struct {
	Filter *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        *[]Usage
}

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) 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 MetricName

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

type QuotaUsageStatus

type QuotaUsageStatus string

const (
	QuotaUsageStatusBlocked   QuotaUsageStatus = "Blocked"
	QuotaUsageStatusInOverage QuotaUsageStatus = "InOverage"
	QuotaUsageStatusIncluded  QuotaUsageStatus = "Included"
	QuotaUsageStatusUnknown   QuotaUsageStatus = "Unknown"
)

func (*QuotaUsageStatus) UnmarshalJSON

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

type UnitType

type UnitType string

const (
	UnitTypeBytes          UnitType = "Bytes"
	UnitTypeBytesPerSecond UnitType = "BytesPerSecond"
	UnitTypeCount          UnitType = "Count"
	UnitTypeCountPerSecond UnitType = "CountPerSecond"
	UnitTypeMilliseconds   UnitType = "Milliseconds"
	UnitTypePercent        UnitType = "Percent"
	UnitTypeSeconds        UnitType = "Seconds"
)

func (*UnitType) UnmarshalJSON

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

type Usage

type Usage struct {
	CurrentValue  *float64          `json:"currentValue,omitempty"`
	Limit         *float64          `json:"limit,omitempty"`
	Name          *MetricName       `json:"name,omitempty"`
	NextResetTime *string           `json:"nextResetTime,omitempty"`
	QuotaPeriod   *string           `json:"quotaPeriod,omitempty"`
	Status        *QuotaUsageStatus `json:"status,omitempty"`
	Unit          *UnitType         `json:"unit,omitempty"`
}

type UsageOperationPredicate

type UsageOperationPredicate struct {
	CurrentValue  *float64
	Limit         *float64
	NextResetTime *string
	QuotaPeriod   *string
}

func (UsageOperationPredicate) Matches

func (p UsageOperationPredicate) Matches(input Usage) bool

type UsagesClient

type UsagesClient struct {
	Client *resourcemanager.Client
}

func NewUsagesClientWithBaseURI

func NewUsagesClientWithBaseURI(api environments.Api) (*UsagesClient, error)

func (UsagesClient) List

func (c UsagesClient) List(ctx context.Context, id LocationId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (UsagesClient) ListComplete

func (c UsagesClient) ListComplete(ctx context.Context, id LocationId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (UsagesClient) ListCompleteMatchingPredicate

func (c UsagesClient) ListCompleteMatchingPredicate(ctx context.Context, id LocationId, options ListOperationOptions, predicate UsageOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate