servers

package
v0.20231004.1141559 Latest Latest
Warning

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

 Go to latest Published: Oct 4, 2023 License: MPL-2.0 Imports: 16 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/postgresql/2022-12-01/servers Documentation

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

Client Initialization

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

Example Usage: ServersClient.Create

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

payload := servers.Server{
	// ...
}


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

Example Usage: ServersClient.Delete

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

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

Example Usage: ServersClient.Get

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

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

ctx := context.TODO()
id := servers.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: ServersClient.ListByResourceGroup

ctx := context.TODO()
id := servers.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: ServersClient.Update

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

payload := servers.ServerForUpdate{
	// ...
}


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 PossibleValuesForActiveDirectoryAuthEnum 

func PossibleValuesForActiveDirectoryAuthEnum() []string

func PossibleValuesForArmServerKeyType 

func PossibleValuesForArmServerKeyType() []string

func PossibleValuesForCreateMode 

func PossibleValuesForCreateMode() []string

func PossibleValuesForCreateModeForUpdate 

func PossibleValuesForCreateModeForUpdate() []string

func PossibleValuesForGeoRedundantBackupEnum 

func PossibleValuesForGeoRedundantBackupEnum() []string

func PossibleValuesForHighAvailabilityMode 

func PossibleValuesForHighAvailabilityMode() []string

func PossibleValuesForPasswordAuthEnum 

func PossibleValuesForPasswordAuthEnum() []string

func PossibleValuesForReplicationRole 

func PossibleValuesForReplicationRole() []string

func PossibleValuesForServerHAState 

func PossibleValuesForServerHAState() []string

func PossibleValuesForServerPublicNetworkAccessState 

func PossibleValuesForServerPublicNetworkAccessState() []string

func PossibleValuesForServerState 

func PossibleValuesForServerState() []string

func PossibleValuesForServerVersion 

func PossibleValuesForServerVersion() []string

func PossibleValuesForSkuTier 

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

type ActiveDirectoryAuthEnum string
const (
	ActiveDirectoryAuthEnumDisabled ActiveDirectoryAuthEnum = "Disabled"
	ActiveDirectoryAuthEnumEnabled  ActiveDirectoryAuthEnum = "Enabled"
)

func (*ActiveDirectoryAuthEnum) UnmarshalJSON added in v0.20230809.1081239 

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

type ArmServerKeyType 

type ArmServerKeyType string
const (
	ArmServerKeyTypeAzureKeyVault ArmServerKeyType = "AzureKeyVault"
	ArmServerKeyTypeSystemManaged ArmServerKeyType = "SystemManaged"
)

func (*ArmServerKeyType) UnmarshalJSON added in v0.20230809.1081239 

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

type AuthConfig 

type AuthConfig struct {
	ActiveDirectoryAuth *ActiveDirectoryAuthEnum `json:"activeDirectoryAuth,omitempty"`
	PasswordAuth        *PasswordAuthEnum        `json:"passwordAuth,omitempty"`
	TenantId            *string                  `json:"tenantId,omitempty"`
}

type Backup 

type Backup struct {
	BackupRetentionDays *int64                  `json:"backupRetentionDays,omitempty"`
	EarliestRestoreDate *string                 `json:"earliestRestoreDate,omitempty"`
	GeoRedundantBackup  *GeoRedundantBackupEnum `json:"geoRedundantBackup,omitempty"`
}

func (*Backup) GetEarliestRestoreDateAsTime 

func (o *Backup) GetEarliestRestoreDateAsTime() (*time.Time, error)

func (*Backup) SetEarliestRestoreDateAsTime 

func (o *Backup) SetEarliestRestoreDateAsTime(input time.Time)

type CreateMode 

type CreateMode string
const (
	CreateModeCreate             CreateMode = "Create"
	CreateModeDefault            CreateMode = "Default"
	CreateModeGeoRestore         CreateMode = "GeoRestore"
	CreateModePointInTimeRestore CreateMode = "PointInTimeRestore"
	CreateModeReplica            CreateMode = "Replica"
	CreateModeUpdate             CreateMode = "Update"
)

func (*CreateMode) UnmarshalJSON added in v0.20230809.1081239 

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

type CreateModeForUpdate 

type CreateModeForUpdate string
const (
	CreateModeForUpdateDefault CreateModeForUpdate = "Default"
	CreateModeForUpdateUpdate  CreateModeForUpdate = "Update"
)

func (*CreateModeForUpdate) UnmarshalJSON added in v0.20230809.1081239 

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

type CreateOperationResponse 

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

type DataEncryption 

type DataEncryption struct {
	PrimaryKeyURI                 *string           `json:"primaryKeyURI,omitempty"`
	PrimaryUserAssignedIdentityId *string           `json:"primaryUserAssignedIdentityId,omitempty"`
	Type                          *ArmServerKeyType `json:"type,omitempty"`
}

type DeleteOperationResponse 

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

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 GeoRedundantBackupEnum 

type GeoRedundantBackupEnum string
const (
	GeoRedundantBackupEnumDisabled GeoRedundantBackupEnum = "Disabled"
	GeoRedundantBackupEnumEnabled  GeoRedundantBackupEnum = "Enabled"
)

func (*GeoRedundantBackupEnum) UnmarshalJSON added in v0.20230809.1081239 

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

type GetOperationResponse 

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

type HighAvailability 

type HighAvailability struct {
	Mode                    *HighAvailabilityMode `json:"mode,omitempty"`
	StandbyAvailabilityZone *string               `json:"standbyAvailabilityZone,omitempty"`
	State                   *ServerHAState        `json:"state,omitempty"`
}

type HighAvailabilityMode 

type HighAvailabilityMode string
const (
	HighAvailabilityModeDisabled      HighAvailabilityMode = "Disabled"
	HighAvailabilityModeSameZone      HighAvailabilityMode = "SameZone"
	HighAvailabilityModeZoneRedundant HighAvailabilityMode = "ZoneRedundant"
)

func (*HighAvailabilityMode) UnmarshalJSON added in v0.20230809.1081239 

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

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	Items []Server
}

type ListByResourceGroupOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	Items []Server
}

type ListOperationResponse 

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

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 Network 

type Network struct {
	DelegatedSubnetResourceId   *string                         `json:"delegatedSubnetResourceId,omitempty"`
	PrivateDnsZoneArmResourceId *string                         `json:"privateDnsZoneArmResourceId,omitempty"`
	PublicNetworkAccess         *ServerPublicNetworkAccessState `json:"publicNetworkAccess,omitempty"`
}

type PasswordAuthEnum 

type PasswordAuthEnum string
const (
	PasswordAuthEnumDisabled PasswordAuthEnum = "Disabled"
	PasswordAuthEnumEnabled  PasswordAuthEnum = "Enabled"
)

func (*PasswordAuthEnum) UnmarshalJSON added in v0.20230809.1081239 

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

type ReplicationRole 

type ReplicationRole string
const (
	ReplicationRoleAsyncReplica    ReplicationRole = "AsyncReplica"
	ReplicationRoleGeoAsyncReplica ReplicationRole = "GeoAsyncReplica"
	ReplicationRoleNone            ReplicationRole = "None"
	ReplicationRolePrimary         ReplicationRole = "Primary"
)

func (*ReplicationRole) UnmarshalJSON added in v0.20230809.1081239 

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

type Server 

type Server struct {
	Id         *string                   `json:"id,omitempty"`
	Identity   *identity.UserAssignedMap `json:"identity,omitempty"`
	Location   string                    `json:"location"`
	Name       *string                   `json:"name,omitempty"`
	Properties *ServerProperties         `json:"properties,omitempty"`
	Sku        *Sku                      `json:"sku,omitempty"`
	SystemData *systemdata.SystemData    `json:"systemData,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type ServerForUpdate 

type ServerForUpdate struct {
	Identity   *identity.UserAssignedMap  `json:"identity,omitempty"`
	Properties *ServerPropertiesForUpdate `json:"properties,omitempty"`
	Sku        *Sku                       `json:"sku,omitempty"`
	Tags       *map[string]string         `json:"tags,omitempty"`
}

type ServerHAState 

type ServerHAState string
const (
	ServerHAStateCreatingStandby ServerHAState = "CreatingStandby"
	ServerHAStateFailingOver     ServerHAState = "FailingOver"
	ServerHAStateHealthy         ServerHAState = "Healthy"
	ServerHAStateNotEnabled      ServerHAState = "NotEnabled"
	ServerHAStateRemovingStandby ServerHAState = "RemovingStandby"
	ServerHAStateReplicatingData ServerHAState = "ReplicatingData"
)

func (*ServerHAState) UnmarshalJSON added in v0.20230809.1081239 

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

type ServerOperationPredicate 

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

func (ServerOperationPredicate) Matches 

func (p ServerOperationPredicate) Matches(input Server) bool

type ServerProperties 

type ServerProperties struct {
	AdministratorLogin         *string            `json:"administratorLogin,omitempty"`
	AdministratorLoginPassword *string            `json:"administratorLoginPassword,omitempty"`
	AuthConfig                 *AuthConfig        `json:"authConfig,omitempty"`
	AvailabilityZone           *string            `json:"availabilityZone,omitempty"`
	Backup                     *Backup            `json:"backup,omitempty"`
	CreateMode                 *CreateMode        `json:"createMode,omitempty"`
	DataEncryption             *DataEncryption    `json:"dataEncryption,omitempty"`
	FullyQualifiedDomainName   *string            `json:"fullyQualifiedDomainName,omitempty"`
	HighAvailability           *HighAvailability  `json:"highAvailability,omitempty"`
	MaintenanceWindow          *MaintenanceWindow `json:"maintenanceWindow,omitempty"`
	MinorVersion               *string            `json:"minorVersion,omitempty"`
	Network                    *Network           `json:"network,omitempty"`
	PointInTimeUTC             *string            `json:"pointInTimeUTC,omitempty"`
	ReplicaCapacity            *int64             `json:"replicaCapacity,omitempty"`
	ReplicationRole            *ReplicationRole   `json:"replicationRole,omitempty"`
	SourceServerResourceId     *string            `json:"sourceServerResourceId,omitempty"`
	State                      *ServerState       `json:"state,omitempty"`
	Storage                    *Storage           `json:"storage,omitempty"`
	Version                    *ServerVersion     `json:"version,omitempty"`
}

func (*ServerProperties) GetPointInTimeUTCAsTime 

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

func (*ServerProperties) SetPointInTimeUTCAsTime 

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

type ServerPropertiesForUpdate 

type ServerPropertiesForUpdate struct {
	AdministratorLoginPassword *string              `json:"administratorLoginPassword,omitempty"`
	AuthConfig                 *AuthConfig          `json:"authConfig,omitempty"`
	Backup                     *Backup              `json:"backup,omitempty"`
	CreateMode                 *CreateModeForUpdate `json:"createMode,omitempty"`
	DataEncryption             *DataEncryption      `json:"dataEncryption,omitempty"`
	HighAvailability           *HighAvailability    `json:"highAvailability,omitempty"`
	MaintenanceWindow          *MaintenanceWindow   `json:"maintenanceWindow,omitempty"`
	Network                    *Network             `json:"network,omitempty"`
	ReplicationRole            *ReplicationRole     `json:"replicationRole,omitempty"`
	Storage                    *Storage             `json:"storage,omitempty"`
	Version                    *ServerVersion       `json:"version,omitempty"`
}

type ServerPublicNetworkAccessState 

type ServerPublicNetworkAccessState string
const (
	ServerPublicNetworkAccessStateDisabled ServerPublicNetworkAccessState = "Disabled"
	ServerPublicNetworkAccessStateEnabled  ServerPublicNetworkAccessState = "Enabled"
)

func (*ServerPublicNetworkAccessState) UnmarshalJSON added in v0.20230809.1081239 

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

type ServerState 

type ServerState string
const (
	ServerStateDisabled ServerState = "Disabled"
	ServerStateDropping ServerState = "Dropping"
	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 ServerVersion 

type ServerVersion string
const (
	ServerVersionOneFour  ServerVersion = "14"
	ServerVersionOneOne   ServerVersion = "11"
	ServerVersionOneThree ServerVersion = "13"
	ServerVersionOneTwo   ServerVersion = "12"
)

func (*ServerVersion) UnmarshalJSON added in v0.20230809.1081239 

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

type ServersClient 

type ServersClient struct {
	Client *resourcemanager.Client
}

func NewServersClientWithBaseURI 

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

func (ServersClient) Create 

func (c ServersClient) Create(ctx context.Context, id FlexibleServerId, input Server) (result CreateOperationResponse, err error)

Create ...

func (ServersClient) CreateThenPoll 

func (c ServersClient) CreateThenPoll(ctx context.Context, id FlexibleServerId, input Server) error

CreateThenPoll performs Create then polls until it's completed

func (ServersClient) Delete 

func (c ServersClient) Delete(ctx context.Context, id FlexibleServerId) (result DeleteOperationResponse, err error)

Delete ...

func (ServersClient) DeleteThenPoll 

func (c ServersClient) DeleteThenPoll(ctx context.Context, id FlexibleServerId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ServersClient) Get 

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

Get ...

func (ServersClient) List 

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

List ...

func (ServersClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (ServersClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (ServersClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ServersClient) ListComplete 

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

ListComplete retrieves all the results into a single object

func (ServersClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ServersClient) Update 

func (c ServersClient) Update(ctx context.Context, id FlexibleServerId, input ServerForUpdate) (result UpdateOperationResponse, err error)

Update ...

func (ServersClient) UpdateThenPoll 

func (c ServersClient) UpdateThenPoll(ctx context.Context, id FlexibleServerId, input ServerForUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type Sku 

type Sku struct {
	Name string  `json:"name"`
	Tier SkuTier `json:"tier"`
}

type SkuTier 

type SkuTier string
const (
	SkuTierBurstable       SkuTier = "Burstable"
	SkuTierGeneralPurpose  SkuTier = "GeneralPurpose"
	SkuTierMemoryOptimized SkuTier = "MemoryOptimized"
)

func (*SkuTier) UnmarshalJSON added in v0.20230809.1081239 

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

type Storage 

type Storage struct {
	StorageSizeGB *int64 `json:"storageSizeGB,omitempty"`
}

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.