commitmenttiers

README

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

The commitmenttiers 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/commitmenttiers"

Client Initialization

client := commitmenttiers.NewCommitmentTiersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CommitmentTiersClient.List

ctx := context.TODO()
id := commitmenttiers.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 PossibleValuesForHostingModel() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type CommitmentCost
• type CommitmentQuota
• type CommitmentTier
• type CommitmentTierOperationPredicate
  • func (p CommitmentTierOperationPredicate) Matches(input CommitmentTier) bool
• type CommitmentTiersClient
  • func NewCommitmentTiersClientWithBaseURI(api environments.Api) (*CommitmentTiersClient, error)
  • func (c CommitmentTiersClient) List(ctx context.Context, id LocationId) (result ListOperationResponse, err error)
  • func (c CommitmentTiersClient) ListComplete(ctx context.Context, id LocationId) (ListCompleteResult, error)
  • func (c CommitmentTiersClient) ListCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate CommitmentTierOperationPredicate) (result ListCompleteResult, err error)
• type HostingModel
  • func (s *HostingModel) UnmarshalJSON(bytes []byte) 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

Functions

func PossibleValuesForHostingModel

func PossibleValuesForHostingModel() []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 CommitmentCost

type CommitmentCost struct {
	CommitmentMeterId *string `json:"commitmentMeterId,omitempty"`
	OverageMeterId    *string `json:"overageMeterId,omitempty"`
}

type CommitmentQuota

type CommitmentQuota struct {
	Quantity *int64  `json:"quantity,omitempty"`
	Unit     *string `json:"unit,omitempty"`
}

type CommitmentTier

type CommitmentTier struct {
	Cost         *CommitmentCost  `json:"cost,omitempty"`
	HostingModel *HostingModel    `json:"hostingModel,omitempty"`
	Kind         *string          `json:"kind,omitempty"`
	MaxCount     *int64           `json:"maxCount,omitempty"`
	PlanType     *string          `json:"planType,omitempty"`
	Quota        *CommitmentQuota `json:"quota,omitempty"`
	SkuName      *string          `json:"skuName,omitempty"`
	Tier         *string          `json:"tier,omitempty"`
}

type CommitmentTierOperationPredicate

type CommitmentTierOperationPredicate struct {
	Kind     *string
	MaxCount *int64
	PlanType *string
	SkuName  *string
	Tier     *string
}

func (CommitmentTierOperationPredicate) Matches

func (p CommitmentTierOperationPredicate) Matches(input CommitmentTier) bool

type CommitmentTiersClient

type CommitmentTiersClient struct {
	Client *resourcemanager.Client
}

func NewCommitmentTiersClientWithBaseURI

func NewCommitmentTiersClientWithBaseURI(api environments.Api) (*CommitmentTiersClient, error)

func (CommitmentTiersClient) List

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

List ...

func (CommitmentTiersClient) ListComplete

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

ListComplete retrieves all the results into a single object

func (CommitmentTiersClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type HostingModel

type HostingModel string

const (
	HostingModelConnectedContainer    HostingModel = "ConnectedContainer"
	HostingModelDisconnectedContainer HostingModel = "DisconnectedContainer"
	HostingModelProvisionedWeb        HostingModel = "ProvisionedWeb"
	HostingModelWeb                   HostingModel = "Web"
)

func (*HostingModel) UnmarshalJSON

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []CommitmentTier
}

type ListOperationResponse

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

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