locationcapabilities

package
v0.20240612.1084144 Latest Latest
Warning

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

Go to latest
Published: Jun 12, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/locationcapabilities Documentation

The locationcapabilities SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-02-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/sql/2023-02-01-preview/locationcapabilities"

Client Initialization

client := locationcapabilities.NewLocationCapabilitiesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: LocationCapabilitiesClient.CapabilitiesListByLocation

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCapabilityGroup

func PossibleValuesForCapabilityGroup() []string

func PossibleValuesForCapabilityStatus

func PossibleValuesForCapabilityStatus() []string

func PossibleValuesForFreeLimitExhaustionBehavior

func PossibleValuesForFreeLimitExhaustionBehavior() []string

func PossibleValuesForLogSizeUnit

func PossibleValuesForLogSizeUnit() []string

func PossibleValuesForMaxSizeUnit

func PossibleValuesForMaxSizeUnit() []string

func PossibleValuesForPauseDelayTimeUnit

func PossibleValuesForPauseDelayTimeUnit() []string

func PossibleValuesForPerformanceLevelUnit

func PossibleValuesForPerformanceLevelUnit() []string

func PossibleValuesForStorageAccountType

func PossibleValuesForStorageAccountType() []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 AutoPauseDelayTimeRange

type AutoPauseDelayTimeRange struct {
	Default         *int64              `json:"default,omitempty"`
	DoNotPauseValue *int64              `json:"doNotPauseValue,omitempty"`
	MaxValue        *int64              `json:"maxValue,omitempty"`
	MinValue        *int64              `json:"minValue,omitempty"`
	StepSize        *int64              `json:"stepSize,omitempty"`
	Unit            *PauseDelayTimeUnit `json:"unit,omitempty"`
}

type CapabilitiesListByLocationOperationOptions

type CapabilitiesListByLocationOperationOptions struct {
	Include *CapabilityGroup
}

func DefaultCapabilitiesListByLocationOperationOptions

func DefaultCapabilitiesListByLocationOperationOptions() CapabilitiesListByLocationOperationOptions

func (CapabilitiesListByLocationOperationOptions) ToHeaders

func (CapabilitiesListByLocationOperationOptions) ToOData

func (CapabilitiesListByLocationOperationOptions) ToQuery

type CapabilitiesListByLocationOperationResponse

type CapabilitiesListByLocationOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *LocationCapabilities
}

type CapabilityGroup

type CapabilityGroup string
const (
	CapabilityGroupSupportedEditions                CapabilityGroup = "supportedEditions"
	CapabilityGroupSupportedElasticPoolEditions     CapabilityGroup = "supportedElasticPoolEditions"
	CapabilityGroupSupportedInstancePoolEditions    CapabilityGroup = "supportedInstancePoolEditions"
	CapabilityGroupSupportedManagedInstanceEditions CapabilityGroup = "supportedManagedInstanceEditions"
	CapabilityGroupSupportedManagedInstanceVersions CapabilityGroup = "supportedManagedInstanceVersions"
)

func (*CapabilityGroup) UnmarshalJSON

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

type CapabilityStatus

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

func (*CapabilityStatus) UnmarshalJSON

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

type EditionCapability

type EditionCapability struct {
	Name                            *string                       `json:"name,omitempty"`
	ReadScale                       *ReadScaleCapability          `json:"readScale,omitempty"`
	Reason                          *string                       `json:"reason,omitempty"`
	Status                          *CapabilityStatus             `json:"status,omitempty"`
	SupportedServiceLevelObjectives *[]ServiceObjectiveCapability `json:"supportedServiceLevelObjectives,omitempty"`
	SupportedStorageCapabilities    *[]StorageCapability          `json:"supportedStorageCapabilities,omitempty"`
	ZonePinning                     *bool                         `json:"zonePinning,omitempty"`
	ZoneRedundant                   *bool                         `json:"zoneRedundant,omitempty"`
}

type ElasticPoolEditionCapability

type ElasticPoolEditionCapability struct {
	Name                                  *string                                  `json:"name,omitempty"`
	Reason                                *string                                  `json:"reason,omitempty"`
	Status                                *CapabilityStatus                        `json:"status,omitempty"`
	SupportedElasticPoolPerformanceLevels *[]ElasticPoolPerformanceLevelCapability `json:"supportedElasticPoolPerformanceLevels,omitempty"`
	ZonePinning                           *bool                                    `json:"zonePinning,omitempty"`
	ZoneRedundant                         *bool                                    `json:"zoneRedundant,omitempty"`
}

type ElasticPoolPerDatabaseMaxPerformanceLevelCapability

type ElasticPoolPerDatabaseMaxPerformanceLevelCapability struct {
	Limit                                    *float64                                               `json:"limit,omitempty"`
	Reason                                   *string                                                `json:"reason,omitempty"`
	Status                                   *CapabilityStatus                                      `json:"status,omitempty"`
	SupportedPerDatabaseMinPerformanceLevels *[]ElasticPoolPerDatabaseMinPerformanceLevelCapability `json:"supportedPerDatabaseMinPerformanceLevels,omitempty"`
	Unit                                     *PerformanceLevelUnit                                  `json:"unit,omitempty"`
}

type ElasticPoolPerDatabaseMinPerformanceLevelCapability

type ElasticPoolPerDatabaseMinPerformanceLevelCapability struct {
	Limit  *float64              `json:"limit,omitempty"`
	Reason *string               `json:"reason,omitempty"`
	Status *CapabilityStatus     `json:"status,omitempty"`
	Unit   *PerformanceLevelUnit `json:"unit,omitempty"`
}

type ElasticPoolPerformanceLevelCapability

type ElasticPoolPerformanceLevelCapability struct {
	IncludedMaxSize                          *MaxSizeCapability                                     `json:"includedMaxSize,omitempty"`
	MaxDatabaseCount                         *int64                                                 `json:"maxDatabaseCount,omitempty"`
	PerformanceLevel                         *PerformanceLevelCapability                            `json:"performanceLevel,omitempty"`
	Reason                                   *string                                                `json:"reason,omitempty"`
	Sku                                      *Sku                                                   `json:"sku,omitempty"`
	Status                                   *CapabilityStatus                                      `json:"status,omitempty"`
	SupportedLicenseTypes                    *[]LicenseTypeCapability                               `json:"supportedLicenseTypes,omitempty"`
	SupportedMaintenanceConfigurations       *[]MaintenanceConfigurationCapability                  `json:"supportedMaintenanceConfigurations,omitempty"`
	SupportedMaxSizes                        *[]MaxSizeRangeCapability                              `json:"supportedMaxSizes,omitempty"`
	SupportedPerDatabaseMaxPerformanceLevels *[]ElasticPoolPerDatabaseMaxPerformanceLevelCapability `json:"supportedPerDatabaseMaxPerformanceLevels,omitempty"`
	SupportedPerDatabaseMaxSizes             *[]MaxSizeRangeCapability                              `json:"supportedPerDatabaseMaxSizes,omitempty"`
	ZoneRedundant                            *bool                                                  `json:"zoneRedundant,omitempty"`
}

type FreeLimitExhaustionBehavior

type FreeLimitExhaustionBehavior string
const (
	FreeLimitExhaustionBehaviorAutoPause     FreeLimitExhaustionBehavior = "AutoPause"
	FreeLimitExhaustionBehaviorBillOverUsage FreeLimitExhaustionBehavior = "BillOverUsage"
)

func (*FreeLimitExhaustionBehavior) UnmarshalJSON

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

type FreeLimitExhaustionBehaviorCapability

type FreeLimitExhaustionBehaviorCapability struct {
	ExhaustionBehaviorType *FreeLimitExhaustionBehavior `json:"exhaustionBehaviorType,omitempty"`
	Status                 *CapabilityStatus            `json:"status,omitempty"`
}

type InstancePoolEditionCapability

type InstancePoolEditionCapability struct {
	Name              *string                         `json:"name,omitempty"`
	Reason            *string                         `json:"reason,omitempty"`
	Status            *CapabilityStatus               `json:"status,omitempty"`
	SupportedFamilies *[]InstancePoolFamilyCapability `json:"supportedFamilies,omitempty"`
}

type InstancePoolFamilyCapability

type InstancePoolFamilyCapability struct {
	Name                  *string                         `json:"name,omitempty"`
	Reason                *string                         `json:"reason,omitempty"`
	Status                *CapabilityStatus               `json:"status,omitempty"`
	SupportedLicenseTypes *[]LicenseTypeCapability        `json:"supportedLicenseTypes,omitempty"`
	SupportedVcoresValues *[]InstancePoolVcoresCapability `json:"supportedVcoresValues,omitempty"`
}

type InstancePoolVcoresCapability

type InstancePoolVcoresCapability struct {
	Name         *string            `json:"name,omitempty"`
	Reason       *string            `json:"reason,omitempty"`
	Status       *CapabilityStatus  `json:"status,omitempty"`
	StorageLimit *MaxSizeCapability `json:"storageLimit,omitempty"`
	Value        *int64             `json:"value,omitempty"`
}

type LicenseTypeCapability

type LicenseTypeCapability struct {
	Name   *string           `json:"name,omitempty"`
	Reason *string           `json:"reason,omitempty"`
	Status *CapabilityStatus `json:"status,omitempty"`
}

type LocationCapabilities

type LocationCapabilities struct {
	Name                             *string                             `json:"name,omitempty"`
	Reason                           *string                             `json:"reason,omitempty"`
	Status                           *CapabilityStatus                   `json:"status,omitempty"`
	SupportedManagedInstanceVersions *[]ManagedInstanceVersionCapability `json:"supportedManagedInstanceVersions,omitempty"`
	SupportedServerVersions          *[]ServerVersionCapability          `json:"supportedServerVersions,omitempty"`
}

type LocationCapabilitiesClient

type LocationCapabilitiesClient struct {
	Client *resourcemanager.Client
}

func NewLocationCapabilitiesClientWithBaseURI

func NewLocationCapabilitiesClientWithBaseURI(sdkApi sdkEnv.Api) (*LocationCapabilitiesClient, error)

func (LocationCapabilitiesClient) CapabilitiesListByLocation

CapabilitiesListByLocation ...

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 LogSizeCapability

type LogSizeCapability struct {
	Limit *int64       `json:"limit,omitempty"`
	Unit  *LogSizeUnit `json:"unit,omitempty"`
}

type LogSizeUnit

type LogSizeUnit string
const (
	LogSizeUnitGigabytes LogSizeUnit = "Gigabytes"
	LogSizeUnitMegabytes LogSizeUnit = "Megabytes"
	LogSizeUnitPercent   LogSizeUnit = "Percent"
	LogSizeUnitPetabytes LogSizeUnit = "Petabytes"
	LogSizeUnitTerabytes LogSizeUnit = "Terabytes"
)

func (*LogSizeUnit) UnmarshalJSON

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

type MaintenanceConfigurationCapability

type MaintenanceConfigurationCapability struct {
	Name          *string           `json:"name,omitempty"`
	Reason        *string           `json:"reason,omitempty"`
	Status        *CapabilityStatus `json:"status,omitempty"`
	ZoneRedundant *bool             `json:"zoneRedundant,omitempty"`
}

type ManagedInstanceEditionCapability

type ManagedInstanceEditionCapability struct {
	IsGeneralPurposeV2           *bool                              `json:"isGeneralPurposeV2,omitempty"`
	Name                         *string                            `json:"name,omitempty"`
	Reason                       *string                            `json:"reason,omitempty"`
	Status                       *CapabilityStatus                  `json:"status,omitempty"`
	SupportedFamilies            *[]ManagedInstanceFamilyCapability `json:"supportedFamilies,omitempty"`
	SupportedStorageCapabilities *[]StorageCapability               `json:"supportedStorageCapabilities,omitempty"`
}

type ManagedInstanceFamilyCapability

type ManagedInstanceFamilyCapability struct {
	Name                  *string                            `json:"name,omitempty"`
	Reason                *string                            `json:"reason,omitempty"`
	Sku                   *string                            `json:"sku,omitempty"`
	Status                *CapabilityStatus                  `json:"status,omitempty"`
	SupportedLicenseTypes *[]LicenseTypeCapability           `json:"supportedLicenseTypes,omitempty"`
	SupportedVcoresValues *[]ManagedInstanceVcoresCapability `json:"supportedVcoresValues,omitempty"`
	ZoneRedundant         *bool                              `json:"zoneRedundant,omitempty"`
}

type ManagedInstanceMaintenanceConfigurationCapability

type ManagedInstanceMaintenanceConfigurationCapability struct {
	Name   *string           `json:"name,omitempty"`
	Reason *string           `json:"reason,omitempty"`
	Status *CapabilityStatus `json:"status,omitempty"`
}

type ManagedInstanceVcoresCapability

