ascusages

README

github.com/hashicorp/go-azure-sdk/resource-manager/storagecache/2023-05-01/ascusages Documentation

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

Client Initialization

client := ascusages.NewAscUsagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AscUsagesClient.List

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

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(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 AscUsagesClient
  • func NewAscUsagesClientWithBaseURI(sdkApi sdkEnv.Api) (*AscUsagesClient, error)
  • func (c AscUsagesClient) List(ctx context.Context, id LocationId) (result ListOperationResponse, err error)
  • func (c AscUsagesClient) ListComplete(ctx context.Context, id LocationId) (ListCompleteResult, error)
  • func (c AscUsagesClient) ListCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate ResourceUsageOperationPredicate) (result ListCompleteResult, err error)
• type ListCompleteResult
• 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 ResourceUsage
• type ResourceUsageName
• type ResourceUsageOperationPredicate
  • func (p ResourceUsageOperationPredicate) Matches(input ResourceUsage) bool

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 AscUsagesClient

type AscUsagesClient struct {
	Client *resourcemanager.Client
}

func NewAscUsagesClientWithBaseURI

func NewAscUsagesClientWithBaseURI(sdkApi sdkEnv.Api) (*AscUsagesClient, error)

func (AscUsagesClient) List

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

List ...

func (AscUsagesClient) ListComplete

func (c AscUsagesClient) ListComplete(ctx context.Context, id LocationId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (AscUsagesClient) ListCompleteMatchingPredicate

func (c AscUsagesClient) ListCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate ResourceUsageOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListCompleteResult

type ListCompleteResult struct {
	Items []ResourceUsage
}

type ListOperationResponse

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

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 ResourceUsage

type ResourceUsage struct {
	CurrentValue *int64             `json:"currentValue,omitempty"`
	Limit        *int64             `json:"limit,omitempty"`
	Name         *ResourceUsageName `json:"name,omitempty"`
	Unit         *string            `json:"unit,omitempty"`
}

type ResourceUsageName

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

type ResourceUsageOperationPredicate

type ResourceUsageOperationPredicate struct {
	CurrentValue *int64
	Limit        *int64
	Unit         *string
}

func (ResourceUsageOperationPredicate) Matches

func (p ResourceUsageOperationPredicate) Matches(input ResourceUsage) bool