servers

package
v0.20231113.1102643 Latest Latest
Warning

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

 Go to latest Published: Nov 13, 2023 License: MPL-2.0 Imports: 11 Imported by: 0

README

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

The servers 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/servers"

Client Initialization

client := servers.NewServersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServersClient.Get

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

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: ServersClient.ListByServerGroup

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

read, err := client.ListByServerGroup(ctx, id)
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 PossibleValuesForCitusVersion 

func PossibleValuesForCitusVersion() []string

func PossibleValuesForPostgreSQLVersion 

func PossibleValuesForPostgreSQLVersion() []string

func PossibleValuesForServerEdition 

func PossibleValuesForServerEdition() []string

func PossibleValuesForServerHaState 

func PossibleValuesForServerHaState() []string

func PossibleValuesForServerRole 

func PossibleValuesForServerRole() []string

func PossibleValuesForServerState 

func PossibleValuesForServerState() []string

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 CitusVersion 

type CitusVersion string
const (
	CitusVersionEightPointThree CitusVersion = "8.3"
	CitusVersionNinePointFive   CitusVersion = "9.5"
	CitusVersionNinePointFour   CitusVersion = "9.4"
	CitusVersionNinePointOne    CitusVersion = "9.1"
	CitusVersionNinePointThree  CitusVersion = "9.3"
	CitusVersionNinePointTwo    CitusVersion = "9.2"
	CitusVersionNinePointZero   CitusVersion = "9.0"
)

func (*CitusVersion) UnmarshalJSON added in v0.20230809.1081239 

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

type GetOperationResponse 

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

type ListByServerGroupOperationResponse 

type ListByServerGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ServerGroupServerListResult
}

type PostgreSQLVersion 

type PostgreSQLVersion string
const (
	PostgreSQLVersionOneOne PostgreSQLVersion = "11"
	PostgreSQLVersionOneTwo PostgreSQLVersion = "12"
)

func (*PostgreSQLVersion) UnmarshalJSON added in v0.20230809.1081239 

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

type ServerEdition 

type ServerEdition string
const (
	ServerEditionGeneralPurpose  ServerEdition = "GeneralPurpose"
	ServerEditionMemoryOptimized ServerEdition = "MemoryOptimized"
)

func (*ServerEdition) UnmarshalJSON added in v0.20230809.1081239 

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

type ServerGroupServer 

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

type ServerGroupServerListResult 

type ServerGroupServerListResult struct {
	Value *[]ServerGroupServer `json:"value,omitempty"`
}

type ServerGroupServerProperties 

type ServerGroupServerProperties struct {
	AdministratorLogin       *string            `json:"administratorLogin,omitempty"`
	AvailabilityZone         *string            `json:"availabilityZone,omitempty"`
	CitusVersion             *CitusVersion      `json:"citusVersion,omitempty"`
	EnableHa                 *bool              `json:"enableHa,omitempty"`
	EnablePublicIP           *bool              `json:"enablePublicIp,omitempty"`
	FullyQualifiedDomainName *string            `json:"fullyQualifiedDomainName,omitempty"`
	HaState                  *ServerHaState     `json:"haState,omitempty"`
	PostgresqlVersion        *PostgreSQLVersion `json:"postgresqlVersion,omitempty"`
	Role                     *ServerRole        `json:"role,omitempty"`
	ServerEdition            *ServerEdition     `json:"serverEdition,omitempty"`
	StandbyAvailabilityZone  *string            `json:"standbyAvailabilityZone,omitempty"`
	State                    *ServerState       `json:"state,omitempty"`
	StorageQuotaInMb         *int64             `json:"storageQuotaInMb,omitempty"`
	VCores                   *int64             `json:"vCores,omitempty"`
}

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) 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 ServerHaState 

type ServerHaState string
const (
	ServerHaStateCreatingStandby ServerHaState = "CreatingStandby"
	ServerHaStateFailingOver     ServerHaState = "FailingOver"
	ServerHaStateHealthy         ServerHaState = "Healthy"
	ServerHaStateNotEnabled      ServerHaState = "NotEnabled"
	ServerHaStateNotSync         ServerHaState = "NotSync"
	ServerHaStateRemovingStandby ServerHaState = "RemovingStandby"
	ServerHaStateReplicatingData ServerHaState = "ReplicatingData"
)

func (*ServerHaState) UnmarshalJSON added in v0.20230809.1081239 

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

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) 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 ServerState 

type ServerState string
const (
	ServerStateDisabled     ServerState = "Disabled"
	ServerStateDropping     ServerState = "Dropping"
	ServerStateProvisioning ServerState = "Provisioning"
	ServerStateReady        ServerState = "Ready"
	ServerStateStarting     ServerState = "Starting"
	ServerStateStopped      ServerState = "Stopped"
	ServerStateStopping     ServerState = "Stopping"
	ServerStateUpdating     ServerState = "Updating"
)

func (*ServerState) UnmarshalJSON added in v0.20230809.1081239 

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

type ServersClient 

type ServersClient struct {
	Client *resourcemanager.Client
}

func NewServersClientWithBaseURI 

func NewServersClientWithBaseURI(sdkApi sdkEnv.Api) (*ServersClient, error)

func (ServersClient) Get 

func (c ServersClient) Get(ctx context.Context, id ServerId) (result GetOperationResponse, err error)

Get ...

func (ServersClient) ListByServerGroup 

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

ListByServerGroup ...

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.