sqlpoolsrestorepoints

README

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

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

Client Initialization

client := sqlpoolsrestorepoints.NewSqlPoolsRestorePointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SqlPoolsRestorePointsClient.SqlPoolRestorePointsCreate

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

payload := sqlpoolsrestorepoints.CreateSqlPoolRestorePointDefinition{
	// ...
}


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

Example Usage: SqlPoolsRestorePointsClient.SqlPoolRestorePointsDelete

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

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

Example Usage: SqlPoolsRestorePointsClient.SqlPoolRestorePointsGet

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

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

Documentation

Index

• func PossibleValuesForRestorePointType() []string
• func ValidateRestorePointID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateSqlPoolID(input interface{}, key string) (warnings []string, errors []error)
• type CreateSqlPoolRestorePointDefinition
• type RestorePoint
• type RestorePointId
  • func NewRestorePointID(subscriptionId string, resourceGroupName string, workspaceName string, ...) RestorePointId
  • func ParseRestorePointID(input string) (*RestorePointId, error)
  • func ParseRestorePointIDInsensitively(input string) (*RestorePointId, error)
  • func (id *RestorePointId) FromParseResult(input resourceids.ParseResult) error
  • func (id RestorePointId) ID() string
  • func (id RestorePointId) Segments() []resourceids.Segment
  • func (id RestorePointId) String() string
• 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 SqlPoolRestorePointsCreateOperationResponse
• type SqlPoolRestorePointsDeleteOperationResponse
• type SqlPoolRestorePointsGetOperationResponse
• type SqlPoolsRestorePointsClient
  • func NewSqlPoolsRestorePointsClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsRestorePointsClient, error)
  • func (c SqlPoolsRestorePointsClient) SqlPoolRestorePointsCreate(ctx context.Context, id SqlPoolId, input CreateSqlPoolRestorePointDefinition) (result SqlPoolRestorePointsCreateOperationResponse, err error)
  • func (c SqlPoolsRestorePointsClient) SqlPoolRestorePointsCreateThenPoll(ctx context.Context, id SqlPoolId, input CreateSqlPoolRestorePointDefinition) error
  • func (c SqlPoolsRestorePointsClient) SqlPoolRestorePointsDelete(ctx context.Context, id RestorePointId) (result SqlPoolRestorePointsDeleteOperationResponse, err error)
  • func (c SqlPoolsRestorePointsClient) SqlPoolRestorePointsGet(ctx context.Context, id RestorePointId) (result SqlPoolRestorePointsGetOperationResponse, err error)

Functions

func PossibleValuesForRestorePointType

func PossibleValuesForRestorePointType() []string

func ValidateRestorePointID

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

ValidateRestorePointID checks that 'input' can be parsed as a Restore Point 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 CreateSqlPoolRestorePointDefinition

type CreateSqlPoolRestorePointDefinition struct {
	RestorePointLabel string `json:"restorePointLabel"`
}

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 RestorePointId

type RestorePointId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	SqlPoolName       string
	RestorePointName  string
}

RestorePointId is a struct representing the Resource ID for a Restore Point

func NewRestorePointID

func NewRestorePointID(subscriptionId string, resourceGroupName string, workspaceName string, sqlPoolName string, restorePointName string) RestorePointId

NewRestorePointID returns a new RestorePointId struct

func ParseRestorePointID

func ParseRestorePointID(input string) (*RestorePointId, error)

ParseRestorePointID parses 'input' into a RestorePointId

func ParseRestorePointIDInsensitively

func ParseRestorePointIDInsensitively(input string) (*RestorePointId, error)

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

func (*RestorePointId) FromParseResult

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

func (RestorePointId) ID

func (id RestorePointId) ID() string

ID returns the formatted Restore Point ID

func (RestorePointId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Restore Point ID

func (RestorePointId) String

func (id RestorePointId) String() string

String returns a human-readable description of this Restore Point ID

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 SqlPoolRestorePointsCreateOperationResponse

type SqlPoolRestorePointsCreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RestorePoint
}

type SqlPoolRestorePointsDeleteOperationResponse

type SqlPoolRestorePointsDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type SqlPoolRestorePointsGetOperationResponse

type SqlPoolRestorePointsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RestorePoint
}

type SqlPoolsRestorePointsClient

type SqlPoolsRestorePointsClient struct {
	Client *resourcemanager.Client
}

func NewSqlPoolsRestorePointsClientWithBaseURI

func NewSqlPoolsRestorePointsClientWithBaseURI(sdkApi sdkEnv.Api) (*SqlPoolsRestorePointsClient, error)

func (SqlPoolsRestorePointsClient) SqlPoolRestorePointsCreate

func (c SqlPoolsRestorePointsClient) SqlPoolRestorePointsCreate(ctx context.Context, id SqlPoolId, input CreateSqlPoolRestorePointDefinition) (result SqlPoolRestorePointsCreateOperationResponse, err error)

SqlPoolRestorePointsCreate ...

func (SqlPoolsRestorePointsClient) SqlPoolRestorePointsCreateThenPoll

func (c SqlPoolsRestorePointsClient) SqlPoolRestorePointsCreateThenPoll(ctx context.Context, id SqlPoolId, input CreateSqlPoolRestorePointDefinition) error

SqlPoolRestorePointsCreateThenPoll performs SqlPoolRestorePointsCreate then polls until it's completed

func (SqlPoolsRestorePointsClient) SqlPoolRestorePointsDelete

func (c SqlPoolsRestorePointsClient) SqlPoolRestorePointsDelete(ctx context.Context, id RestorePointId) (result SqlPoolRestorePointsDeleteOperationResponse, err error)

SqlPoolRestorePointsDelete ...

func (SqlPoolsRestorePointsClient) SqlPoolRestorePointsGet

func (c SqlPoolsRestorePointsClient) SqlPoolRestorePointsGet(ctx context.Context, id RestorePointId) (result SqlPoolRestorePointsGetOperationResponse, err error)

SqlPoolRestorePointsGet ...