databaseautomatictuning

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2022-11-01-preview/databaseautomatictuning Documentation

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

Client Initialization

client := databaseautomatictuning.NewDatabaseAutomaticTuningClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DatabaseAutomaticTuningClient.Get

ctx := context.TODO()
id := databaseautomatictuning.NewDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue")

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

Example Usage: DatabaseAutomaticTuningClient.Update

ctx := context.TODO()
id := databaseautomatictuning.NewDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue")

payload := databaseautomatictuning.DatabaseAutomaticTuning{
	// ...
}


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

Documentation

Index

• func PossibleValuesForAutomaticTuningDisabledReason() []string
• func PossibleValuesForAutomaticTuningMode() []string
• func PossibleValuesForAutomaticTuningOptionModeActual() []string
• func PossibleValuesForAutomaticTuningOptionModeDesired() []string
• func ValidateDatabaseID(input interface{}, key string) (warnings []string, errors []error)
• type AutomaticTuningDisabledReason
  • func (s *AutomaticTuningDisabledReason) UnmarshalJSON(bytes []byte) error
• type AutomaticTuningMode
  • func (s *AutomaticTuningMode) UnmarshalJSON(bytes []byte) error
• type AutomaticTuningOptionModeActual
  • func (s *AutomaticTuningOptionModeActual) UnmarshalJSON(bytes []byte) error
• type AutomaticTuningOptionModeDesired
  • func (s *AutomaticTuningOptionModeDesired) UnmarshalJSON(bytes []byte) error
• type AutomaticTuningOptions
• type DatabaseAutomaticTuning
• type DatabaseAutomaticTuningClient
  • func NewDatabaseAutomaticTuningClientWithBaseURI(sdkApi sdkEnv.Api) (*DatabaseAutomaticTuningClient, error)
  • func (c DatabaseAutomaticTuningClient) Get(ctx context.Context, id DatabaseId) (result GetOperationResponse, err error)
  • func (c DatabaseAutomaticTuningClient) Update(ctx context.Context, id DatabaseId, input DatabaseAutomaticTuning) (result UpdateOperationResponse, err error)
• type DatabaseAutomaticTuningProperties
• type DatabaseId
  • func NewDatabaseID(subscriptionId string, resourceGroupName string, serverName string, ...) DatabaseId
  • func ParseDatabaseID(input string) (*DatabaseId, error)
  • func ParseDatabaseIDInsensitively(input string) (*DatabaseId, error)
  • func (id DatabaseId) ID() string
  • func (id DatabaseId) Segments() []resourceids.Segment
  • func (id DatabaseId) String() string
• type GetOperationResponse
• type UpdateOperationResponse

Functions

func PossibleValuesForAutomaticTuningDisabledReason

func PossibleValuesForAutomaticTuningDisabledReason() []string

func PossibleValuesForAutomaticTuningMode

func PossibleValuesForAutomaticTuningMode() []string

func PossibleValuesForAutomaticTuningOptionModeActual

func PossibleValuesForAutomaticTuningOptionModeActual() []string

func PossibleValuesForAutomaticTuningOptionModeDesired

func PossibleValuesForAutomaticTuningOptionModeDesired() []string

func ValidateDatabaseID

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

ValidateDatabaseID checks that 'input' can be parsed as a Database ID

Types

type AutomaticTuningDisabledReason

type AutomaticTuningDisabledReason string

const (
	AutomaticTuningDisabledReasonAutoConfigured      AutomaticTuningDisabledReason = "AutoConfigured"
	AutomaticTuningDisabledReasonDefault             AutomaticTuningDisabledReason = "Default"
	AutomaticTuningDisabledReasonDisabled            AutomaticTuningDisabledReason = "Disabled"
	AutomaticTuningDisabledReasonInheritedFromServer AutomaticTuningDisabledReason = "InheritedFromServer"
	AutomaticTuningDisabledReasonNotSupported        AutomaticTuningDisabledReason = "NotSupported"
	AutomaticTuningDisabledReasonQueryStoreOff       AutomaticTuningDisabledReason = "QueryStoreOff"
	AutomaticTuningDisabledReasonQueryStoreReadOnly  AutomaticTuningDisabledReason = "QueryStoreReadOnly"
)

func (*AutomaticTuningDisabledReason) UnmarshalJSON

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

type AutomaticTuningMode

type AutomaticTuningMode string

const (
	AutomaticTuningModeAuto        AutomaticTuningMode = "Auto"
	AutomaticTuningModeCustom      AutomaticTuningMode = "Custom"
	AutomaticTuningModeInherit     AutomaticTuningMode = "Inherit"
	AutomaticTuningModeUnspecified AutomaticTuningMode = "Unspecified"
)

func (*AutomaticTuningMode) UnmarshalJSON

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

type AutomaticTuningOptionModeActual

type AutomaticTuningOptionModeActual string

const (
	AutomaticTuningOptionModeActualOff AutomaticTuningOptionModeActual = "Off"
	AutomaticTuningOptionModeActualOn  AutomaticTuningOptionModeActual = "On"
)

func (*AutomaticTuningOptionModeActual) UnmarshalJSON

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

type AutomaticTuningOptionModeDesired

type AutomaticTuningOptionModeDesired string

const (
	AutomaticTuningOptionModeDesiredDefault AutomaticTuningOptionModeDesired = "Default"
	AutomaticTuningOptionModeDesiredOff     AutomaticTuningOptionModeDesired = "Off"
	AutomaticTuningOptionModeDesiredOn      AutomaticTuningOptionModeDesired = "On"
)

func (*AutomaticTuningOptionModeDesired) UnmarshalJSON

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

type AutomaticTuningOptions

type AutomaticTuningOptions struct {
	ActualState  *AutomaticTuningOptionModeActual  `json:"actualState,omitempty"`
	DesiredState *AutomaticTuningOptionModeDesired `json:"desiredState,omitempty"`
	ReasonCode   *int64                            `json:"reasonCode,omitempty"`
	ReasonDesc   *AutomaticTuningDisabledReason    `json:"reasonDesc,omitempty"`
}

type DatabaseAutomaticTuning

type DatabaseAutomaticTuning struct {
	Id         *string                            `json:"id,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *DatabaseAutomaticTuningProperties `json:"properties,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type DatabaseAutomaticTuningClient

type DatabaseAutomaticTuningClient struct {
	Client *resourcemanager.Client
}

func NewDatabaseAutomaticTuningClientWithBaseURI

func NewDatabaseAutomaticTuningClientWithBaseURI(sdkApi sdkEnv.Api) (*DatabaseAutomaticTuningClient, error)

func (DatabaseAutomaticTuningClient) Get

func (c DatabaseAutomaticTuningClient) Get(ctx context.Context, id DatabaseId) (result GetOperationResponse, err error)

Get ...

func (DatabaseAutomaticTuningClient) Update

func (c DatabaseAutomaticTuningClient) Update(ctx context.Context, id DatabaseId, input DatabaseAutomaticTuning) (result UpdateOperationResponse, err error)

Update ...

type DatabaseAutomaticTuningProperties

type DatabaseAutomaticTuningProperties struct {
	ActualState  *AutomaticTuningMode               `json:"actualState,omitempty"`
	DesiredState *AutomaticTuningMode               `json:"desiredState,omitempty"`
	Options      *map[string]AutomaticTuningOptions `json:"options,omitempty"`
}

type DatabaseId

type DatabaseId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	DatabaseName      string
}

DatabaseId is a struct representing the Resource ID for a Database

func NewDatabaseID

func NewDatabaseID(subscriptionId string, resourceGroupName string, serverName string, databaseName string) DatabaseId

NewDatabaseID returns a new DatabaseId struct

func ParseDatabaseID

func ParseDatabaseID(input string) (*DatabaseId, error)

ParseDatabaseID parses 'input' into a DatabaseId

func ParseDatabaseIDInsensitively

func ParseDatabaseIDInsensitively(input string) (*DatabaseId, error)

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

func (DatabaseId) ID

func (id DatabaseId) ID() string

ID returns the formatted Database ID

func (DatabaseId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Database ID

func (DatabaseId) String

func (id DatabaseId) String() string

String returns a human-readable description of this Database ID

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DatabaseAutomaticTuning
}

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DatabaseAutomaticTuning
}