sqlpoolsreplicationlinks

package
v0.20240320.1144505 Latest Latest
Warning

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

Go to latest
Published: Mar 20, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

The sqlpoolsreplicationlinks SDK allows for interaction with the Azure Resource Manager Service synapse (API Version 2021-06-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/synapse/2021-06-01/sqlpoolsreplicationlinks"

Client Initialization

client := sqlpoolsreplicationlinks.NewSqlPoolsReplicationLinksClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SqlPoolsReplicationLinksClient.SqlPoolReplicationLinksGetByName

ctx := context.TODO()
id := sqlpoolsreplicationlinks.NewReplicationLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue", "linkIdValue")

read, err := client.SqlPoolReplicationLinksGetByName(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}
ctx := context.TODO()
id := sqlpoolsreplicationlinks.NewSqlPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sqlPoolValue")

// alternatively `client.SqlPoolReplicationLinksList(ctx, id)` can be used to do batched pagination
items, err := client.SqlPoolReplicationLinksListComplete(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 PossibleValuesForReplicationRole

func PossibleValuesForReplicationRole() []string

func PossibleValuesForReplicationState

func PossibleValuesForReplicationState() []string

func ValidateReplicationLinkID

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

ValidateReplicationLinkID checks that 'input' can be parsed as a Replication Link ID

func ValidateSqlPoolID

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

ValidateSqlPoolID checks that 'input' can be parsed as a Sql Pool ID

Types

type ReplicationLink struct {
	Id         *string                    `json:"id,omitempty"`
	Location   *string                    `json:"location,omitempty"`
	Name       *string                    `json:"name,omitempty"`
	Properties *ReplicationLinkProperties `json:"properties,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type ReplicationLinkId

type ReplicationLinkId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	SqlPoolName       string
	LinkId            string
}

ReplicationLinkId is a struct representing the Resource ID for a Replication Link

func NewReplicationLinkID

func NewReplicationLinkID(subscriptionId string, resourceGroupName string, workspaceName string, sqlPoolName string, linkId string) ReplicationLinkId

NewReplicationLinkID returns a new ReplicationLinkId struct

func ParseReplicationLinkID

func ParseReplicationLinkID(input string) (*ReplicationLinkId, error)

ParseReplicationLinkID parses 'input' into a ReplicationLinkId

func ParseReplicationLinkIDInsensitively

func ParseReplicationLinkIDInsensitively(input string) (*ReplicationLinkId, error)

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

func (*ReplicationLinkId) FromParseResult

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

func (ReplicationLinkId) ID

func (id ReplicationLinkId) ID() string

ID returns the formatted Replication Link ID

func (ReplicationLinkId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Replication Link ID

func (ReplicationLinkId) String

func (id ReplicationLinkId) String() string

String returns a human-readable description of this Replication Link ID

type ReplicationLinkOperationPredicate

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

func (ReplicationLinkOperationPredicate) Matches

type ReplicationLinkProperties

type ReplicationLinkProperties struct {
	IsTerminationAllowed *bool             `json:"isTerminationAllowed,omitempty"`
	PartnerDatabase      *string           `json:"partnerDatabase,omitempty"`
	PartnerLocation      *string           `json:"partnerLocation,omitempty"`
	PartnerRole          *ReplicationRole  `json:"partnerRole,omitempty"`
	PartnerServer        *string           `json:"partnerServer,omitempty"`
	PercentComplete      *int64            `json:"percentComplete,omitempty"`
	ReplicationMode      *string           `json:"replicationMode,omitempty"`
	ReplicationState     *ReplicationState `json:"replicationState,omitempty"`
	Role                 *ReplicationRole  `json:"role,omitempty"`
	StartTime            *string           `json:"startTime,omitempty"`
}

func (*ReplicationLinkProperties) GetStartTimeAsTime

func (o *ReplicationLinkProperties) GetStartTimeAsTime() (*time.Time, error)

func (*ReplicationLinkProperties) SetStartTimeAsTime

func (o *ReplicationLinkProperties) SetStartTimeAsTime(input time.Time)

type ReplicationRole

type ReplicationRole string
const (
	ReplicationRoleCopy                 ReplicationRole = "Copy"
	ReplicationRoleNonReadableSecondary ReplicationRole = "NonReadableSecondary"
	ReplicationRolePrimary              ReplicationRole = "Primary"
	ReplicationRoleSecondary            ReplicationRole = "Secondary"
	ReplicationRoleSource               ReplicationRole = "Source"
)

func (*ReplicationRole) UnmarshalJSON

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

type ReplicationState

type ReplicationState string
const (
	ReplicationStateCATCHUP   ReplicationState = "CATCH_UP"
	ReplicationStatePENDING   ReplicationState = "PENDING"
	ReplicationStateSEEDING   ReplicationState = "SEEDING"
	ReplicationStateSUSPENDED ReplicationState = "SUSPENDED"
)

func (*ReplicationState) UnmarshalJSON

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

type SqlPoolId

type SqlPoolId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	SqlPoolName       string
}

SqlPoolId is a struct representing the Resource ID for a Sql Pool

func NewSqlPoolID

func NewSqlPoolID(subscriptionId string, resourceGroupName string, workspaceName string, sqlPoolName string) SqlPoolId

NewSqlPoolID returns a new SqlPoolId struct

func ParseSqlPoolID

func ParseSqlPoolID(input string) (*SqlPoolId, error)

ParseSqlPoolID parses 'input' into a SqlPoolId

func ParseSqlPoolIDInsensitively

func ParseSqlPoolIDInsensitively(input string) (*SqlPoolId, error)

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

func (*SqlPoolId) FromParseResult

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

func (SqlPoolId) ID

func (id SqlPoolId) ID() string

ID returns the formatted Sql Pool ID

func (SqlPoolId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Sql Pool ID

func (SqlPoolId) String

func (id SqlPoolId) String() string

String returns a human-readable description of this Sql Pool ID

type SqlPoolReplicationLinksGetByNameOperationResponse

type SqlPoolReplicationLinksGetByNameOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ReplicationLink
}

type SqlPoolReplicationLinksListCompleteResult

type SqlPoolReplicationLinksListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ReplicationLink
}

type SqlPoolReplicationLinksListOperationResponse

type SqlPoolReplicationLinksListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ReplicationLink
}

type SqlPoolsReplicationLinksClient

type SqlPoolsReplicationLinksClient struct {
	Client *resourcemanager.Client
}

func NewSqlPoolsReplicationLinksClientWithBaseURI

func NewSqlPoolsReplicationLinksClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsReplicationLinksClient, error)

func (SqlPoolsReplicationLinksClient) SqlPoolReplicationLinksGetByName

SqlPoolReplicationLinksGetByName ...

SqlPoolReplicationLinksList ...

func (SqlPoolsReplicationLinksClient) SqlPoolReplicationLinksListComplete

SqlPoolReplicationLinksListComplete retrieves all the results into a single object

func (SqlPoolsReplicationLinksClient) SqlPoolReplicationLinksListCompleteMatchingPredicate

func (c SqlPoolsReplicationLinksClient) SqlPoolReplicationLinksListCompleteMatchingPredicate(ctx context.Context, id SqlPoolId, predicate ReplicationLinkOperationPredicate) (result SqlPoolReplicationLinksListCompleteResult, err error)

SqlPoolReplicationLinksListCompleteMatchingPredicate retrieves all the results and then applies the predicate

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL