servergroups

package
v0.20240110.1151535 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := servergroups.NewServerGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServerGroupsClient.CheckNameAvailability

ctx := context.TODO()
id := servergroups.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

payload := servergroups.NameAvailabilityRequest{
	// ...
}


read, err := client.CheckNameAvailability(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ServerGroupsClient.CreateOrUpdate

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

payload := servergroups.ServerGroup{
	// ...
}


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

Example Usage: ServerGroupsClient.Delete

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

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

Example Usage: ServerGroupsClient.Get

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

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: ServerGroupsClient.List

ctx := context.TODO()
id := servergroups.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: ServerGroupsClient.ListByResourceGroup

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

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

Example Usage: ServerGroupsClient.Update

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

payload := servergroups.ServerGroupForUpdate{
	// ...
}


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 PossibleValuesForCheckNameAvailabilityResourceType 

func PossibleValuesForCheckNameAvailabilityResourceType() []string

func PossibleValuesForCitusVersion 

func PossibleValuesForCitusVersion() []string

func PossibleValuesForCreateMode 

func PossibleValuesForCreateMode() []string

func PossibleValuesForPostgreSQLVersion 

func PossibleValuesForPostgreSQLVersion() []string

func PossibleValuesForResourceProviderType 

func PossibleValuesForResourceProviderType() []string

func PossibleValuesForServerEdition 

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

Types

type CheckNameAvailabilityOperationResponse 

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NameAvailability
}

type CheckNameAvailabilityResourceType 

type CheckNameAvailabilityResourceType string
const (
	CheckNameAvailabilityResourceTypeMicrosoftPointDBforPostgreSQLServerGroupsvTwo CheckNameAvailabilityResourceType = "Microsoft.DBforPostgreSQL/serverGroupsv2"
)

func (*CheckNameAvailabilityResourceType) UnmarshalJSON added in v0.20230809.1081239 

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

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 CreateMode 

type CreateMode string
const (
	CreateModeDefault            CreateMode = "Default"
	CreateModePointInTimeRestore CreateMode = "PointInTimeRestore"
	CreateModeReadReplica        CreateMode = "ReadReplica"
)

func (*CreateMode) UnmarshalJSON added in v0.20230809.1081239 

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

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationResponse 

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

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ServerGroup
}

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ServerGroup
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ServerGroup
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ServerGroup
}

type MaintenanceWindow 

type MaintenanceWindow struct {
	CustomWindow *string `json:"customWindow,omitempty"`
	DayOfWeek    *int64  `json:"dayOfWeek,omitempty"`
	StartHour    *int64  `json:"startHour,omitempty"`
	StartMinute  *int64  `json:"startMinute,omitempty"`
}

type NameAvailability 

type NameAvailability struct {
	Message       *string `json:"message,omitempty"`
	Name          *string `json:"name,omitempty"`
	NameAvailable *bool   `json:"nameAvailable,omitempty"`
	Type          *string `json:"type,omitempty"`
}

type NameAvailabilityRequest 

type NameAvailabilityRequest struct {
	Name string                            `json:"name"`
	Type CheckNameAvailabilityResourceType `json:"type"`
}

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 ResourceProviderType 

type ResourceProviderType string
const (
	ResourceProviderTypeMarlin ResourceProviderType = "Marlin"
	ResourceProviderTypeMeru   ResourceProviderType = "Meru"
)

func (*ResourceProviderType) UnmarshalJSON added in v0.20230809.1081239 

func (s *ResourceProviderType) 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 ServerGroup 

type ServerGroup struct {
	Id         *string                `json:"id,omitempty"`
	Location   string                 `json:"location"`
	Name       *string                `json:"name,omitempty"`
	Properties *ServerGroupProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type ServerGroupForUpdate 

type ServerGroupForUpdate struct {
	Location   *string                         `json:"location,omitempty"`
	Properties *ServerGroupPropertiesForUpdate `json:"properties,omitempty"`
	Tags       *map[string]string              `json:"tags,omitempty"`
}

type ServerGroupOperationPredicate 

type ServerGroupOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ServerGroupOperationPredicate) Matches 

func (p ServerGroupOperationPredicate) Matches(input ServerGroup) bool

type ServerGroupProperties 

type ServerGroupProperties struct {
	AdministratorLogin         *string                                        `json:"administratorLogin,omitempty"`
	AdministratorLoginPassword *string                                        `json:"administratorLoginPassword,omitempty"`
	AvailabilityZone           *string                                        `json:"availabilityZone,omitempty"`
	BackupRetentionDays        *int64                                         `json:"backupRetentionDays,omitempty"`
	CitusVersion               *CitusVersion                                  `json:"citusVersion,omitempty"`
	CreateMode                 *CreateMode                                    `json:"createMode,omitempty"`
	DelegatedSubnetArguments   *ServerGroupPropertiesDelegatedSubnetArguments `json:"delegatedSubnetArguments,omitempty"`
	EarliestRestoreTime        *string                                        `json:"earliestRestoreTime,omitempty"`
	EnableMx                   *bool                                          `json:"enableMx,omitempty"`
	EnableShardsOnCoordinator  *bool                                          `json:"enableShardsOnCoordinator,omitempty"`
	EnableZfs                  *bool                                          `json:"enableZfs,omitempty"`
	MaintenanceWindow          *MaintenanceWindow                             `json:"maintenanceWindow,omitempty"`
	PointInTimeUTC             *string                                        `json:"pointInTimeUTC,omitempty"`
	PostgresqlVersion          *PostgreSQLVersion                             `json:"postgresqlVersion,omitempty"`
	PrivateDnsZoneArguments    *ServerGroupPropertiesPrivateDnsZoneArguments  `json:"privateDnsZoneArguments,omitempty"`
	ReadReplicas               *[]string                                      `json:"readReplicas,omitempty"`
	ResourceProviderType       *ResourceProviderType                          `json:"resourceProviderType,omitempty"`
	ServerRoleGroups           *[]ServerRoleGroup                             `json:"serverRoleGroups,omitempty"`
	SourceLocation             *string                                        `json:"sourceLocation,omitempty"`
	SourceResourceGroupName    *string                                        `json:"sourceResourceGroupName,omitempty"`
	SourceServerGroup          *string                                        `json:"sourceServerGroup,omitempty"`
	SourceServerGroupName      *string                                        `json:"sourceServerGroupName,omitempty"`
	SourceSubscriptionId       *string                                        `json:"sourceSubscriptionId,omitempty"`
	StandbyAvailabilityZone    *string                                        `json:"standbyAvailabilityZone,omitempty"`
	State                      *ServerState                                   `json:"state,omitempty"`
}

func (*ServerGroupProperties) GetEarliestRestoreTimeAsTime 

func (o *ServerGroupProperties) GetEarliestRestoreTimeAsTime() (*time.Time, error)

func (*ServerGroupProperties) GetPointInTimeUTCAsTime 

func (o *ServerGroupProperties) GetPointInTimeUTCAsTime() (*time.Time, error)

func (*ServerGroupProperties) SetEarliestRestoreTimeAsTime 

func (o *ServerGroupProperties) SetEarliestRestoreTimeAsTime(input time.Time)

func (*ServerGroupProperties) SetPointInTimeUTCAsTime 

func (o *ServerGroupProperties) SetPointInTimeUTCAsTime(input time.Time)

type ServerGroupPropertiesDelegatedSubnetArguments 

type ServerGroupPropertiesDelegatedSubnetArguments struct {
	SubnetArmResourceId *string `json:"subnetArmResourceId,omitempty"`
}

type ServerGroupPropertiesForUpdate 

type ServerGroupPropertiesForUpdate struct {
	AdministratorLoginPassword *string            `json:"administratorLoginPassword,omitempty"`
	AvailabilityZone           *string            `json:"availabilityZone,omitempty"`
	BackupRetentionDays        *int64             `json:"backupRetentionDays,omitempty"`
	CitusVersion               *CitusVersion      `json:"citusVersion,omitempty"`
	EnableShardsOnCoordinator  *bool              `json:"enableShardsOnCoordinator,omitempty"`
	MaintenanceWindow          *MaintenanceWindow `json:"maintenanceWindow,omitempty"`
	PostgresqlVersion          *PostgreSQLVersion `json:"postgresqlVersion,omitempty"`
	ServerRoleGroups           *[]ServerRoleGroup `json:"serverRoleGroups,omitempty"`
	StandbyAvailabilityZone    *string            `json:"standbyAvailabilityZone,omitempty"`
}

type ServerGroupPropertiesPrivateDnsZoneArguments 

type ServerGroupPropertiesPrivateDnsZoneArguments struct {
	PrivateDnsZoneArmResourceId *string `json:"privateDnsZoneArmResourceId,omitempty"`
}

type ServerGroupsClient 

type ServerGroupsClient struct {
	Client *resourcemanager.Client
}

func NewServerGroupsClientWithBaseURI 

func NewServerGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*ServerGroupsClient, error)

func (ServerGroupsClient) CheckNameAvailability 

func (c ServerGroupsClient) CheckNameAvailability(ctx context.Context, id commonids.SubscriptionId, input NameAvailabilityRequest) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

func (ServerGroupsClient) CreateOrUpdate 

func (c ServerGroupsClient) CreateOrUpdate(ctx context.Context, id ServerGroupsv2Id, input ServerGroup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ServerGroupsClient) CreateOrUpdateThenPoll 

func (c ServerGroupsClient) CreateOrUpdateThenPoll(ctx context.Context, id ServerGroupsv2Id, input ServerGroup) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ServerGroupsClient) Delete 

func (c ServerGroupsClient) Delete(ctx context.Context, id ServerGroupsv2Id) (result DeleteOperationResponse, err error)

Delete ...

func (ServerGroupsClient) DeleteThenPoll 

func (c ServerGroupsClient) DeleteThenPoll(ctx context.Context, id ServerGroupsv2Id) error

DeleteThenPoll performs Delete then polls until it's completed

func (ServerGroupsClient) Get 

func (c ServerGroupsClient) Get(ctx context.Context, id ServerGroupsv2Id) (result GetOperationResponse, err error)

Get ...

func (ServerGroupsClient) List 

func (c ServerGroupsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (ServerGroupsClient) ListByResourceGroup 

func (c ServerGroupsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ServerGroupsClient) ListByResourceGroupComplete 

func (c ServerGroupsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (ServerGroupsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c ServerGroupsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ServerGroupOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ServerGroupsClient) ListComplete 

func (c ServerGroupsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ServerGroupsClient) ListCompleteMatchingPredicate 

func (c ServerGroupsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ServerGroupOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ServerGroupsClient) Update 

func (c ServerGroupsClient) Update(ctx context.Context, id ServerGroupsv2Id, input ServerGroupForUpdate) (result UpdateOperationResponse, err error)

Update ...

func (ServerGroupsClient) UpdateThenPoll 

func (c ServerGroupsClient) UpdateThenPoll(ctx context.Context, id ServerGroupsv2Id, input ServerGroupForUpdate) error

UpdateThenPoll performs Update then polls until it's completed

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 ServerNameItem 

type ServerNameItem struct {
	FullyQualifiedDomainName *string `json:"fullyQualifiedDomainName,omitempty"`
	Name                     *string `json:"name,omitempty"`
}

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 ServerRoleGroup 

type ServerRoleGroup struct {
	EnableHa         *bool             `json:"enableHa,omitempty"`
	EnablePublicIP   *bool             `json:"enablePublicIp,omitempty"`
	Name             *string           `json:"name,omitempty"`
	Role             *ServerRole       `json:"role,omitempty"`
	ServerCount      *int64            `json:"serverCount,omitempty"`
	ServerEdition    *ServerEdition    `json:"serverEdition,omitempty"`
	ServerNames      *[]ServerNameItem `json:"serverNames,omitempty"`
	StorageQuotaInMb *int64            `json:"storageQuotaInMb,omitempty"`
	VCores           *int64            `json:"vCores,omitempty"`
}

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