README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/postgresql/2022-12-01/configurations
Documentation
The configurations
SDK allows for interaction with the Azure Resource Manager Service postgresql
(API Version 2022-12-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/2022-12-01/configurations"
Client Initialization
client := configurations.NewConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
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)` can be used to do batched pagination
items, err := client.ListByServerComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: ConfigurationsClient.Put
ctx := context.TODO()
id := configurations.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue", "configurationValue")
payload := configurations.Configuration{
// ...
}
if err := client.PutThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: ConfigurationsClient.Update
ctx := context.TODO()
id := configurations.NewConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue", "configurationValue")
payload := configurations.ConfigurationForUpdate{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func PossibleValuesForConfigurationDataType() []string
- func ValidateConfigurationID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateFlexibleServerID(input interface{}, key string) (warnings []string, errors []error)
- type Configuration
- type ConfigurationDataType
- type ConfigurationForUpdate
- type ConfigurationId
- type ConfigurationOperationPredicate
- type ConfigurationProperties
- type ConfigurationsClient
- func (c ConfigurationsClient) Get(ctx context.Context, id ConfigurationId) (result GetOperationResponse, err error)
- func (c ConfigurationsClient) ListByServer(ctx context.Context, id FlexibleServerId) (resp ListByServerOperationResponse, err error)
- func (c ConfigurationsClient) ListByServerComplete(ctx context.Context, id FlexibleServerId) (ListByServerCompleteResult, error)
- func (c ConfigurationsClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id FlexibleServerId, ...) (resp ListByServerCompleteResult, err error)
- func (c ConfigurationsClient) Put(ctx context.Context, id ConfigurationId, input Configuration) (result PutOperationResponse, err error)
- func (c ConfigurationsClient) PutThenPoll(ctx context.Context, id ConfigurationId, input Configuration) error
- func (c ConfigurationsClient) Update(ctx context.Context, id ConfigurationId, input ConfigurationForUpdate) (result UpdateOperationResponse, err error)
- func (c ConfigurationsClient) UpdateThenPoll(ctx context.Context, id ConfigurationId, input ConfigurationForUpdate) error
- type FlexibleServerId
- type GetOperationResponse
- type ListByServerCompleteResult
- type ListByServerOperationResponse
- type PutOperationResponse
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForConfigurationDataType ¶
func PossibleValuesForConfigurationDataType() []string
func ValidateConfigurationID ¶
ValidateConfigurationID checks that 'input' can be parsed as a Configuration ID
func ValidateFlexibleServerID ¶
ValidateFlexibleServerID checks that 'input' can be parsed as a Flexible Server ID
Types ¶
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 ConfigurationDataType ¶
type ConfigurationDataType string
const ( ConfigurationDataTypeBoolean ConfigurationDataType = "Boolean" ConfigurationDataTypeEnumeration ConfigurationDataType = "Enumeration" ConfigurationDataTypeInteger ConfigurationDataType = "Integer" ConfigurationDataTypeNumeric ConfigurationDataType = "Numeric" )
type ConfigurationForUpdate ¶
type ConfigurationForUpdate struct {
Properties *ConfigurationProperties `json:"properties,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 ConfigurationOperationPredicate ¶
func (ConfigurationOperationPredicate) Matches ¶
func (p ConfigurationOperationPredicate) Matches(input Configuration) bool
type ConfigurationProperties ¶
type ConfigurationProperties struct { AllowedValues *string `json:"allowedValues,omitempty"` DataType *ConfigurationDataType `json:"dataType,omitempty"` DefaultValue *string `json:"defaultValue,omitempty"` Description *string `json:"description,omitempty"` DocumentationLink *string `json:"documentationLink,omitempty"` IsConfigPendingRestart *bool `json:"isConfigPendingRestart,omitempty"` IsDynamicConfig *bool `json:"isDynamicConfig,omitempty"` IsReadOnly *bool `json:"isReadOnly,omitempty"` Source *string `json:"source,omitempty"` Unit *string `json:"unit,omitempty"` Value *string `json:"value,omitempty"` }
type ConfigurationsClient ¶
type ConfigurationsClient struct { Client autorest.Client // contains filtered or unexported fields }
func NewConfigurationsClientWithBaseURI ¶
func NewConfigurationsClientWithBaseURI(endpoint string) ConfigurationsClient
func (ConfigurationsClient) Get ¶
func (c ConfigurationsClient) Get(ctx context.Context, id ConfigurationId) (result GetOperationResponse, err error)
Get ...
func (ConfigurationsClient) ListByServer ¶
func (c ConfigurationsClient) ListByServer(ctx context.Context, id FlexibleServerId) (resp ListByServerOperationResponse, err error)
ListByServer ...
func (ConfigurationsClient) ListByServerComplete ¶
func (c ConfigurationsClient) ListByServerComplete(ctx context.Context, id FlexibleServerId) (ListByServerCompleteResult, error)
ListByServerComplete retrieves all of the results into a single object
func (ConfigurationsClient) ListByServerCompleteMatchingPredicate ¶
func (c ConfigurationsClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id FlexibleServerId, predicate ConfigurationOperationPredicate) (resp ListByServerCompleteResult, err error)
ListByServerCompleteMatchingPredicate retrieves all of the results and then applied the predicate
func (ConfigurationsClient) Put ¶
func (c ConfigurationsClient) Put(ctx context.Context, id ConfigurationId, input Configuration) (result PutOperationResponse, err error)
Put ...
func (ConfigurationsClient) PutThenPoll ¶
func (c ConfigurationsClient) PutThenPoll(ctx context.Context, id ConfigurationId, input Configuration) error
PutThenPoll performs Put then polls until it's completed
func (ConfigurationsClient) Update ¶
func (c ConfigurationsClient) Update(ctx context.Context, id ConfigurationId, input ConfigurationForUpdate) (result UpdateOperationResponse, err error)
Update ...
func (ConfigurationsClient) UpdateThenPoll ¶
func (c ConfigurationsClient) UpdateThenPoll(ctx context.Context, id ConfigurationId, input ConfigurationForUpdate) error
UpdateThenPoll performs Update then polls until it's completed
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 Model *Configuration }
type ListByServerCompleteResult ¶
type ListByServerCompleteResult struct {
Items []Configuration
}
type ListByServerOperationResponse ¶
type ListByServerOperationResponse struct { HttpResponse *http.Response Model *[]Configuration // contains filtered or unexported fields }
func (ListByServerOperationResponse) HasMore ¶
func (r ListByServerOperationResponse) HasMore() bool
func (ListByServerOperationResponse) LoadMore ¶
func (r ListByServerOperationResponse) LoadMore(ctx context.Context) (resp ListByServerOperationResponse, err error)
type PutOperationResponse ¶
type PutOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type UpdateOperationResponse ¶
type UpdateOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }