configurations

package
v0.20231018.1165214 Latest Latest
Warning

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

Go to latest
Published: Oct 18, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/mysql/2022-01-01/configurations Documentation

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

Client Initialization

client := configurations.NewConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConfigurationsClient.BatchUpdate

ctx := context.TODO()
id := configurations.NewFlexibleServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue")

payload := configurations.ConfigurationListForBatchUpdate{
	// ...
}


if err := client.BatchUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ConfigurationsClient.CreateOrUpdate

ctx := context.TODO()
id := configurations.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue", "configurationValue")

payload := configurations.Configuration{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ConfigurationsClient.Get

ctx := context.TODO()
id := configurations.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue", "configurationValue")

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: ConfigurationsClient.ListByServer

ctx := context.TODO()
id := configurations.NewFlexibleServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue")

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

Example Usage: ConfigurationsClient.Update

ctx := context.TODO()
id := configurations.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue", "configurationValue")

payload := configurations.Configuration{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForConfigurationSource

func PossibleValuesForConfigurationSource() []string

func PossibleValuesForIsConfigPendingRestart

func PossibleValuesForIsConfigPendingRestart() []string

func PossibleValuesForIsDynamicConfig

func PossibleValuesForIsDynamicConfig() []string

func PossibleValuesForIsReadOnly

func PossibleValuesForIsReadOnly() []string

func PossibleValuesForResetAllToDefault

func PossibleValuesForResetAllToDefault() []string

func ValidateConfigurationID

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

ValidateConfigurationID checks that 'input' can be parsed as a Configuration ID

func ValidateFlexibleServerID

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

ValidateFlexibleServerID checks that 'input' can be parsed as a Flexible Server ID

Types

type BatchUpdateOperationResponse

type BatchUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type Configuration

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

type ConfigurationForBatchUpdate

type ConfigurationForBatchUpdate struct {
	Name       *string                                `json:"name,omitempty"`
	Properties *ConfigurationForBatchUpdateProperties `json:"properties,omitempty"`
}

type ConfigurationForBatchUpdateProperties

type ConfigurationForBatchUpdateProperties struct {
	Source *string `json:"source,omitempty"`
	Value  *string `json:"value,omitempty"`
}

type ConfigurationId

type ConfigurationId struct {
	SubscriptionId     string
	ResourceGroupName  string
	FlexibleServerName string
	ConfigurationName  string
}

ConfigurationId is a struct representing the Resource ID for a Configuration

func NewConfigurationID

func NewConfigurationID(subscriptionId string, resourceGroupName string, flexibleServerName string, configurationName string) ConfigurationId

NewConfigurationID returns a new ConfigurationId struct

func ParseConfigurationID

func ParseConfigurationID(input string) (*ConfigurationId, error)

ParseConfigurationID parses 'input' into a ConfigurationId

func ParseConfigurationIDInsensitively

func ParseConfigurationIDInsensitively(input string) (*ConfigurationId, error)

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

func (ConfigurationId) ID

func (id ConfigurationId) ID() string

ID returns the formatted Configuration ID

func (ConfigurationId) Segments

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

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

func (ConfigurationId) String

func (id ConfigurationId) String() string

String returns a human-readable description of this Configuration ID

type ConfigurationListForBatchUpdate

type ConfigurationListForBatchUpdate struct {
	ResetAllToDefault *ResetAllToDefault             `json:"resetAllToDefault,omitempty"`
	Value             *[]ConfigurationForBatchUpdate `json:"value,omitempty"`
}

type ConfigurationListResult

type ConfigurationListResult struct {
	NextLink *string          `json:"nextLink,omitempty"`
	Value    *[]Configuration `json:"value,omitempty"`
}

type ConfigurationOperationPredicate

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

func (ConfigurationOperationPredicate) Matches

type ConfigurationProperties

type ConfigurationProperties struct {
	AllowedValues          *string                 `json:"allowedValues,omitempty"`
	CurrentValue           *string                 `json:"currentValue,omitempty"`
	DataType               *string                 `json:"dataType,omitempty"`
	DefaultValue           *string                 `json:"defaultValue,omitempty"`
	Description            *string                 `json:"description,omitempty"`
	DocumentationLink      *string                 `json:"documentationLink,omitempty"`
	IsConfigPendingRestart *IsConfigPendingRestart `json:"isConfigPendingRestart,omitempty"`
	IsDynamicConfig        *IsDynamicConfig        `json:"isDynamicConfig,omitempty"`
	IsReadOnly             *IsReadOnly             `json:"isReadOnly,omitempty"`
	Source                 *ConfigurationSource    `json:"source,omitempty"`
	Value                  *string                 `json:"value,omitempty"`
}

type ConfigurationSource

type ConfigurationSource string
const (
	ConfigurationSourceSystemNegativedefault ConfigurationSource = "system-default"
	ConfigurationSourceUserNegativeoverride  ConfigurationSource = "user-override"
)

func (*ConfigurationSource) UnmarshalJSON added in v0.20230725.1205316

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

type ConfigurationsClient

type ConfigurationsClient struct {
	Client *resourcemanager.Client
}

func NewConfigurationsClientWithBaseURI

func NewConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*ConfigurationsClient, error)

func (ConfigurationsClient) BatchUpdate

BatchUpdate ...

func (ConfigurationsClient) BatchUpdateThenPoll

BatchUpdateThenPoll performs BatchUpdate then polls until it's completed

func (ConfigurationsClient) CreateOrUpdate

CreateOrUpdate ...

func (ConfigurationsClient) CreateOrUpdateThenPoll

func (c ConfigurationsClient) CreateOrUpdateThenPoll(ctx context.Context, id ConfigurationId, input Configuration) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ConfigurationsClient) Get

Get ...

func (ConfigurationsClient) ListByServer

ListByServer ...

func (ConfigurationsClient) ListByServerComplete

ListByServerComplete retrieves all the results into a single object

func (ConfigurationsClient) ListByServerCompleteMatchingPredicate

func (c ConfigurationsClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id FlexibleServerId, options ListByServerOperationOptions, predicate ConfigurationOperationPredicate) (result ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConfigurationsClient) Update

Update ...

func (ConfigurationsClient) UpdateThenPoll

func (c ConfigurationsClient) UpdateThenPoll(ctx context.Context, id ConfigurationId, input Configuration) error

UpdateThenPoll performs Update then polls until it's completed

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type FlexibleServerId

type FlexibleServerId struct {
	SubscriptionId     string
	ResourceGroupName  string
	FlexibleServerName string
}

FlexibleServerId is a struct representing the Resource ID for a Flexible Server

func NewFlexibleServerID

func NewFlexibleServerID(subscriptionId string, resourceGroupName string, flexibleServerName string) FlexibleServerId

NewFlexibleServerID returns a new FlexibleServerId struct

func ParseFlexibleServerID

func ParseFlexibleServerID(input string) (*FlexibleServerId, error)

ParseFlexibleServerID parses 'input' into a FlexibleServerId

func ParseFlexibleServerIDInsensitively

func ParseFlexibleServerIDInsensitively(input string) (*FlexibleServerId, error)

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

func (FlexibleServerId) ID

func (id FlexibleServerId) ID() string

ID returns the formatted Flexible Server ID

func (FlexibleServerId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Flexible Server ID

func (FlexibleServerId) String

func (id FlexibleServerId) String() string

String returns a human-readable description of this Flexible Server ID

type GetOperationResponse

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

type IsConfigPendingRestart

type IsConfigPendingRestart string
const (
	IsConfigPendingRestartFalse IsConfigPendingRestart = "False"
	IsConfigPendingRestartTrue  IsConfigPendingRestart = "True"
)

func (*IsConfigPendingRestart) UnmarshalJSON added in v0.20230725.1205316

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

type IsDynamicConfig

type IsDynamicConfig string
const (
	IsDynamicConfigFalse IsDynamicConfig = "False"
	IsDynamicConfigTrue  IsDynamicConfig = "True"
)

func (*IsDynamicConfig) UnmarshalJSON added in v0.20230725.1205316

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

type IsReadOnly

type IsReadOnly string
const (
	IsReadOnlyFalse IsReadOnly = "False"
	IsReadOnlyTrue  IsReadOnly = "True"
)

func (*IsReadOnly) UnmarshalJSON added in v0.20230725.1205316

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

type ListByServerCompleteResult

type ListByServerCompleteResult struct {
	Items []Configuration
}

type ListByServerOperationOptions

type ListByServerOperationOptions struct {
	Keyword  *string
	Page     *int64
	PageSize *int64
	Tags     *string
}

func DefaultListByServerOperationOptions

func DefaultListByServerOperationOptions() ListByServerOperationOptions

func (ListByServerOperationOptions) ToHeaders added in v0.20230725.1205316

func (ListByServerOperationOptions) ToOData added in v0.20230725.1205316

func (ListByServerOperationOptions) ToQuery added in v0.20230725.1205316

type ListByServerOperationResponse

type ListByServerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Configuration
}

type ResetAllToDefault

type ResetAllToDefault string
const (
	ResetAllToDefaultFalse ResetAllToDefault = "False"
	ResetAllToDefaultTrue  ResetAllToDefault = "True"
)

func (*ResetAllToDefault) UnmarshalJSON added in v0.20230725.1205316

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

type UpdateOperationResponse

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

Jump to

Keyboard shortcuts

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