usagemodels

README

github.com/hashicorp/go-azure-sdk/resource-manager/storagecache/2024-03-01/usagemodels Documentation

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

Client Initialization

client := usagemodels.NewUsageModelsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: UsageModelsClient.List

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

// 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

• type ListCompleteResult
• type ListOperationResponse
• type UsageModel
• type UsageModelDisplay
• type UsageModelOperationPredicate
  • func (p UsageModelOperationPredicate) Matches(input UsageModel) bool
• type UsageModelsClient
  • func NewUsageModelsClientWithBaseURI(sdkApi sdkEnv.Api) (*UsageModelsClient, error)
  • func (c UsageModelsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c UsageModelsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
  • func (c UsageModelsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)

Types

type ListCompleteResult

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

type ListOperationResponse

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

type UsageModel

type UsageModel struct {
	Display    *UsageModelDisplay `json:"display,omitempty"`
	ModelName  *string            `json:"modelName,omitempty"`
	TargetType *string            `json:"targetType,omitempty"`
}

type UsageModelDisplay

type UsageModelDisplay struct {
	Description *string `json:"description,omitempty"`
}

type UsageModelOperationPredicate

type UsageModelOperationPredicate struct {
	ModelName  *string
	TargetType *string
}

func (UsageModelOperationPredicate) Matches

func (p UsageModelOperationPredicate) Matches(input UsageModel) bool

type UsageModelsClient

type UsageModelsClient struct {
	Client *resourcemanager.Client
}

func NewUsageModelsClientWithBaseURI

func NewUsageModelsClientWithBaseURI(sdkApi sdkEnv.Api) (*UsageModelsClient, error)

func (UsageModelsClient) List

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

List ...

func (UsageModelsClient) ListComplete

func (c UsageModelsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (UsageModelsClient) ListCompleteMatchingPredicate

func (c UsageModelsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate UsageModelOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate