sqlpoolsbackup

README

github.com/hashicorp/go-azure-sdk/resource-manager/synapse/2021-06-01/sqlpoolsbackup Documentation

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

Client Initialization

client := sqlpoolsbackup.NewSqlPoolsBackupClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SqlPoolsBackupClient.SqlPoolRestorePointsList

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

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

Documentation

Index

• func PossibleValuesForRestorePointType() []string
• func ValidateSqlPoolID(input interface{}, key string) (warnings []string, errors []error)
• type RestorePoint
• type RestorePointOperationPredicate
  • func (p RestorePointOperationPredicate) Matches(input RestorePoint) bool
• type RestorePointProperties
  • func (o *RestorePointProperties) GetEarliestRestoreDateAsTime() (*time.Time, error)
  • func (o *RestorePointProperties) GetRestorePointCreationDateAsTime() (*time.Time, error)
  • func (o *RestorePointProperties) SetEarliestRestoreDateAsTime(input time.Time)
  • func (o *RestorePointProperties) SetRestorePointCreationDateAsTime(input time.Time)
• type RestorePointType
  • func (s *RestorePointType) UnmarshalJSON(bytes []byte) error
• type SqlPoolId
  • func NewSqlPoolID(subscriptionId string, resourceGroupName string, workspaceName string, ...) SqlPoolId
  • func ParseSqlPoolID(input string) (*SqlPoolId, error)
  • func ParseSqlPoolIDInsensitively(input string) (*SqlPoolId, error)
  • func (id *SqlPoolId) FromParseResult(input resourceids.ParseResult) error
  • func (id SqlPoolId) ID() string
  • func (id SqlPoolId) Segments() []resourceids.Segment
  • func (id SqlPoolId) String() string
• type SqlPoolRestorePointsListCompleteResult
• type SqlPoolRestorePointsListOperationResponse
• type SqlPoolsBackupClient
  • func NewSqlPoolsBackupClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsBackupClient, error)
  • func (c SqlPoolsBackupClient) SqlPoolRestorePointsList(ctx context.Context, id SqlPoolId) (result SqlPoolRestorePointsListOperationResponse, err error)
  • func (c SqlPoolsBackupClient) SqlPoolRestorePointsListComplete(ctx context.Context, id SqlPoolId) (SqlPoolRestorePointsListCompleteResult, error)
  • func (c SqlPoolsBackupClient) SqlPoolRestorePointsListCompleteMatchingPredicate(ctx context.Context, id SqlPoolId, predicate RestorePointOperationPredicate) (result SqlPoolRestorePointsListCompleteResult, err error)

Functions

func PossibleValuesForRestorePointType

func PossibleValuesForRestorePointType() []string

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 RestorePoint

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

type RestorePointOperationPredicate

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

func (RestorePointOperationPredicate) Matches

func (p RestorePointOperationPredicate) Matches(input RestorePoint) bool

type RestorePointProperties

type RestorePointProperties struct {
	EarliestRestoreDate      *string           `json:"earliestRestoreDate,omitempty"`
	RestorePointCreationDate *string           `json:"restorePointCreationDate,omitempty"`
	RestorePointLabel        *string           `json:"restorePointLabel,omitempty"`
	RestorePointType         *RestorePointType `json:"restorePointType,omitempty"`
}

func (*RestorePointProperties) GetEarliestRestoreDateAsTime

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

func (*RestorePointProperties) GetRestorePointCreationDateAsTime

func (o *RestorePointProperties) GetRestorePointCreationDateAsTime() (*time.Time, error)

func (*RestorePointProperties) SetEarliestRestoreDateAsTime

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

func (*RestorePointProperties) SetRestorePointCreationDateAsTime

func (o *RestorePointProperties) SetRestorePointCreationDateAsTime(input time.Time)

type RestorePointType

type RestorePointType string

const (
	RestorePointTypeCONTINUOUS RestorePointType = "CONTINUOUS"
	RestorePointTypeDISCRETE   RestorePointType = "DISCRETE"
)

func (*RestorePointType) UnmarshalJSON

func (s *RestorePointType) 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 SqlPoolRestorePointsListCompleteResult

type SqlPoolRestorePointsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RestorePoint
}

type SqlPoolRestorePointsListOperationResponse

type SqlPoolRestorePointsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RestorePoint
}

type SqlPoolsBackupClient

type SqlPoolsBackupClient struct {
	Client *resourcemanager.Client
}

func NewSqlPoolsBackupClientWithBaseURI

func NewSqlPoolsBackupClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsBackupClient, error)

func (SqlPoolsBackupClient) SqlPoolRestorePointsList

func (c SqlPoolsBackupClient) SqlPoolRestorePointsList(ctx context.Context, id SqlPoolId) (result SqlPoolRestorePointsListOperationResponse, err error)

SqlPoolRestorePointsList ...

func (SqlPoolsBackupClient) SqlPoolRestorePointsListComplete

func (c SqlPoolsBackupClient) SqlPoolRestorePointsListComplete(ctx context.Context, id SqlPoolId) (SqlPoolRestorePointsListCompleteResult, error)

SqlPoolRestorePointsListComplete retrieves all the results into a single object

func (SqlPoolsBackupClient) SqlPoolRestorePointsListCompleteMatchingPredicate

func (c SqlPoolsBackupClient) SqlPoolRestorePointsListCompleteMatchingPredicate(ctx context.Context, id SqlPoolId, predicate RestorePointOperationPredicate) (result SqlPoolRestorePointsListCompleteResult, err error)

SqlPoolRestorePointsListCompleteMatchingPredicate retrieves all the results and then applies the predicate