locationbasedcapabilities

README

github.com/hashicorp/go-azure-sdk/resource-manager/postgresql/2021-06-01/locationbasedcapabilities Documentation

The locationbasedcapabilities SDK allows for interaction with the Azure Resource Manager Service postgresql (API Version 2021-06-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/postgresql/2021-06-01/locationbasedcapabilities"

Client Initialization

client := locationbasedcapabilities.NewLocationBasedCapabilitiesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: LocationBasedCapabilitiesClient.Execute

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

// alternatively `client.Execute(ctx, id)` can be used to do batched pagination
items, err := client.ExecuteComplete(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 CapabilityProperties
• type CapabilityPropertiesOperationPredicate
  • func (p CapabilityPropertiesOperationPredicate) Matches(input CapabilityProperties) bool
• type ExecuteCompleteResult
• type ExecuteOperationResponse
• type FlexibleServerEditionCapability
• type HyperscaleNodeEditionCapability
• type LocationBasedCapabilitiesClient
  • func NewLocationBasedCapabilitiesClientWithBaseURI(sdkApi sdkEnv.Api) (*LocationBasedCapabilitiesClient, error)
  • func (c LocationBasedCapabilitiesClient) Execute(ctx context.Context, id LocationId) (result ExecuteOperationResponse, err error)
  • func (c LocationBasedCapabilitiesClient) ExecuteComplete(ctx context.Context, id LocationId) (ExecuteCompleteResult, error)
  • func (c LocationBasedCapabilitiesClient) ExecuteCompleteMatchingPredicate(ctx context.Context, id LocationId, ...) (result ExecuteCompleteResult, err error)
• 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
• type NodeTypeCapability
• type ServerVersionCapability
• type StorageEditionCapability
• type StorageMBCapability
• type VcoreCapability

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 CapabilityProperties

type CapabilityProperties struct {
	GeoBackupSupported                   *bool                              `json:"geoBackupSupported,omitempty"`
	Status                               *string                            `json:"status,omitempty"`
	SupportedFlexibleServerEditions      *[]FlexibleServerEditionCapability `json:"supportedFlexibleServerEditions,omitempty"`
	SupportedHAMode                      *[]string                          `json:"supportedHAMode,omitempty"`
	SupportedHyperscaleNodeEditions      *[]HyperscaleNodeEditionCapability `json:"supportedHyperscaleNodeEditions,omitempty"`
	Zone                                 *string                            `json:"zone,omitempty"`
	ZoneRedundantHaAndGeoBackupSupported *bool                              `json:"zoneRedundantHaAndGeoBackupSupported,omitempty"`
	ZoneRedundantHaSupported             *bool                              `json:"zoneRedundantHaSupported,omitempty"`
}

type CapabilityPropertiesOperationPredicate

type CapabilityPropertiesOperationPredicate struct {
	GeoBackupSupported                   *bool
	Status                               *string
	ZoneRedundantHaAndGeoBackupSupported *bool
	ZoneRedundantHaSupported             *bool
}

func (CapabilityPropertiesOperationPredicate) Matches

func (p CapabilityPropertiesOperationPredicate) Matches(input CapabilityProperties) bool

type ExecuteCompleteResult

type ExecuteCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []CapabilityProperties
}

type ExecuteOperationResponse

type ExecuteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]CapabilityProperties
}

type FlexibleServerEditionCapability

type FlexibleServerEditionCapability struct {
	Name                     *string                     `json:"name,omitempty"`
	Status                   *string                     `json:"status,omitempty"`
	SupportedServerVersions  *[]ServerVersionCapability  `json:"supportedServerVersions,omitempty"`
	SupportedStorageEditions *[]StorageEditionCapability `json:"supportedStorageEditions,omitempty"`
}

type HyperscaleNodeEditionCapability

type HyperscaleNodeEditionCapability struct {
	Name                     *string                     `json:"name,omitempty"`
	Status                   *string                     `json:"status,omitempty"`
	SupportedNodeTypes       *[]NodeTypeCapability       `json:"supportedNodeTypes,omitempty"`
	SupportedServerVersions  *[]ServerVersionCapability  `json:"supportedServerVersions,omitempty"`
	SupportedStorageEditions *[]StorageEditionCapability `json:"supportedStorageEditions,omitempty"`
}

type LocationBasedCapabilitiesClient

type LocationBasedCapabilitiesClient struct {
	Client *resourcemanager.Client
}

func NewLocationBasedCapabilitiesClientWithBaseURI

func NewLocationBasedCapabilitiesClientWithBaseURI(sdkApi sdkEnv.Api) (*LocationBasedCapabilitiesClient, error)

func (LocationBasedCapabilitiesClient) Execute

func (c LocationBasedCapabilitiesClient) Execute(ctx context.Context, id LocationId) (result ExecuteOperationResponse, err error)

Execute ...

func (LocationBasedCapabilitiesClient) ExecuteComplete

func (c LocationBasedCapabilitiesClient) ExecuteComplete(ctx context.Context, id LocationId) (ExecuteCompleteResult, error)

ExecuteComplete retrieves all the results into a single object

func (LocationBasedCapabilitiesClient) ExecuteCompleteMatchingPredicate

func (c LocationBasedCapabilitiesClient) ExecuteCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate CapabilityPropertiesOperationPredicate) (result ExecuteCompleteResult, err error)

ExecuteCompleteMatchingPredicate 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 NodeTypeCapability

type NodeTypeCapability struct {
	Name     *string `json:"name,omitempty"`
	NodeType *string `json:"nodeType,omitempty"`
	Status   *string `json:"status,omitempty"`
}

type ServerVersionCapability

type ServerVersionCapability struct {
	Name            *string            `json:"name,omitempty"`
	Status          *string            `json:"status,omitempty"`
	SupportedVcores *[]VcoreCapability `json:"supportedVcores,omitempty"`
}

type StorageEditionCapability

type StorageEditionCapability struct {
	Name               *string                `json:"name,omitempty"`
	Status             *string                `json:"status,omitempty"`
	SupportedStorageMB *[]StorageMBCapability `json:"supportedStorageMB,omitempty"`
}

type StorageMBCapability

type StorageMBCapability struct {
	Name          *string `json:"name,omitempty"`
	Status        *string `json:"status,omitempty"`
	StorageSizeMB *int64  `json:"storageSizeMB,omitempty"`
	SupportedIops *int64  `json:"supportedIops,omitempty"`
}

type VcoreCapability

type VcoreCapability struct {
	Name                      *string `json:"name,omitempty"`
	Status                    *string `json:"status,omitempty"`
	SupportedIops             *int64  `json:"supportedIops,omitempty"`
	SupportedMemoryPerVcoreMB *int64  `json:"supportedMemoryPerVcoreMB,omitempty"`
	VCores                    *int64  `json:"vCores,omitempty"`
}