type ManagedInstanceVcoresCapability struct {
	IncludedMaxSize                                               *MaxSizeCapability                                   `json:"includedMaxSize,omitempty"`
	IncludedStorageIOps                                           *int64                                               `json:"includedStorageIOps,omitempty"`
	IncludedStorageThroughputMBps                                 *int64                                               `json:"includedStorageThroughputMBps,omitempty"`
	InstancePoolSupported                                         *bool                                                `json:"instancePoolSupported,omitempty"`
	IopsIncludedValueOverrideFactorPerSelectedStorageGB           *float64                                             `json:"iopsIncludedValueOverrideFactorPerSelectedStorageGB,omitempty"`
	IopsMinValueOverrideFactorPerSelectedStorageGB                *float64                                             `json:"iopsMinValueOverrideFactorPerSelectedStorageGB,omitempty"`
	Name                                                          *string                                              `json:"name,omitempty"`
	Reason                                                        *string                                              `json:"reason,omitempty"`
	StandaloneSupported                                           *bool                                                `json:"standaloneSupported,omitempty"`
	Status                                                        *CapabilityStatus                                    `json:"status,omitempty"`
	SupportedMaintenanceConfigurations                            *[]ManagedInstanceMaintenanceConfigurationCapability `json:"supportedMaintenanceConfigurations,omitempty"`
	SupportedStorageIOps                                          *MaxLimitRangeCapability                             `json:"supportedStorageIOps,omitempty"`
	SupportedStorageSizes                                         *[]MaxSizeRangeCapability                            `json:"supportedStorageSizes,omitempty"`
	SupportedStorageThroughputMBps                                *MaxLimitRangeCapability                             `json:"supportedStorageThroughputMBps,omitempty"`
	ThroughputMBpsIncludedValueOverrideFactorPerSelectedStorageGB *float64                                             `json:"throughputMBpsIncludedValueOverrideFactorPerSelectedStorageGB,omitempty"`
	ThroughputMBpsMinValueOverrideFactorPerSelectedStorageGB      *float64                                             `json:"throughputMBpsMinValueOverrideFactorPerSelectedStorageGB,omitempty"`
	Value                                                         *int64                                               `json:"value,omitempty"`
}

type ManagedInstanceVersionCapability

type ManagedInstanceVersionCapability struct {
	Name                          *string                             `json:"name,omitempty"`
	Reason                        *string                             `json:"reason,omitempty"`
	Status                        *CapabilityStatus                   `json:"status,omitempty"`
	SupportedEditions             *[]ManagedInstanceEditionCapability `json:"supportedEditions,omitempty"`
	SupportedInstancePoolEditions *[]InstancePoolEditionCapability    `json:"supportedInstancePoolEditions,omitempty"`
}

type MaxLimitRangeCapability

type MaxLimitRangeCapability struct {
	MaxValue  *int64            `json:"maxValue,omitempty"`
	MinValue  *int64            `json:"minValue,omitempty"`
	Reason    *string           `json:"reason,omitempty"`
	ScaleSize *int64            `json:"scaleSize,omitempty"`
	Status    *CapabilityStatus `json:"status,omitempty"`
}

type MaxSizeCapability

type MaxSizeCapability struct {
	Limit *int64       `json:"limit,omitempty"`
	Unit  *MaxSizeUnit `json:"unit,omitempty"`
}

type MaxSizeRangeCapability

type MaxSizeRangeCapability struct {
	LogSize   *LogSizeCapability `json:"logSize,omitempty"`
	MaxValue  *MaxSizeCapability `json:"maxValue,omitempty"`
	MinValue  *MaxSizeCapability `json:"minValue,omitempty"`
	Reason    *string            `json:"reason,omitempty"`
	ScaleSize *MaxSizeCapability `json:"scaleSize,omitempty"`
	Status    *CapabilityStatus  `json:"status,omitempty"`
}

type MaxSizeUnit

type MaxSizeUnit string
const (
	MaxSizeUnitGigabytes MaxSizeUnit = "Gigabytes"
	MaxSizeUnitMegabytes MaxSizeUnit = "Megabytes"
	MaxSizeUnitPetabytes MaxSizeUnit = "Petabytes"
	MaxSizeUnitTerabytes MaxSizeUnit = "Terabytes"
)

func (*MaxSizeUnit) UnmarshalJSON

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

type MinCapacityCapability

