distributedavailabilitygroups

package
v0.20230823.1052657 Latest Latest
Warning

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

 Go to latest Published: Aug 23, 2023 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2022-11-01-preview/distributedavailabilitygroups Documentation

The distributedavailabilitygroups SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2022-11-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/sql/2022-11-01-preview/distributedavailabilitygroups"

Client Initialization

client := distributedavailabilitygroups.NewDistributedAvailabilityGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DistributedAvailabilityGroupsClient.CreateOrUpdate

ctx := context.TODO()
id := distributedavailabilitygroups.NewDistributedAvailabilityGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "distributedAvailabilityGroupValue")

payload := distributedavailabilitygroups.DistributedAvailabilityGroup{
	// ...
}


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

Example Usage: DistributedAvailabilityGroupsClient.Delete

ctx := context.TODO()
id := distributedavailabilitygroups.NewDistributedAvailabilityGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "distributedAvailabilityGroupValue")

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

Example Usage: DistributedAvailabilityGroupsClient.Get

ctx := context.TODO()
id := distributedavailabilitygroups.NewDistributedAvailabilityGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "distributedAvailabilityGroupValue")

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: DistributedAvailabilityGroupsClient.ListByInstance

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

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

Example Usage: DistributedAvailabilityGroupsClient.SetRole

ctx := context.TODO()
id := distributedavailabilitygroups.NewDistributedAvailabilityGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "distributedAvailabilityGroupValue")

payload := distributedavailabilitygroups.DistributedAvailabilityGroupSetRole{
	// ...
}


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

Example Usage: DistributedAvailabilityGroupsClient.Update

ctx := context.TODO()
id := distributedavailabilitygroups.NewDistributedAvailabilityGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "distributedAvailabilityGroupValue")

payload := distributedavailabilitygroups.DistributedAvailabilityGroup{
	// ...
}


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 PossibleValuesForInstanceRole 

func PossibleValuesForInstanceRole() []string

func PossibleValuesForReplicationMode 

func PossibleValuesForReplicationMode() []string

func PossibleValuesForRoleChangeType 

func PossibleValuesForRoleChangeType() []string

func ValidateDistributedAvailabilityGroupID 

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

ValidateDistributedAvailabilityGroupID checks that 'input' can be parsed as a Distributed Availability Group ID

func ValidateManagedInstanceID 

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

ValidateManagedInstanceID checks that 'input' can be parsed as a Managed Instance ID

Types

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 DistributedAvailabilityGroup 

type DistributedAvailabilityGroup struct {
	Id         *string                                 `json:"id,omitempty"`
	Name       *string                                 `json:"name,omitempty"`
	Properties *DistributedAvailabilityGroupProperties `json:"properties,omitempty"`
	Type       *string                                 `json:"type,omitempty"`
}

type DistributedAvailabilityGroupId 

type DistributedAvailabilityGroupId struct {
	SubscriptionId                   string
	ResourceGroupName                string
	ManagedInstanceName              string
	DistributedAvailabilityGroupName string
}

DistributedAvailabilityGroupId is a struct representing the Resource ID for a Distributed Availability Group

func NewDistributedAvailabilityGroupID 

func NewDistributedAvailabilityGroupID(subscriptionId string, resourceGroupName string, managedInstanceName string, distributedAvailabilityGroupName string) DistributedAvailabilityGroupId

NewDistributedAvailabilityGroupID returns a new DistributedAvailabilityGroupId struct

func ParseDistributedAvailabilityGroupID 

func ParseDistributedAvailabilityGroupID(input string) (*DistributedAvailabilityGroupId, error)

ParseDistributedAvailabilityGroupID parses 'input' into a DistributedAvailabilityGroupId

func ParseDistributedAvailabilityGroupIDInsensitively 

func ParseDistributedAvailabilityGroupIDInsensitively(input string) (*DistributedAvailabilityGroupId, error)

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

func (DistributedAvailabilityGroupId) ID 

func (id DistributedAvailabilityGroupId) ID() string

ID returns the formatted Distributed Availability Group ID

func (DistributedAvailabilityGroupId) Segments 

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

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

func (DistributedAvailabilityGroupId) String 

func (id DistributedAvailabilityGroupId) String() string

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

type DistributedAvailabilityGroupOperationPredicate 

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

func (DistributedAvailabilityGroupOperationPredicate) Matches 

func (p DistributedAvailabilityGroupOperationPredicate) Matches(input DistributedAvailabilityGroup) bool

type DistributedAvailabilityGroupProperties 

type DistributedAvailabilityGroupProperties struct {
	DistributedAvailabilityGroupId *string          `json:"distributedAvailabilityGroupId,omitempty"`
	InstanceRole                   *string          `json:"instanceRole,omitempty"`
	LastHardenedLsn                *string          `json:"lastHardenedLsn,omitempty"`
	LinkState                      *string          `json:"linkState,omitempty"`
	PrimaryAvailabilityGroupName   *string          `json:"primaryAvailabilityGroupName,omitempty"`
	ReplicationMode                *ReplicationMode `json:"replicationMode,omitempty"`
	SecondaryAvailabilityGroupName *string          `json:"secondaryAvailabilityGroupName,omitempty"`
	SourceEndpoint                 *string          `json:"sourceEndpoint,omitempty"`
	SourceReplicaId                *string          `json:"sourceReplicaId,omitempty"`
	TargetDatabase                 *string          `json:"targetDatabase,omitempty"`
	TargetReplicaId                *string          `json:"targetReplicaId,omitempty"`
}

type DistributedAvailabilityGroupSetRole 

type DistributedAvailabilityGroupSetRole struct {
	InstanceRole   InstanceRole   `json:"instanceRole"`
	RoleChangeType RoleChangeType `json:"roleChangeType"`
}

type DistributedAvailabilityGroupsClient 

type DistributedAvailabilityGroupsClient struct {
	Client *resourcemanager.Client
}

func NewDistributedAvailabilityGroupsClientWithBaseURI 

func NewDistributedAvailabilityGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*DistributedAvailabilityGroupsClient, error)

func (DistributedAvailabilityGroupsClient) CreateOrUpdate 

func (c DistributedAvailabilityGroupsClient) CreateOrUpdate(ctx context.Context, id DistributedAvailabilityGroupId, input DistributedAvailabilityGroup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DistributedAvailabilityGroupsClient) CreateOrUpdateThenPoll 

func (c DistributedAvailabilityGroupsClient) CreateOrUpdateThenPoll(ctx context.Context, id DistributedAvailabilityGroupId, input DistributedAvailabilityGroup) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DistributedAvailabilityGroupsClient) Delete 

func (c DistributedAvailabilityGroupsClient) Delete(ctx context.Context, id DistributedAvailabilityGroupId) (result DeleteOperationResponse, err error)

Delete ...

func (DistributedAvailabilityGroupsClient) DeleteThenPoll 

func (c DistributedAvailabilityGroupsClient) DeleteThenPoll(ctx context.Context, id DistributedAvailabilityGroupId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DistributedAvailabilityGroupsClient) Get 

func (c DistributedAvailabilityGroupsClient) Get(ctx context.Context, id DistributedAvailabilityGroupId) (result GetOperationResponse, err error)

Get ...

func (DistributedAvailabilityGroupsClient) ListByInstance 

func (c DistributedAvailabilityGroupsClient) ListByInstance(ctx context.Context, id ManagedInstanceId) (result ListByInstanceOperationResponse, err error)

ListByInstance ...

func (DistributedAvailabilityGroupsClient) ListByInstanceComplete 

func (c DistributedAvailabilityGroupsClient) ListByInstanceComplete(ctx context.Context, id ManagedInstanceId) (ListByInstanceCompleteResult, error)

ListByInstanceComplete retrieves all the results into a single object

func (DistributedAvailabilityGroupsClient) ListByInstanceCompleteMatchingPredicate 

func (c DistributedAvailabilityGroupsClient) ListByInstanceCompleteMatchingPredicate(ctx context.Context, id ManagedInstanceId, predicate DistributedAvailabilityGroupOperationPredicate) (result ListByInstanceCompleteResult, err error)

ListByInstanceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DistributedAvailabilityGroupsClient) SetRole 

func (c DistributedAvailabilityGroupsClient) SetRole(ctx context.Context, id DistributedAvailabilityGroupId, input DistributedAvailabilityGroupSetRole) (result SetRoleOperationResponse, err error)

SetRole ...

func (DistributedAvailabilityGroupsClient) SetRoleThenPoll 

func (c DistributedAvailabilityGroupsClient) SetRoleThenPoll(ctx context.Context, id DistributedAvailabilityGroupId, input DistributedAvailabilityGroupSetRole) error

SetRoleThenPoll performs SetRole then polls until it's completed

func (DistributedAvailabilityGroupsClient) Update 

func (c DistributedAvailabilityGroupsClient) Update(ctx context.Context, id DistributedAvailabilityGroupId, input DistributedAvailabilityGroup) (result UpdateOperationResponse, err error)

Update ...

func (DistributedAvailabilityGroupsClient) UpdateThenPoll 

func (c DistributedAvailabilityGroupsClient) UpdateThenPoll(ctx context.Context, id DistributedAvailabilityGroupId, input DistributedAvailabilityGroup) error

UpdateThenPoll performs Update then polls until it's completed

type GetOperationResponse 

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

type InstanceRole 

type InstanceRole string
const (
	InstanceRolePrimary   InstanceRole = "Primary"
	InstanceRoleSecondary InstanceRole = "Secondary"
)

func (*InstanceRole) UnmarshalJSON 

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

type ListByInstanceCompleteResult 

type ListByInstanceCompleteResult struct {
	Items []DistributedAvailabilityGroup
}

type ListByInstanceOperationResponse 

type ListByInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DistributedAvailabilityGroup
}

type ManagedInstanceId 

type ManagedInstanceId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ManagedInstanceName string
}

ManagedInstanceId is a struct representing the Resource ID for a Managed Instance

func NewManagedInstanceID 

func NewManagedInstanceID(subscriptionId string, resourceGroupName string, managedInstanceName string) ManagedInstanceId

NewManagedInstanceID returns a new ManagedInstanceId struct

func ParseManagedInstanceID 

func ParseManagedInstanceID(input string) (*ManagedInstanceId, error)

ParseManagedInstanceID parses 'input' into a ManagedInstanceId

func ParseManagedInstanceIDInsensitively 

func ParseManagedInstanceIDInsensitively(input string) (*ManagedInstanceId, error)

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

func (ManagedInstanceId) ID 

func (id ManagedInstanceId) ID() string

ID returns the formatted Managed Instance ID

func (ManagedInstanceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Managed Instance ID

func (ManagedInstanceId) String 

func (id ManagedInstanceId) String() string

String returns a human-readable description of this Managed Instance ID

type ReplicationMode 

type ReplicationMode string
const (
	ReplicationModeAsync ReplicationMode = "Async"
	ReplicationModeSync  ReplicationMode = "Sync"
)

func (*ReplicationMode) UnmarshalJSON 

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

type RoleChangeType 

type RoleChangeType string
const (
	RoleChangeTypeForced  RoleChangeType = "Forced"
	RoleChangeTypePlanned RoleChangeType = "Planned"
)

func (*RoleChangeType) UnmarshalJSON 

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

type SetRoleOperationResponse 

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

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.