servers

package
v0.20231214.1140441 Latest Latest
Warning

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

 Go to latest Published: Dec 14, 2023 License: MPL-2.0 Imports: 15 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/mariadb/2018-06-01-preview/servers Documentation

The servers SDK allows for interaction with the Azure Resource Manager Service mariadb (API Version 2018-06-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/mariadb/2018-06-01-preview/servers"

Client Initialization

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

Example Usage: ServersClient.Create

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

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


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

Example Usage: ServersClient.Delete

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

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

Example Usage: ServersClient.Get

ctx := context.TODO()
id := servers.NewServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "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.List

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

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

Example Usage: ServersClient.ListByResourceGroup

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

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

Example Usage: ServersClient.Update

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

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


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 PossibleValuesForCreateMode 

func PossibleValuesForCreateMode() []string

func PossibleValuesForGeoRedundantBackup 

func PossibleValuesForGeoRedundantBackup() []string

func PossibleValuesForMinimalTlsVersionEnum 

func PossibleValuesForMinimalTlsVersionEnum() []string

func PossibleValuesForServerState 

func PossibleValuesForServerState() []string

func PossibleValuesForServerVersion 

func PossibleValuesForServerVersion() []string

func PossibleValuesForSkuTier 

func PossibleValuesForSkuTier() []string

func PossibleValuesForSslEnforcementEnum 

func PossibleValuesForSslEnforcementEnum() []string

func PossibleValuesForStorageAutogrow 

func PossibleValuesForStorageAutogrow() []string

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 CreateMode 

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

func (*CreateMode) UnmarshalJSON added in v0.20230713.1092427 

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

type CreateOperationResponse 

type CreateOperationResponse 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 GeoRedundantBackup 

type GeoRedundantBackup string
const (
	GeoRedundantBackupDisabled GeoRedundantBackup = "Disabled"
	GeoRedundantBackupEnabled  GeoRedundantBackup = "Enabled"
)

func (*GeoRedundantBackup) UnmarshalJSON added in v0.20230713.1092427 

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

type GetOperationResponse 

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

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ServerListResult
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ServerListResult
}

type MinimalTlsVersionEnum 

type MinimalTlsVersionEnum string
const (
	MinimalTlsVersionEnumTLSEnforcementDisabled MinimalTlsVersionEnum = "TLSEnforcementDisabled"
	MinimalTlsVersionEnumTLSOneOne              MinimalTlsVersionEnum = "TLS1_1"
	MinimalTlsVersionEnumTLSOneTwo              MinimalTlsVersionEnum = "TLS1_2"
	MinimalTlsVersionEnumTLSOneZero             MinimalTlsVersionEnum = "TLS1_0"
)

func (*MinimalTlsVersionEnum) UnmarshalJSON added in v0.20230713.1092427 

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

type RawServerPropertiesForCreateImpl added in v0.20230807.1063129 

type RawServerPropertiesForCreateImpl struct {
	Type   string
	Values map[string]interface{}
}

RawServerPropertiesForCreateImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type Server 

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

type ServerForCreate 

type ServerForCreate struct {
	Location   string                    `json:"location"`
	Properties ServerPropertiesForCreate `json:"properties"`
	Sku        *Sku                      `json:"sku,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
}

func (*ServerForCreate) UnmarshalJSON 

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

type ServerId 

type ServerId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
}

ServerId is a struct representing the Resource ID for a Server

func NewServerID 

func NewServerID(subscriptionId string, resourceGroupName 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 ServerListResult 

type ServerListResult struct {
	Value *[]Server `json:"value,omitempty"`
}

type ServerProperties 

type ServerProperties struct {
	AdministratorLogin       *string                `json:"administratorLogin,omitempty"`
	EarliestRestoreDate      *string                `json:"earliestRestoreDate,omitempty"`
	FullyQualifiedDomainName *string                `json:"fullyQualifiedDomainName,omitempty"`
	MasterServerId           *string                `json:"masterServerId,omitempty"`
	MinimalTlsVersion        *MinimalTlsVersionEnum `json:"minimalTlsVersion,omitempty"`
	ReplicaCapacity          *int64                 `json:"replicaCapacity,omitempty"`
	ReplicationRole          *string                `json:"replicationRole,omitempty"`
	SslEnforcement           *SslEnforcementEnum    `json:"sslEnforcement,omitempty"`
	StorageProfile           *StorageProfile        `json:"storageProfile,omitempty"`
	UserVisibleState         *ServerState           `json:"userVisibleState,omitempty"`
	Version                  *ServerVersion         `json:"version,omitempty"`
}

func (*ServerProperties) GetEarliestRestoreDateAsTime 

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

func (*ServerProperties) SetEarliestRestoreDateAsTime 

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

type ServerPropertiesForCreate 

type ServerPropertiesForCreate interface {
}

type ServerPropertiesForDefaultCreate 

type ServerPropertiesForDefaultCreate struct {
	AdministratorLogin         string `json:"administratorLogin"`
	AdministratorLoginPassword string `json:"administratorLoginPassword"`

	// Fields inherited from ServerPropertiesForCreate
	MinimalTlsVersion *MinimalTlsVersionEnum `json:"minimalTlsVersion,omitempty"`
	SslEnforcement    *SslEnforcementEnum    `json:"sslEnforcement,omitempty"`
	StorageProfile    *StorageProfile        `json:"storageProfile,omitempty"`
	Version           *ServerVersion         `json:"version,omitempty"`
}

func (ServerPropertiesForDefaultCreate) MarshalJSON 

func (s ServerPropertiesForDefaultCreate) MarshalJSON() ([]byte, error)

type ServerPropertiesForGeoRestore 

type ServerPropertiesForGeoRestore struct {
	SourceServerId string `json:"sourceServerId"`

	// Fields inherited from ServerPropertiesForCreate
	MinimalTlsVersion *MinimalTlsVersionEnum `json:"minimalTlsVersion,omitempty"`
	SslEnforcement    *SslEnforcementEnum    `json:"sslEnforcement,omitempty"`
	StorageProfile    *StorageProfile        `json:"storageProfile,omitempty"`
	Version           *ServerVersion         `json:"version,omitempty"`
}

func (ServerPropertiesForGeoRestore) MarshalJSON 

func (s ServerPropertiesForGeoRestore) MarshalJSON() ([]byte, error)

type ServerPropertiesForReplica 

type ServerPropertiesForReplica struct {
	SourceServerId string `json:"sourceServerId"`

	// Fields inherited from ServerPropertiesForCreate
	MinimalTlsVersion *MinimalTlsVersionEnum `json:"minimalTlsVersion,omitempty"`
	SslEnforcement    *SslEnforcementEnum    `json:"sslEnforcement,omitempty"`
	StorageProfile    *StorageProfile        `json:"storageProfile,omitempty"`
	Version           *ServerVersion         `json:"version,omitempty"`
}

func (ServerPropertiesForReplica) MarshalJSON 

func (s ServerPropertiesForReplica) MarshalJSON() ([]byte, error)

type ServerPropertiesForRestore 

type ServerPropertiesForRestore struct {
	RestorePointInTime string `json:"restorePointInTime"`
	SourceServerId     string `json:"sourceServerId"`

	// Fields inherited from ServerPropertiesForCreate
	MinimalTlsVersion *MinimalTlsVersionEnum `json:"minimalTlsVersion,omitempty"`
	SslEnforcement    *SslEnforcementEnum    `json:"sslEnforcement,omitempty"`
	StorageProfile    *StorageProfile        `json:"storageProfile,omitempty"`
	Version           *ServerVersion         `json:"version,omitempty"`
}

func (ServerPropertiesForRestore) MarshalJSON 

func (s ServerPropertiesForRestore) MarshalJSON() ([]byte, error)

type ServerState 

type ServerState string
const (
	ServerStateDisabled ServerState = "Disabled"
	ServerStateDropping ServerState = "Dropping"
	ServerStateReady    ServerState = "Ready"
)

func (*ServerState) UnmarshalJSON added in v0.20230713.1092427 

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

type ServerUpdateParameters 

type ServerUpdateParameters struct {
	Properties *ServerUpdateParametersProperties `json:"properties,omitempty"`
	Sku        *Sku                              `json:"sku,omitempty"`
	Tags       *map[string]string                `json:"tags,omitempty"`
}

type ServerUpdateParametersProperties 

type ServerUpdateParametersProperties struct {
	AdministratorLoginPassword *string                `json:"administratorLoginPassword,omitempty"`
	MinimalTlsVersion          *MinimalTlsVersionEnum `json:"minimalTlsVersion,omitempty"`
	ReplicationRole            *string                `json:"replicationRole,omitempty"`
	SslEnforcement             *SslEnforcementEnum    `json:"sslEnforcement,omitempty"`
	StorageProfile             *StorageProfile        `json:"storageProfile,omitempty"`
	Version                    *ServerVersion         `json:"version,omitempty"`
}

type ServerVersion 

type ServerVersion string
const (
	ServerVersionOneZeroPointThree ServerVersion = "10.3"
	ServerVersionOneZeroPointTwo   ServerVersion = "10.2"
)

func (*ServerVersion) UnmarshalJSON added in v0.20230713.1092427 

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 ServerId, input ServerForCreate) (result CreateOperationResponse, err error)

Create ...

func (ServersClient) CreateThenPoll 

func (c ServersClient) CreateThenPoll(ctx context.Context, id ServerId, input ServerForCreate) error

CreateThenPoll performs Create then polls until it's completed

func (ServersClient) Delete 

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

Delete ...

func (ServersClient) DeleteThenPoll 

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

DeleteThenPoll performs Delete then polls until it's completed

func (ServersClient) Get 

func (c ServersClient) Get(ctx context.Context, id ServerId) (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) Update 

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

Update ...

func (ServersClient) UpdateThenPoll 

func (c ServersClient) UpdateThenPoll(ctx context.Context, id ServerId, input ServerUpdateParameters) error

UpdateThenPoll performs Update then polls until it's completed

type Sku 

type Sku struct {
	Capacity *int64   `json:"capacity,omitempty"`
	Family   *string  `json:"family,omitempty"`
	Name     string   `json:"name"`
	Size     *string  `json:"size,omitempty"`
	Tier     *SkuTier `json:"tier,omitempty"`
}

type SkuTier 

type SkuTier string
const (
	SkuTierBasic           SkuTier = "Basic"
	SkuTierGeneralPurpose  SkuTier = "GeneralPurpose"
	SkuTierMemoryOptimized SkuTier = "MemoryOptimized"
)

func (*SkuTier) UnmarshalJSON added in v0.20230713.1092427 

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

type SslEnforcementEnum 

type SslEnforcementEnum string
const (
	SslEnforcementEnumDisabled SslEnforcementEnum = "Disabled"
	SslEnforcementEnumEnabled  SslEnforcementEnum = "Enabled"
)

func (*SslEnforcementEnum) UnmarshalJSON added in v0.20230713.1092427 

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

type StorageAutogrow 

type StorageAutogrow string
const (
	StorageAutogrowDisabled StorageAutogrow = "Disabled"
	StorageAutogrowEnabled  StorageAutogrow = "Enabled"
)

func (*StorageAutogrow) UnmarshalJSON added in v0.20230713.1092427 

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

type StorageProfile 

type StorageProfile struct {
	BackupRetentionDays *int64              `json:"backupRetentionDays,omitempty"`
	GeoRedundantBackup  *GeoRedundantBackup `json:"geoRedundantBackup,omitempty"`
	StorageAutogrow     *StorageAutogrow    `json:"storageAutogrow,omitempty"`
	StorageMB           *int64              `json:"storageMB,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.