type MinCapacityCapability struct {
	Reason *string           `json:"reason,omitempty"`
	Status *CapabilityStatus `json:"status,omitempty"`
	Value  *float64          `json:"value,omitempty"`
}

type PauseDelayTimeUnit

type PauseDelayTimeUnit string
const (
	PauseDelayTimeUnitMinutes PauseDelayTimeUnit = "Minutes"
)

func (*PauseDelayTimeUnit) UnmarshalJSON

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

type PerformanceLevelCapability

type PerformanceLevelCapability struct {
	Unit  *PerformanceLevelUnit `json:"unit,omitempty"`
	Value *float64              `json:"value,omitempty"`
}

type PerformanceLevelUnit

type PerformanceLevelUnit string
const (
	PerformanceLevelUnitDTU    PerformanceLevelUnit = "DTU"
	PerformanceLevelUnitVCores PerformanceLevelUnit = "VCores"
)

func (*PerformanceLevelUnit) UnmarshalJSON

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

type ReadScaleCapability

type ReadScaleCapability struct {
	MaxNumberOfReplicas *int64            `json:"maxNumberOfReplicas,omitempty"`
	Reason              *string           `json:"reason,omitempty"`
	Status              *CapabilityStatus `json:"status,omitempty"`
}

type ServerVersionCapability

type ServerVersionCapability struct {
	Name                         *string                         `json:"name,omitempty"`
	Reason                       *string                         `json:"reason,omitempty"`
	Status                       *CapabilityStatus               `json:"status,omitempty"`
	SupportedEditions            *[]EditionCapability            `json:"supportedEditions,omitempty"`
	SupportedElasticPoolEditions *[]ElasticPoolEditionCapability `json:"supportedElasticPoolEditions,omitempty"`
}

type ServiceObjectiveCapability

type ServiceObjectiveCapability struct {
	ComputeModel                          *string                                  `json:"computeModel,omitempty"`
	Id                                    *string                                  `json:"id,omitempty"`
	IncludedMaxSize                       *MaxSizeCapability                       `json:"includedMaxSize,omitempty"`
	Name                                  *string                                  `json:"name,omitempty"`
	PerformanceLevel                      *PerformanceLevelCapability              `json:"performanceLevel,omitempty"`
	Reason                                *string                                  `json:"reason,omitempty"`
	Sku                                   *Sku                                     `json:"sku,omitempty"`
	Status                                *CapabilityStatus                        `json:"status,omitempty"`
	SupportedAutoPauseDelay               *AutoPauseDelayTimeRange                 `json:"supportedAutoPauseDelay,omitempty"`
	SupportedFreeLimitExhaustionBehaviors *[]FreeLimitExhaustionBehaviorCapability `json:"supportedFreeLimitExhaustionBehaviors,omitempty"`
	SupportedLicenseTypes                 *[]LicenseTypeCapability                 `json:"supportedLicenseTypes,omitempty"`
	SupportedMaintenanceConfigurations    *[]MaintenanceConfigurationCapability    `json:"supportedMaintenanceConfigurations,omitempty"`
	SupportedMaxSizes                     *[]MaxSizeRangeCapability                `json:"supportedMaxSizes,omitempty"`
	SupportedMinCapacities                *[]MinCapacityCapability                 `json:"supportedMinCapacities,omitempty"`
	ZonePinning                           *bool                                    `json:"zonePinning,omitempty"`
	ZoneRedundant                         *bool                                    `json:"zoneRedundant,omitempty"`
}

type Sku

type Sku struct {
	Capacity *int64  `json:"capacity,omitempty"`
	Family   *string `json:"family,omitempty"`
	Name     string  `json:"name"`
	Size     *string `json:"size,omitempty"`
	Tier     *string `json:"tier,omitempty"`
}

type StorageAccountType

type StorageAccountType string
const (
	StorageAccountTypeGRS  StorageAccountType = "GRS"
	StorageAccountTypeGZRS StorageAccountType = "GZRS"
	StorageAccountTypeLRS  StorageAccountType = "LRS"
	StorageAccountTypeZRS  StorageAccountType = "ZRS"
)

func (*StorageAccountType) UnmarshalJSON

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

type StorageCapability

type StorageCapability struct {
	Reason             *string             `json:"reason,omitempty"`
	Status             *CapabilityStatus   `json:"status,omitempty"`
	StorageAccountType *StorageAccountType `json:"storageAccountType,omitempty"`
}

Jump to

Keyboard shortcuts

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