restorepoints

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/restorepoints Documentation

The restorepoints SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-02-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-02-01-preview/restorepoints"

Client Initialization

client := restorepoints.NewRestorePointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RestorePointsClient.Create

ctx := context.TODO()
id := commonids.NewSqlDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue")

payload := restorepoints.CreateDatabaseRestorePointDefinition{
	// ...
}


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

Example Usage: RestorePointsClient.Delete

ctx := context.TODO()
id := restorepoints.NewRestorePointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "restorePointValue")

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

Example Usage: RestorePointsClient.Get

ctx := context.TODO()
id := restorepoints.NewRestorePointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "restorePointValue")

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: RestorePointsClient.ListByDatabase

ctx := context.TODO()
id := commonids.NewSqlDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue")

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

Documentation

Index

• func PossibleValuesForRestorePointType() []string
• func ValidateRestorePointID(input interface{}, key string) (warnings []string, errors []error)
• type CreateDatabaseRestorePointDefinition
• type CreateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListByDatabaseCompleteResult
• type ListByDatabaseOperationResponse
• type RestorePoint
• type RestorePointId
  • func NewRestorePointID(subscriptionId string, resourceGroupName string, serverName 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 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 RestorePointsClient
  • func NewRestorePointsClientWithBaseURI(sdkApi sdkEnv.Api) (*RestorePointsClient, error)
  • func (c RestorePointsClient) Create(ctx context.Context, id commonids.SqlDatabaseId, ...) (result CreateOperationResponse, err error)
  • func (c RestorePointsClient) CreateThenPoll(ctx context.Context, id commonids.SqlDatabaseId, ...) error
  • func (c RestorePointsClient) Delete(ctx context.Context, id RestorePointId) (result DeleteOperationResponse, err error)
  • func (c RestorePointsClient) Get(ctx context.Context, id RestorePointId) (result GetOperationResponse, err error)
  • func (c RestorePointsClient) ListByDatabase(ctx context.Context, id commonids.SqlDatabaseId) (result ListByDatabaseOperationResponse, err error)
  • func (c RestorePointsClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlDatabaseId) (ListByDatabaseCompleteResult, error)
  • func (c RestorePointsClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlDatabaseId, ...) (result ListByDatabaseCompleteResult, 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

Types

type CreateDatabaseRestorePointDefinition

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

type CreateOperationResponse

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

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListByDatabaseCompleteResult

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

type ListByDatabaseOperationResponse

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

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
	ServerName        string
	DatabaseName      string
	RestorePointName  string
}

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

func NewRestorePointID

func NewRestorePointID(subscriptionId string, resourceGroupName string, serverName string, databaseName 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 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 RestorePointsClient

type RestorePointsClient struct {
	Client *resourcemanager.Client
}

func NewRestorePointsClientWithBaseURI

func NewRestorePointsClientWithBaseURI(sdkApi sdkEnv.Api) (*RestorePointsClient, error)

func (RestorePointsClient) Create

func (c RestorePointsClient) Create(ctx context.Context, id commonids.SqlDatabaseId, input CreateDatabaseRestorePointDefinition) (result CreateOperationResponse, err error)

Create ...

func (RestorePointsClient) CreateThenPoll

func (c RestorePointsClient) CreateThenPoll(ctx context.Context, id commonids.SqlDatabaseId, input CreateDatabaseRestorePointDefinition) error

CreateThenPoll performs Create then polls until it's completed

func (RestorePointsClient) Delete

func (c RestorePointsClient) Delete(ctx context.Context, id RestorePointId) (result DeleteOperationResponse, err error)

Delete ...

func (RestorePointsClient) Get

func (c RestorePointsClient) Get(ctx context.Context, id RestorePointId) (result GetOperationResponse, err error)

Get ...

func (RestorePointsClient) ListByDatabase

func (c RestorePointsClient) ListByDatabase(ctx context.Context, id commonids.SqlDatabaseId) (result ListByDatabaseOperationResponse, err error)

ListByDatabase ...

func (RestorePointsClient) ListByDatabaseComplete

func (c RestorePointsClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlDatabaseId) (ListByDatabaseCompleteResult, error)

ListByDatabaseComplete retrieves all the results into a single object

func (RestorePointsClient) ListByDatabaseCompleteMatchingPredicate

func (c RestorePointsClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlDatabaseId, predicate RestorePointOperationPredicate) (result ListByDatabaseCompleteResult, err error)

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate