availableworkloadprofiles

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerapps/2024-03-01/availableworkloadprofiles Documentation

The availableworkloadprofiles SDK allows for interaction with the Azure Resource Manager Service containerapps (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-sdk/resource-manager/containerapps/2024-03-01/availableworkloadprofiles"

Client Initialization

client := availableworkloadprofiles.NewAvailableWorkloadProfilesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AvailableWorkloadProfilesClient.Get

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

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

Documentation

Index

• func PossibleValuesForApplicability() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type Applicability
  • func (s *Applicability) UnmarshalJSON(bytes []byte) error
• type AvailableWorkloadProfile
• type AvailableWorkloadProfileOperationPredicate
  • func (p AvailableWorkloadProfileOperationPredicate) Matches(input AvailableWorkloadProfile) bool
• type AvailableWorkloadProfileProperties
• type AvailableWorkloadProfilesClient
  • func NewAvailableWorkloadProfilesClientWithBaseURI(sdkApi sdkEnv.Api) (*AvailableWorkloadProfilesClient, error)
  • func (c AvailableWorkloadProfilesClient) Get(ctx context.Context, id LocationId) (result GetOperationResponse, err error)
  • func (c AvailableWorkloadProfilesClient) GetComplete(ctx context.Context, id LocationId) (GetCompleteResult, error)
  • func (c AvailableWorkloadProfilesClient) GetCompleteMatchingPredicate(ctx context.Context, id LocationId, ...) (result GetCompleteResult, err error)
• type GetCompleteResult
• type GetOperationResponse
• 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

Functions

func PossibleValuesForApplicability

func PossibleValuesForApplicability() []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 Applicability

type Applicability string

const (
	ApplicabilityCustom          Applicability = "Custom"
	ApplicabilityLocationDefault Applicability = "LocationDefault"
)

func (*Applicability) UnmarshalJSON

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

type AvailableWorkloadProfile

type AvailableWorkloadProfile struct {
	Id         *string                             `json:"id,omitempty"`
	Location   *string                             `json:"location,omitempty"`
	Name       *string                             `json:"name,omitempty"`
	Properties *AvailableWorkloadProfileProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData              `json:"systemData,omitempty"`
	Type       *string                             `json:"type,omitempty"`
}

type AvailableWorkloadProfileOperationPredicate

type AvailableWorkloadProfileOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (AvailableWorkloadProfileOperationPredicate) Matches

func (p AvailableWorkloadProfileOperationPredicate) Matches(input AvailableWorkloadProfile) bool

type AvailableWorkloadProfileProperties

type AvailableWorkloadProfileProperties struct {
	Applicability *Applicability `json:"applicability,omitempty"`
	Category      *string        `json:"category,omitempty"`
	Cores         *int64         `json:"cores,omitempty"`
	DisplayName   *string        `json:"displayName,omitempty"`
	Gpus          *int64         `json:"gpus,omitempty"`
	MemoryGiB     *int64         `json:"memoryGiB,omitempty"`
}

type AvailableWorkloadProfilesClient

type AvailableWorkloadProfilesClient struct {
	Client *resourcemanager.Client
}

func NewAvailableWorkloadProfilesClientWithBaseURI

func NewAvailableWorkloadProfilesClientWithBaseURI(sdkApi sdkEnv.Api) (*AvailableWorkloadProfilesClient, error)

func (AvailableWorkloadProfilesClient) Get

func (c AvailableWorkloadProfilesClient) Get(ctx context.Context, id LocationId) (result GetOperationResponse, err error)

Get ...

func (AvailableWorkloadProfilesClient) GetComplete

func (c AvailableWorkloadProfilesClient) GetComplete(ctx context.Context, id LocationId) (GetCompleteResult, error)

GetComplete retrieves all the results into a single object

func (AvailableWorkloadProfilesClient) GetCompleteMatchingPredicate

func (c AvailableWorkloadProfilesClient) GetCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate AvailableWorkloadProfileOperationPredicate) (result GetCompleteResult, err error)

GetCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetCompleteResult

type GetCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AvailableWorkloadProfile
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AvailableWorkloadProfile
}

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