availabilitygrouplisteners

package
v0.20241126.2320 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/sqlvirtualmachine/2023-10-01/availabilitygrouplisteners Documentation

The availabilitygrouplisteners SDK allows for interaction with Azure Resource Manager sqlvirtualmachine (API Version 2023-10-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/sqlvirtualmachine/2023-10-01/availabilitygrouplisteners"

Client Initialization

client := availabilitygrouplisteners.NewAvailabilityGroupListenersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AvailabilityGroupListenersClient.CreateOrUpdate

ctx := context.TODO()
id := availabilitygrouplisteners.NewAvailabilityGroupListenerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sqlVirtualMachineGroupName", "availabilityGroupListenerName")

payload := availabilitygrouplisteners.AvailabilityGroupListener{
	// ...
}


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

Example Usage: AvailabilityGroupListenersClient.Delete

ctx := context.TODO()
id := availabilitygrouplisteners.NewAvailabilityGroupListenerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sqlVirtualMachineGroupName", "availabilityGroupListenerName")

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

Example Usage: AvailabilityGroupListenersClient.Get

ctx := context.TODO()
id := availabilitygrouplisteners.NewAvailabilityGroupListenerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sqlVirtualMachineGroupName", "availabilityGroupListenerName")

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

Example Usage: AvailabilityGroupListenersClient.ListByGroup

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCommit 

func PossibleValuesForCommit() []string

func PossibleValuesForFailover 

func PossibleValuesForFailover() []string

func PossibleValuesForReadableSecondary 

func PossibleValuesForReadableSecondary() []string

func PossibleValuesForRole 

func PossibleValuesForRole() []string

func ValidateAvailabilityGroupListenerID 

func ValidateAvailabilityGroupListenerID(input interface{}, key string) (warnings []string, errors []error)

ValidateAvailabilityGroupListenerID checks that 'input' can be parsed as a Availability Group Listener ID

func ValidateSqlVirtualMachineGroupID 

func ValidateSqlVirtualMachineGroupID(input interface{}, key string) (warnings []string, errors []error)

ValidateSqlVirtualMachineGroupID checks that 'input' can be parsed as a Sql Virtual Machine Group ID

Types

type AgConfiguration 

type AgConfiguration struct {
	Replicas *[]AgReplica `json:"replicas,omitempty"`
}

type AgReplica 

type AgReplica struct {
	Commit                      *Commit            `json:"commit,omitempty"`
	Failover                    *Failover          `json:"failover,omitempty"`
	ReadableSecondary           *ReadableSecondary `json:"readableSecondary,omitempty"`
	Role                        *Role              `json:"role,omitempty"`
	SqlVirtualMachineInstanceId *string            `json:"sqlVirtualMachineInstanceId,omitempty"`
}

type AvailabilityGroupListener 

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

type AvailabilityGroupListenerId 

type AvailabilityGroupListenerId struct {
	SubscriptionId                string
	ResourceGroupName             string
	SqlVirtualMachineGroupName    string
	AvailabilityGroupListenerName string
}

AvailabilityGroupListenerId is a struct representing the Resource ID for a Availability Group Listener

func NewAvailabilityGroupListenerID 

func NewAvailabilityGroupListenerID(subscriptionId string, resourceGroupName string, sqlVirtualMachineGroupName string, availabilityGroupListenerName string) AvailabilityGroupListenerId

NewAvailabilityGroupListenerID returns a new AvailabilityGroupListenerId struct

func ParseAvailabilityGroupListenerID 

func ParseAvailabilityGroupListenerID(input string) (*AvailabilityGroupListenerId, error)

ParseAvailabilityGroupListenerID parses 'input' into a AvailabilityGroupListenerId

func ParseAvailabilityGroupListenerIDInsensitively 

func ParseAvailabilityGroupListenerIDInsensitively(input string) (*AvailabilityGroupListenerId, error)

ParseAvailabilityGroupListenerIDInsensitively parses 'input' case-insensitively into a AvailabilityGroupListenerId note: this method should only be used for API response data and not user input

func (*AvailabilityGroupListenerId) FromParseResult 

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

func (AvailabilityGroupListenerId) ID 

func (id AvailabilityGroupListenerId) ID() string

ID returns the formatted Availability Group Listener ID

func (AvailabilityGroupListenerId) Segments 

func (id AvailabilityGroupListenerId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Availability Group Listener ID

func (AvailabilityGroupListenerId) String 

func (id AvailabilityGroupListenerId) String() string

String returns a human-readable description of this Availability Group Listener ID

type AvailabilityGroupListenerOperationPredicate 

type AvailabilityGroupListenerOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (AvailabilityGroupListenerOperationPredicate) Matches 

func (p AvailabilityGroupListenerOperationPredicate) Matches(input AvailabilityGroupListener) bool

type AvailabilityGroupListenerProperties 

type AvailabilityGroupListenerProperties struct {
	AvailabilityGroupConfiguration           *AgConfiguration              `json:"availabilityGroupConfiguration,omitempty"`
	AvailabilityGroupName                    *string                       `json:"availabilityGroupName,omitempty"`
	CreateDefaultAvailabilityGroupIfNotExist *bool                         `json:"createDefaultAvailabilityGroupIfNotExist,omitempty"`
	LoadBalancerConfigurations               *[]LoadBalancerConfiguration  `json:"loadBalancerConfigurations,omitempty"`
	MultiSubnetIPConfigurations              *[]MultiSubnetIPConfiguration `json:"multiSubnetIpConfigurations,omitempty"`
	Port                                     *int64                        `json:"port,omitempty"`
	ProvisioningState                        *string                       `json:"provisioningState,omitempty"`
}

type AvailabilityGroupListenersClient 

type AvailabilityGroupListenersClient struct {
	Client *resourcemanager.Client
}

func NewAvailabilityGroupListenersClientWithBaseURI 

func NewAvailabilityGroupListenersClientWithBaseURI(sdkApi sdkEnv.Api) (*AvailabilityGroupListenersClient, error)

func (AvailabilityGroupListenersClient) CreateOrUpdate 

func (c AvailabilityGroupListenersClient) CreateOrUpdate(ctx context.Context, id AvailabilityGroupListenerId, input AvailabilityGroupListener) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (AvailabilityGroupListenersClient) CreateOrUpdateThenPoll 

func (c AvailabilityGroupListenersClient) CreateOrUpdateThenPoll(ctx context.Context, id AvailabilityGroupListenerId, input AvailabilityGroupListener) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (AvailabilityGroupListenersClient) Delete 

func (c AvailabilityGroupListenersClient) Delete(ctx context.Context, id AvailabilityGroupListenerId) (result DeleteOperationResponse, err error)

Delete ...

func (AvailabilityGroupListenersClient) DeleteThenPoll 

func (c AvailabilityGroupListenersClient) DeleteThenPoll(ctx context.Context, id AvailabilityGroupListenerId) error

DeleteThenPoll performs Delete then polls until it's completed

func (AvailabilityGroupListenersClient) Get 

func (c AvailabilityGroupListenersClient) Get(ctx context.Context, id AvailabilityGroupListenerId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (AvailabilityGroupListenersClient) ListByGroup 

func (c AvailabilityGroupListenersClient) ListByGroup(ctx context.Context, id SqlVirtualMachineGroupId) (result ListByGroupOperationResponse, err error)

ListByGroup ...

func (AvailabilityGroupListenersClient) ListByGroupComplete 

func (c AvailabilityGroupListenersClient) ListByGroupComplete(ctx context.Context, id SqlVirtualMachineGroupId) (ListByGroupCompleteResult, error)

ListByGroupComplete retrieves all the results into a single object

func (AvailabilityGroupListenersClient) ListByGroupCompleteMatchingPredicate 

func (c AvailabilityGroupListenersClient) ListByGroupCompleteMatchingPredicate(ctx context.Context, id SqlVirtualMachineGroupId, predicate AvailabilityGroupListenerOperationPredicate) (result ListByGroupCompleteResult, err error)

ListByGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

type Commit 

type Commit string
const (
	CommitAsynchronousCommit Commit = "Asynchronous_Commit"
	CommitSynchronousCommit  Commit = "Synchronous_Commit"
)

func (*Commit) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type Failover 

type Failover string
const (
	FailoverAutomatic Failover = "Automatic"
	FailoverManual    Failover = "Manual"
)

func (*Failover) UnmarshalJSON 

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

type GetOperationOptions 

type GetOperationOptions struct {
	Expand *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders 

func (o GetOperationOptions) ToHeaders() *client.Headers

func (GetOperationOptions) ToOData 

func (o GetOperationOptions) ToOData() *odata.Query

func (GetOperationOptions) ToQuery 

func (o GetOperationOptions) ToQuery() *client.QueryParams

type GetOperationResponse 

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

type ListByGroupCompleteResult 

type ListByGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AvailabilityGroupListener
}

type ListByGroupCustomPager 

type ListByGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByGroupCustomPager) NextPageLink() *odata.Link

type ListByGroupOperationResponse 

type ListByGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AvailabilityGroupListener
}

type LoadBalancerConfiguration 

type LoadBalancerConfiguration struct {
	LoadBalancerResourceId     *string           `json:"loadBalancerResourceId,omitempty"`
	PrivateIPAddress           *PrivateIPAddress `json:"privateIpAddress,omitempty"`
	ProbePort                  *int64            `json:"probePort,omitempty"`
	PublicIPAddressResourceId  *string           `json:"publicIpAddressResourceId,omitempty"`
	SqlVirtualMachineInstances *[]string         `json:"sqlVirtualMachineInstances,omitempty"`
}

type MultiSubnetIPConfiguration 

type MultiSubnetIPConfiguration struct {
	PrivateIPAddress          PrivateIPAddress `json:"privateIpAddress"`
	SqlVirtualMachineInstance string           `json:"sqlVirtualMachineInstance"`
}

type PrivateIPAddress 

type PrivateIPAddress struct {
	IPAddress        *string `json:"ipAddress,omitempty"`
	SubnetResourceId *string `json:"subnetResourceId,omitempty"`
}

type ReadableSecondary 

type ReadableSecondary string
const (
	ReadableSecondaryAll      ReadableSecondary = "All"
	ReadableSecondaryNo       ReadableSecondary = "No"
	ReadableSecondaryReadOnly ReadableSecondary = "Read_Only"
)

func (*ReadableSecondary) UnmarshalJSON 

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

type Role 

type Role string
const (
	RolePrimary   Role = "Primary"
	RoleSecondary Role = "Secondary"
)

func (*Role) UnmarshalJSON 

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

type SqlVirtualMachineGroupId 

type SqlVirtualMachineGroupId struct {
	SubscriptionId             string
	ResourceGroupName          string
	SqlVirtualMachineGroupName string
}

SqlVirtualMachineGroupId is a struct representing the Resource ID for a Sql Virtual Machine Group

func NewSqlVirtualMachineGroupID 

func NewSqlVirtualMachineGroupID(subscriptionId string, resourceGroupName string, sqlVirtualMachineGroupName string) SqlVirtualMachineGroupId

NewSqlVirtualMachineGroupID returns a new SqlVirtualMachineGroupId struct

func ParseSqlVirtualMachineGroupID 

func ParseSqlVirtualMachineGroupID(input string) (*SqlVirtualMachineGroupId, error)

ParseSqlVirtualMachineGroupID parses 'input' into a SqlVirtualMachineGroupId

func ParseSqlVirtualMachineGroupIDInsensitively 

func ParseSqlVirtualMachineGroupIDInsensitively(input string) (*SqlVirtualMachineGroupId, error)

ParseSqlVirtualMachineGroupIDInsensitively parses 'input' case-insensitively into a SqlVirtualMachineGroupId note: this method should only be used for API response data and not user input

func (*SqlVirtualMachineGroupId) FromParseResult 

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

func (SqlVirtualMachineGroupId) ID 

func (id SqlVirtualMachineGroupId) ID() string

ID returns the formatted Sql Virtual Machine Group ID

func (SqlVirtualMachineGroupId) Segments 

func (id SqlVirtualMachineGroupId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Sql Virtual Machine Group ID

func (SqlVirtualMachineGroupId) String 

func (id SqlVirtualMachineGroupId) String() string

String returns a human-readable description of this Sql Virtual Machine Group ID

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.