locationbasedcapability

package
v0.20240826.1115152 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 26, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/mysql/2023-12-30/locationbasedcapability Documentation

The locationbasedcapability SDK allows for interaction with the Azure Resource Manager Service mysql (API Version 2023-12-30).

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/mysql/2023-12-30/locationbasedcapability"

Client Initialization

client := locationbasedcapability.NewLocationBasedCapabilityClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: LocationBasedCapabilityClient.SetGet

ctx := context.TODO()
id := locationbasedcapability.NewCapabilitySetID("12345678-1234-9876-4563-123456789012", "locationValue", "capabilitySetValue")

read, err := client.SetGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: LocationBasedCapabilityClient.SetList

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateCapabilitySetID

func ValidateCapabilitySetID(input interface{}, key string) (warnings []string, errors []error)

ValidateCapabilitySetID checks that 'input' can be parsed as a Capability Set ID

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 Capability

type Capability struct {
	Id         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *CapabilityPropertiesV2 `json:"properties,omitempty"`
	SystemData *systemdata.SystemData  `json:"systemData,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type CapabilityOperationPredicate

type CapabilityOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (CapabilityOperationPredicate) Matches

func (p CapabilityOperationPredicate) Matches(input Capability) bool

type CapabilityPropertiesV2

type CapabilityPropertiesV2 struct {
	SupportedFlexibleServerEditions *[]ServerEditionCapabilityV2 `json:"supportedFlexibleServerEditions,omitempty"`
	SupportedGeoBackupRegions       *[]string                    `json:"supportedGeoBackupRegions,omitempty"`
	SupportedServerVersions         *[]ServerVersionCapabilityV2 `json:"supportedServerVersions,omitempty"`
}

type CapabilitySetId

type CapabilitySetId struct {
	SubscriptionId    string
	LocationName      string
	CapabilitySetName string
}

CapabilitySetId is a struct representing the Resource ID for a Capability Set

func NewCapabilitySetID

func NewCapabilitySetID(subscriptionId string, locationName string, capabilitySetName string) CapabilitySetId

NewCapabilitySetID returns a new CapabilitySetId struct

func ParseCapabilitySetID

func ParseCapabilitySetID(input string) (*CapabilitySetId, error)

ParseCapabilitySetID parses 'input' into a CapabilitySetId

func ParseCapabilitySetIDInsensitively

func ParseCapabilitySetIDInsensitively(input string) (*CapabilitySetId, error)

ParseCapabilitySetIDInsensitively parses 'input' case-insensitively into a CapabilitySetId note: this method should only be used for API response data and not user input

func (*CapabilitySetId) FromParseResult

func (id *CapabilitySetId) FromParseResult(input resourceids.ParseResult) error

func (CapabilitySetId) ID

func (id CapabilitySetId) ID() string

ID returns the formatted Capability Set ID

func (CapabilitySetId) Segments

func (id CapabilitySetId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Capability Set ID

func (CapabilitySetId) String

func (id CapabilitySetId) String() string

String returns a human-readable description of this Capability Set ID

type LocationBasedCapabilityClient

type LocationBasedCapabilityClient struct {
	Client *resourcemanager.Client
}

func NewLocationBasedCapabilityClientWithBaseURI

func NewLocationBasedCapabilityClientWithBaseURI(sdkApi sdkEnv.Api) (*LocationBasedCapabilityClient, error)

func (LocationBasedCapabilityClient) SetGet

SetGet ...

func (LocationBasedCapabilityClient) SetList

SetList ...

func (LocationBasedCapabilityClient) SetListComplete

SetListComplete retrieves all the results into a single object

func (LocationBasedCapabilityClient) SetListCompleteMatchingPredicate

func (c LocationBasedCapabilityClient) SetListCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate CapabilityOperationPredicate) (result SetListCompleteResult, err error)

SetListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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

type ServerEditionCapabilityV2

type ServerEditionCapabilityV2 struct {
	DefaultSku               *string                     `json:"defaultSku,omitempty"`
	DefaultStorageSize       *int64                      `json:"defaultStorageSize,omitempty"`
	Name                     *string                     `json:"name,omitempty"`
	SupportedSkus            *[]SkuCapabilityV2          `json:"supportedSkus,omitempty"`
	SupportedStorageEditions *[]StorageEditionCapability `json:"supportedStorageEditions,omitempty"`
}

type ServerVersionCapabilityV2

type ServerVersionCapabilityV2 struct {
	Name *string `json:"name,omitempty"`
}

type SetGetOperationResponse

type SetGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Capability
}

type SetListCompleteResult

type SetListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Capability
}

type SetListCustomPager added in v0.20240628.1153531

type SetListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *SetListCustomPager) NextPageLink() *odata.Link

type SetListOperationResponse

type SetListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Capability
}

type SkuCapabilityV2

type SkuCapabilityV2 struct {
	Name                      *string   `json:"name,omitempty"`
	SupportedHAMode           *[]string `json:"supportedHAMode,omitempty"`
	SupportedIops             *int64    `json:"supportedIops,omitempty"`
	SupportedMemoryPerVCoreMB *int64    `json:"supportedMemoryPerVCoreMB,omitempty"`
	SupportedZones            *[]string `json:"supportedZones,omitempty"`
	VCores                    *int64    `json:"vCores,omitempty"`
}

type StorageEditionCapability

type StorageEditionCapability struct {
	MaxBackupIntervalHours *int64  `json:"maxBackupIntervalHours,omitempty"`
	MaxBackupRetentionDays *int64  `json:"maxBackupRetentionDays,omitempty"`
	MaxStorageSize         *int64  `json:"maxStorageSize,omitempty"`
	MinBackupIntervalHours *int64  `json:"minBackupIntervalHours,omitempty"`
	MinBackupRetentionDays *int64  `json:"minBackupRetentionDays,omitempty"`
	MinStorageSize         *int64  `json:"minStorageSize,omitempty"`
	Name                   *string `json:"name,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL