serverrestart

README

github.com/hashicorp/go-azure-sdk/resource-manager/postgresql/2023-03-01-preview/serverrestart Documentation

The serverrestart SDK allows for interaction with the Azure Resource Manager Service postgresql (API Version 2023-03-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/postgresql/2023-03-01-preview/serverrestart"

Client Initialization

client := serverrestart.NewServerRestartClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServerRestartClient.ServersRestart

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

payload := serverrestart.RestartParameter{
	// ...
}


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

Documentation

Index

• func PossibleValuesForFailoverMode() []string
• func ValidateFlexibleServerID(input interface{}, key string) (warnings []string, errors []error)
• type FailoverMode
  • func (s *FailoverMode) UnmarshalJSON(bytes []byte) error
• type FlexibleServerId
  • func NewFlexibleServerID(subscriptionId string, resourceGroupName string, flexibleServerName string) FlexibleServerId
  • func ParseFlexibleServerID(input string) (*FlexibleServerId, error)
  • func ParseFlexibleServerIDInsensitively(input string) (*FlexibleServerId, error)
  • func (id *FlexibleServerId) FromParseResult(input resourceids.ParseResult) error
  • func (id FlexibleServerId) ID() string
  • func (id FlexibleServerId) Segments() []resourceids.Segment
  • func (id FlexibleServerId) String() string
• type RestartParameter
• type ServerRestartClient
  • func NewServerRestartClientWithBaseURI(sdkApi sdkEnv.Api) (*ServerRestartClient, error)
  • func (c ServerRestartClient) ServersRestart(ctx context.Context, id FlexibleServerId, input RestartParameter) (result ServersRestartOperationResponse, err error)
  • func (c ServerRestartClient) ServersRestartThenPoll(ctx context.Context, id FlexibleServerId, input RestartParameter) error
• type ServersRestartOperationResponse

Functions

func PossibleValuesForFailoverMode

func PossibleValuesForFailoverMode() []string

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 FailoverMode

type FailoverMode string

const (
	FailoverModeForcedFailover    FailoverMode = "ForcedFailover"
	FailoverModeForcedSwitchover  FailoverMode = "ForcedSwitchover"
	FailoverModePlannedFailover   FailoverMode = "PlannedFailover"
	FailoverModePlannedSwitchover FailoverMode = "PlannedSwitchover"
)

func (*FailoverMode) UnmarshalJSON

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

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

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

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 RestartParameter

type RestartParameter struct {
	FailoverMode        *FailoverMode `json:"failoverMode,omitempty"`
	RestartWithFailover *bool         `json:"restartWithFailover,omitempty"`
}

type ServerRestartClient

type ServerRestartClient struct {
	Client *resourcemanager.Client
}

func NewServerRestartClientWithBaseURI

func NewServerRestartClientWithBaseURI(sdkApi sdkEnv.Api) (*ServerRestartClient, error)

func (ServerRestartClient) ServersRestart

func (c ServerRestartClient) ServersRestart(ctx context.Context, id FlexibleServerId, input RestartParameter) (result ServersRestartOperationResponse, err error)

ServersRestart ...

func (ServerRestartClient) ServersRestartThenPoll

func (c ServerRestartClient) ServersRestartThenPoll(ctx context.Context, id FlexibleServerId, input RestartParameter) error

ServersRestartThenPoll performs ServersRestart then polls until it's completed

type ServersRestartOperationResponse

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