configurations

package
v0.20240118.1101651 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/postgresqlhsc/2020-10-05-privatepreview/configurations Documentation

The configurations SDK allows for interaction with the Azure Resource Manager Service postgresqlhsc (API Version 2020-10-05-privatepreview).

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/postgresqlhsc/2020-10-05-privatepreview/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", "serverGroupsv2Value", "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.NewServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverGroupsv2Value", "serverValue")

// 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.ListByServerGroup

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

// alternatively `client.ListByServerGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByServerGroupComplete(ctx, id)
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", "serverGroupsv2Value", "configurationValue")

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


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 PossibleValuesForConfigurationDataType 

func PossibleValuesForConfigurationDataType() []string

func PossibleValuesForServerRole 

func PossibleValuesForServerRole() []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 ValidateServerGroupsv2ID 

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

ValidateServerGroupsv2ID checks that 'input' can be parsed as a Server Groupsv 2 ID

func ValidateServerID 

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

ValidateServerID checks that 'input' can be parsed as a Server ID

Types

type ConfigurationDataType 

type ConfigurationDataType string
const (
	ConfigurationDataTypeBoolean     ConfigurationDataType = "Boolean"
	ConfigurationDataTypeEnumeration ConfigurationDataType = "Enumeration"
	ConfigurationDataTypeInteger     ConfigurationDataType = "Integer"
	ConfigurationDataTypeNumeric     ConfigurationDataType = "Numeric"
)

func (*ConfigurationDataType) UnmarshalJSON added in v0.20230809.1081239 

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

type ConfigurationId 

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

ConfigurationId is a struct representing the Resource ID for a Configuration

func NewConfigurationID 

func NewConfigurationID(subscriptionId string, resourceGroupName string, serverGroupsv2Name 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) FromParseResult added in v0.20231127.1171502 

func (id *ConfigurationId) FromParseResult(input resourceids.ParseResult) error

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 ConfigurationsClient 

type ConfigurationsClient struct {
	Client *resourcemanager.Client
}

func NewConfigurationsClientWithBaseURI 

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

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 ServerId) (result ListByServerOperationResponse, err error)

ListByServer ...

func (ConfigurationsClient) ListByServerComplete 

func (c ConfigurationsClient) ListByServerComplete(ctx context.Context, id ServerId) (ListByServerCompleteResult, error)

ListByServerComplete retrieves all the results into a single object

func (ConfigurationsClient) ListByServerCompleteMatchingPredicate 

func (c ConfigurationsClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id ServerId, predicate ServerConfigurationOperationPredicate) (result ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConfigurationsClient) ListByServerGroup 

func (c ConfigurationsClient) ListByServerGroup(ctx context.Context, id ServerGroupsv2Id) (result ListByServerGroupOperationResponse, err error)

ListByServerGroup ...

func (ConfigurationsClient) ListByServerGroupComplete 

func (c ConfigurationsClient) ListByServerGroupComplete(ctx context.Context, id ServerGroupsv2Id) (ListByServerGroupCompleteResult, error)

ListByServerGroupComplete retrieves all the results into a single object

func (ConfigurationsClient) ListByServerGroupCompleteMatchingPredicate 

func (c ConfigurationsClient) ListByServerGroupCompleteMatchingPredicate(ctx context.Context, id ServerGroupsv2Id, predicate ServerGroupConfigurationOperationPredicate) (result ListByServerGroupCompleteResult, err error)

ListByServerGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ConfigurationsClient) Update 

func (c ConfigurationsClient) Update(ctx context.Context, id ConfigurationId, input ServerGroupConfiguration) (result UpdateOperationResponse, err error)

Update ...

func (ConfigurationsClient) UpdateThenPoll 

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

UpdateThenPoll performs Update then polls until it's completed

type GetOperationResponse 

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

type ListByServerCompleteResult 

type ListByServerCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ServerConfiguration
}

type ListByServerGroupCompleteResult 

type ListByServerGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ServerGroupConfiguration
}

type ListByServerGroupOperationResponse 

type ListByServerGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ServerGroupConfiguration
}

type ListByServerOperationResponse 

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

type ServerConfiguration 

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

type ServerConfigurationOperationPredicate 

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

func (ServerConfigurationOperationPredicate) Matches 

func (p ServerConfigurationOperationPredicate) Matches(input ServerConfiguration) bool

type ServerConfigurationProperties 

type ServerConfigurationProperties struct {
	AllowedValues *string                `json:"allowedValues,omitempty"`
	DataType      *ConfigurationDataType `json:"dataType,omitempty"`
	DefaultValue  *string                `json:"defaultValue,omitempty"`
	Description   *string                `json:"description,omitempty"`
	Source        *string                `json:"source,omitempty"`
	Value         string                 `json:"value"`
}

type ServerGroupConfiguration 

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

type ServerGroupConfigurationOperationPredicate 

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

func (ServerGroupConfigurationOperationPredicate) Matches 

func (p ServerGroupConfigurationOperationPredicate) Matches(input ServerGroupConfiguration) bool

type ServerGroupConfigurationProperties 

type ServerGroupConfigurationProperties struct {
	AllowedValues                 *string                        `json:"allowedValues,omitempty"`
	DataType                      *ConfigurationDataType         `json:"dataType,omitempty"`
	Description                   *string                        `json:"description,omitempty"`
	ServerRoleGroupConfigurations []ServerRoleGroupConfiguration `json:"serverRoleGroupConfigurations"`
}

type ServerGroupsv2Id 

type ServerGroupsv2Id struct {
	SubscriptionId     string
	ResourceGroupName  string
	ServerGroupsv2Name string
}

ServerGroupsv2Id is a struct representing the Resource ID for a Server Groupsv 2

func NewServerGroupsv2ID 

func NewServerGroupsv2ID(subscriptionId string, resourceGroupName string, serverGroupsv2Name string) ServerGroupsv2Id

NewServerGroupsv2ID returns a new ServerGroupsv2Id struct

func ParseServerGroupsv2ID 

func ParseServerGroupsv2ID(input string) (*ServerGroupsv2Id, error)

ParseServerGroupsv2ID parses 'input' into a ServerGroupsv2Id

func ParseServerGroupsv2IDInsensitively 

func ParseServerGroupsv2IDInsensitively(input string) (*ServerGroupsv2Id, error)

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

func (*ServerGroupsv2Id) FromParseResult added in v0.20231127.1171502 

func (id *ServerGroupsv2Id) FromParseResult(input resourceids.ParseResult) error

func (ServerGroupsv2Id) ID 

func (id ServerGroupsv2Id) ID() string

ID returns the formatted Server Groupsv 2 ID

func (ServerGroupsv2Id) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Server Groupsv 2 ID

func (ServerGroupsv2Id) String 

func (id ServerGroupsv2Id) String() string

String returns a human-readable description of this Server Groupsv 2 ID

type ServerId 

type ServerId struct {
	SubscriptionId     string
	ResourceGroupName  string
	ServerGroupsv2Name string
	ServerName         string
}

ServerId is a struct representing the Resource ID for a Server

func NewServerID 

func NewServerID(subscriptionId string, resourceGroupName string, serverGroupsv2Name string, serverName string) ServerId

NewServerID returns a new ServerId struct

func ParseServerID 

func ParseServerID(input string) (*ServerId, error)

ParseServerID parses 'input' into a ServerId

func ParseServerIDInsensitively 

func ParseServerIDInsensitively(input string) (*ServerId, error)

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

func (*ServerId) FromParseResult added in v0.20231127.1171502 

func (id *ServerId) FromParseResult(input resourceids.ParseResult) error

func (ServerId) ID 

func (id ServerId) ID() string

ID returns the formatted Server ID

func (ServerId) Segments 

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

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

func (ServerId) String 

func (id ServerId) String() string

String returns a human-readable description of this Server ID

type ServerRole 

type ServerRole string
const (
	ServerRoleCoordinator ServerRole = "Coordinator"
	ServerRoleWorker      ServerRole = "Worker"
)

func (*ServerRole) UnmarshalJSON added in v0.20230809.1081239 

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

type ServerRoleGroupConfiguration 

type ServerRoleGroupConfiguration struct {
	DefaultValue *string    `json:"defaultValue,omitempty"`
	Role         ServerRole `json:"role"`
	Source       *string    `json:"source,omitempty"`
	Value        string     `json:"value"`
}

type UpdateOperationResponse 

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

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.