locationbasedcapabilities

package
v0.20240108.1165100 Latest Latest
Warning

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

 Go to latest Published: Jan 8, 2024 License: MPL-2.0 Imports: 10 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/postgresql/2023-03-01-preview/locationbasedcapabilities Documentation

The locationbasedcapabilities SDK allows for interaction with the Azure Resource Manager Service postgresql (API Version 2023-03-01-preview).

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/2023-03-01-preview/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

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCapabilityStatus 

func PossibleValuesForCapabilityStatus() []string

func PossibleValuesForFastProvisioningSupportedEnum 

func PossibleValuesForFastProvisioningSupportedEnum() []string

func PossibleValuesForGeoBackupSupportedEnum 

func PossibleValuesForGeoBackupSupportedEnum() []string

func PossibleValuesForHaMode 

func PossibleValuesForHaMode() []string

func PossibleValuesForOnlineResizeSupportedEnum 

func PossibleValuesForOnlineResizeSupportedEnum() []string

func PossibleValuesForRestrictedEnum 

func PossibleValuesForRestrictedEnum() []string

func PossibleValuesForStorageAutoGrowthSupportedEnum 

func PossibleValuesForStorageAutoGrowthSupportedEnum() []string

func PossibleValuesForZoneRedundantHaAndGeoBackupSupportedEnum 

func PossibleValuesForZoneRedundantHaAndGeoBackupSupportedEnum() []string

func PossibleValuesForZoneRedundantHaSupportedEnum 

func PossibleValuesForZoneRedundantHaSupportedEnum() []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 CapabilityStatus 

type CapabilityStatus string
const (
	CapabilityStatusAvailable CapabilityStatus = "Available"
	CapabilityStatusDefault   CapabilityStatus = "Default"
	CapabilityStatusDisabled  CapabilityStatus = "Disabled"
	CapabilityStatusVisible   CapabilityStatus = "Visible"
)

func (*CapabilityStatus) UnmarshalJSON added in v0.20230809.1081239 

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

type ExecuteCompleteResult 

type ExecuteCompleteResult struct {
	Items []FlexibleServerCapability
}

type ExecuteOperationResponse 

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

type FastProvisioningEditionCapability 

type FastProvisioningEditionCapability struct {
	Reason                  *string           `json:"reason,omitempty"`
	ServerCount             *int64            `json:"serverCount,omitempty"`
	Status                  *CapabilityStatus `json:"status,omitempty"`
	SupportedServerVersions *string           `json:"supportedServerVersions,omitempty"`
	SupportedSku            *string           `json:"supportedSku,omitempty"`
	SupportedStorageGb      *int64            `json:"supportedStorageGb,omitempty"`
	SupportedTier           *string           `json:"supportedTier,omitempty"`
}

type FastProvisioningSupportedEnum 

type FastProvisioningSupportedEnum string
const (
	FastProvisioningSupportedEnumDisabled FastProvisioningSupportedEnum = "Disabled"
	FastProvisioningSupportedEnumEnabled  FastProvisioningSupportedEnum = "Enabled"
)

func (*FastProvisioningSupportedEnum) UnmarshalJSON added in v0.20230809.1081239 

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

type FlexibleServerCapability 

type FlexibleServerCapability struct {
	FastProvisioningSupported            *FastProvisioningSupportedEnum            `json:"fastProvisioningSupported,omitempty"`
	GeoBackupSupported                   *GeoBackupSupportedEnum                   `json:"geoBackupSupported,omitempty"`
	Name                                 *string                                   `json:"name,omitempty"`
	OnlineResizeSupported                *OnlineResizeSupportedEnum                `json:"onlineResizeSupported,omitempty"`
	Reason                               *string                                   `json:"reason,omitempty"`
	Restricted                           *RestrictedEnum                           `json:"restricted,omitempty"`
	Status                               *CapabilityStatus                         `json:"status,omitempty"`
	StorageAutoGrowthSupported           *StorageAutoGrowthSupportedEnum           `json:"storageAutoGrowthSupported,omitempty"`
	SupportedFastProvisioningEditions    *[]FastProvisioningEditionCapability      `json:"supportedFastProvisioningEditions,omitempty"`
	SupportedServerEditions              *[]FlexibleServerEditionCapability        `json:"supportedServerEditions,omitempty"`
	SupportedServerVersions              *[]ServerVersionCapability                `json:"supportedServerVersions,omitempty"`
	ZoneRedundantHaAndGeoBackupSupported *ZoneRedundantHaAndGeoBackupSupportedEnum `json:"zoneRedundantHaAndGeoBackupSupported,omitempty"`
	ZoneRedundantHaSupported             *ZoneRedundantHaSupportedEnum             `json:"zoneRedundantHaSupported,omitempty"`
}

type FlexibleServerCapabilityOperationPredicate 

type FlexibleServerCapabilityOperationPredicate struct {
	Name   *string
	Reason *string
}

func (FlexibleServerCapabilityOperationPredicate) Matches 

func (p FlexibleServerCapabilityOperationPredicate) Matches(input FlexibleServerCapability) bool

type FlexibleServerEditionCapability 

type FlexibleServerEditionCapability struct {
	DefaultSkuName           *string                     `json:"defaultSkuName,omitempty"`
	Name                     *string                     `json:"name,omitempty"`
	Reason                   *string                     `json:"reason,omitempty"`
	Status                   *CapabilityStatus           `json:"status,omitempty"`
	SupportedServerSkus      *[]ServerSkuCapability      `json:"supportedServerSkus,omitempty"`
	SupportedStorageEditions *[]StorageEditionCapability `json:"supportedStorageEditions,omitempty"`
}

type GeoBackupSupportedEnum 

type GeoBackupSupportedEnum string
const (
	GeoBackupSupportedEnumDisabled GeoBackupSupportedEnum = "Disabled"
	GeoBackupSupportedEnumEnabled  GeoBackupSupportedEnum = "Enabled"
)

func (*GeoBackupSupportedEnum) UnmarshalJSON added in v0.20230809.1081239 

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

type HaMode 

type HaMode string
const (
	HaModeSameZone      HaMode = "SameZone"
	HaModeZoneRedundant HaMode = "ZoneRedundant"
)

func (*HaMode) UnmarshalJSON added in v0.20230809.1081239 

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

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 FlexibleServerCapabilityOperationPredicate) (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 added in v0.20231127.1171502 

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 OnlineResizeSupportedEnum 

type OnlineResizeSupportedEnum string
const (
	OnlineResizeSupportedEnumDisabled OnlineResizeSupportedEnum = "Disabled"
	OnlineResizeSupportedEnumEnabled  OnlineResizeSupportedEnum = "Enabled"
)

func (*OnlineResizeSupportedEnum) UnmarshalJSON added in v0.20230809.1081239 

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

type RestrictedEnum 

type RestrictedEnum string
const (
	RestrictedEnumDisabled RestrictedEnum = "Disabled"
	RestrictedEnumEnabled  RestrictedEnum = "Enabled"
)

func (*RestrictedEnum) UnmarshalJSON added in v0.20230809.1081239 

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

type ServerSkuCapability 

type ServerSkuCapability struct {
	Name                      *string           `json:"name,omitempty"`
	Reason                    *string           `json:"reason,omitempty"`
	Status                    *CapabilityStatus `json:"status,omitempty"`
	SupportedHaMode           *[]HaMode         `json:"supportedHaMode,omitempty"`
	SupportedIops             *int64            `json:"supportedIops,omitempty"`
	SupportedMemoryPerVcoreMb *int64            `json:"supportedMemoryPerVcoreMb,omitempty"`
	SupportedZones            *[]string         `json:"supportedZones,omitempty"`
	VCores                    *int64            `json:"vCores,omitempty"`
}

type ServerVersionCapability 

type ServerVersionCapability struct {
	Name                       *string           `json:"name,omitempty"`
	Reason                     *string           `json:"reason,omitempty"`
	Status                     *CapabilityStatus `json:"status,omitempty"`
	SupportedVersionsToUpgrade *[]string         `json:"supportedVersionsToUpgrade,omitempty"`
}

type StorageAutoGrowthSupportedEnum 

type StorageAutoGrowthSupportedEnum string
const (
	StorageAutoGrowthSupportedEnumDisabled StorageAutoGrowthSupportedEnum = "Disabled"
	StorageAutoGrowthSupportedEnumEnabled  StorageAutoGrowthSupportedEnum = "Enabled"
)

func (*StorageAutoGrowthSupportedEnum) UnmarshalJSON added in v0.20230809.1081239 

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

type StorageEditionCapability 

type StorageEditionCapability struct {
	DefaultStorageSizeMb *int64                 `json:"defaultStorageSizeMb,omitempty"`
	Name                 *string                `json:"name,omitempty"`
	Reason               *string                `json:"reason,omitempty"`
	Status               *CapabilityStatus      `json:"status,omitempty"`
	SupportedStorageMb   *[]StorageMbCapability `json:"supportedStorageMb,omitempty"`
}

type StorageMbCapability 

type StorageMbCapability struct {
	DefaultIopsTier    *string                  `json:"defaultIopsTier,omitempty"`
	Reason             *string                  `json:"reason,omitempty"`
	Status             *CapabilityStatus        `json:"status,omitempty"`
	StorageSizeMb      *int64                   `json:"storageSizeMb,omitempty"`
	SupportedIops      *int64                   `json:"supportedIops,omitempty"`
	SupportedIopsTiers *[]StorageTierCapability `json:"supportedIopsTiers,omitempty"`
}

type StorageTierCapability 

type StorageTierCapability struct {
	Iops   *int64            `json:"iops,omitempty"`
	Name   *string           `json:"name,omitempty"`
	Reason *string           `json:"reason,omitempty"`
	Status *CapabilityStatus `json:"status,omitempty"`
}

type ZoneRedundantHaAndGeoBackupSupportedEnum 

type ZoneRedundantHaAndGeoBackupSupportedEnum string
const (
	ZoneRedundantHaAndGeoBackupSupportedEnumDisabled ZoneRedundantHaAndGeoBackupSupportedEnum = "Disabled"
	ZoneRedundantHaAndGeoBackupSupportedEnumEnabled  ZoneRedundantHaAndGeoBackupSupportedEnum = "Enabled"
)

func (*ZoneRedundantHaAndGeoBackupSupportedEnum) UnmarshalJSON added in v0.20230809.1081239 

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

type ZoneRedundantHaSupportedEnum 

type ZoneRedundantHaSupportedEnum string
const (
	ZoneRedundantHaSupportedEnumDisabled ZoneRedundantHaSupportedEnum = "Disabled"
	ZoneRedundantHaSupportedEnumEnabled  ZoneRedundantHaSupportedEnum = "Enabled"
)

func (*ZoneRedundantHaSupportedEnum) UnmarshalJSON added in v0.20230809.1081239 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.