backupandexport

README

github.com/hashicorp/go-azure-sdk/resource-manager/mysql/2023-12-30/backupandexport Documentation

The backupandexport SDK allows for interaction with the Azure Resource Manager Service mysql (API Version 2023-12-30).

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/mysql/2023-12-30/backupandexport"

Client Initialization

client := backupandexport.NewBackupAndExportClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BackupAndExportClient.Create

ctx := context.TODO()
id := backupandexport.NewFlexibleServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue")

payload := backupandexport.BackupAndExportRequest{
	// ...
}


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

Example Usage: BackupAndExportClient.ValidateBackup

ctx := context.TODO()
id := backupandexport.NewFlexibleServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue")

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

Documentation

Index

• func PossibleValuesForBackupFormat() []string
• func PossibleValuesForOperationStatus() []string
• func ValidateFlexibleServerID(input interface{}, key string) (warnings []string, errors []error)
• type BackupAndExportClient
  • func NewBackupAndExportClientWithBaseURI(sdkApi sdkEnv.Api) (*BackupAndExportClient, error)
  • func (c BackupAndExportClient) Create(ctx context.Context, id FlexibleServerId, input BackupAndExportRequest) (result CreateOperationResponse, err error)
  • func (c BackupAndExportClient) CreateThenPoll(ctx context.Context, id FlexibleServerId, input BackupAndExportRequest) error
  • func (c BackupAndExportClient) ValidateBackup(ctx context.Context, id FlexibleServerId) (result ValidateBackupOperationResponse, err error)
• type BackupAndExportRequest
  • func (s *BackupAndExportRequest) UnmarshalJSON(bytes []byte) error
• type BackupAndExportResponse
  • func (o *BackupAndExportResponse) GetEndTimeAsTime() (*time.Time, error)
  • func (o *BackupAndExportResponse) GetStartTimeAsTime() (*time.Time, error)
  • func (o *BackupAndExportResponse) SetEndTimeAsTime(input time.Time)
  • func (o *BackupAndExportResponse) SetStartTimeAsTime(input time.Time)
• type BackupAndExportResponseProperties
• type BackupFormat
  • func (s *BackupFormat) UnmarshalJSON(bytes []byte) error
• type BackupSettings
• type BackupStoreDetails
• type CreateOperationResponse
• type ErrorAdditionalInfo
• type ErrorDetail
• type FlexibleServerId
  • func NewFlexibleServerID(subscriptionId string, resourceGroupName string, flexibleServerName string) FlexibleServerId
  • func ParseFlexibleServerID(input string) (*FlexibleServerId, error)
  • func ParseFlexibleServerIDInsensitively(input string) (*FlexibleServerId, error)
  • func (id *FlexibleServerId) FromParseResult(input resourceids.ParseResult) error
  • func (id FlexibleServerId) ID() string
  • func (id FlexibleServerId) Segments() []resourceids.Segment
  • func (id FlexibleServerId) String() string
• type OperationStatus
  • func (s *OperationStatus) UnmarshalJSON(bytes []byte) error
• type RawBackupStoreDetailsImpl
• type ValidateBackupOperationResponse
• type ValidateBackupResponse
• type ValidateBackupResponseProperties

Functions

func PossibleValuesForBackupFormat

func PossibleValuesForBackupFormat() []string

func PossibleValuesForOperationStatus

func PossibleValuesForOperationStatus() []string

func ValidateFlexibleServerID

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

ValidateFlexibleServerID checks that 'input' can be parsed as a Flexible Server ID

Types

type BackupAndExportClient

type BackupAndExportClient struct {
	Client *resourcemanager.Client
}

func NewBackupAndExportClientWithBaseURI

func NewBackupAndExportClientWithBaseURI(sdkApi sdkEnv.Api) (*BackupAndExportClient, error)

func (BackupAndExportClient) Create

func (c BackupAndExportClient) Create(ctx context.Context, id FlexibleServerId, input BackupAndExportRequest) (result CreateOperationResponse, err error)

Create ...

func (BackupAndExportClient) CreateThenPoll

func (c BackupAndExportClient) CreateThenPoll(ctx context.Context, id FlexibleServerId, input BackupAndExportRequest) error

CreateThenPoll performs Create then polls until it's completed

func (BackupAndExportClient) ValidateBackup

func (c BackupAndExportClient) ValidateBackup(ctx context.Context, id FlexibleServerId) (result ValidateBackupOperationResponse, err error)

ValidateBackup ...

type BackupAndExportRequest

type BackupAndExportRequest struct {
	BackupSettings BackupSettings     `json:"backupSettings"`
	TargetDetails  BackupStoreDetails `json:"targetDetails"`
}

func (*BackupAndExportRequest) UnmarshalJSON

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

type BackupAndExportResponse

type BackupAndExportResponse struct {
	EndTime         *string                            `json:"endTime,omitempty"`
	Error           *ErrorDetail                       `json:"error,omitempty"`
	Id              *string                            `json:"id,omitempty"`
	Name            *string                            `json:"name,omitempty"`
	PercentComplete *float64                           `json:"percentComplete,omitempty"`
	Properties      *BackupAndExportResponseProperties `json:"properties,omitempty"`
	StartTime       *string                            `json:"startTime,omitempty"`
	Status          *OperationStatus                   `json:"status,omitempty"`
	SystemData      *systemdata.SystemData             `json:"systemData,omitempty"`
	Type            *string                            `json:"type,omitempty"`
}

func (*BackupAndExportResponse) GetEndTimeAsTime

func (o *BackupAndExportResponse) GetEndTimeAsTime() (*time.Time, error)

func (*BackupAndExportResponse) GetStartTimeAsTime

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

func (*BackupAndExportResponse) SetEndTimeAsTime

func (o *BackupAndExportResponse) SetEndTimeAsTime(input time.Time)

func (*BackupAndExportResponse) SetStartTimeAsTime

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

type BackupAndExportResponseProperties

type BackupAndExportResponseProperties struct {
	BackupMetadata         *string `json:"backupMetadata,omitempty"`
	DataTransferredInBytes *int64  `json:"dataTransferredInBytes,omitempty"`
	DatasourceSizeInBytes  *int64  `json:"datasourceSizeInBytes,omitempty"`
}

type BackupFormat

type BackupFormat string

const (
	BackupFormatCollatedFormat BackupFormat = "CollatedFormat"
	BackupFormatRaw            BackupFormat = "Raw"
)

func (*BackupFormat) UnmarshalJSON

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

type BackupSettings

type BackupSettings struct {
	BackupFormat *BackupFormat `json:"backupFormat,omitempty"`
	BackupName   string        `json:"backupName"`
}

type BackupStoreDetails

type BackupStoreDetails interface {
}

type CreateOperationResponse

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

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	Info *interface{} `json:"info,omitempty"`
	Type *string      `json:"type,omitempty"`
}

type ErrorDetail

type ErrorDetail struct {
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
	Code           *string                `json:"code,omitempty"`
	Details        *[]ErrorDetail         `json:"details,omitempty"`
	Message        *string                `json:"message,omitempty"`
	Target         *string                `json:"target,omitempty"`
}

type FlexibleServerId

type FlexibleServerId struct {
	SubscriptionId     string
	ResourceGroupName  string
	FlexibleServerName string
}

FlexibleServerId is a struct representing the Resource ID for a Flexible Server

func NewFlexibleServerID

func NewFlexibleServerID(subscriptionId string, resourceGroupName string, flexibleServerName string) FlexibleServerId

NewFlexibleServerID returns a new FlexibleServerId struct

func ParseFlexibleServerID

func ParseFlexibleServerID(input string) (*FlexibleServerId, error)

ParseFlexibleServerID parses 'input' into a FlexibleServerId

func ParseFlexibleServerIDInsensitively

func ParseFlexibleServerIDInsensitively(input string) (*FlexibleServerId, error)

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

func (*FlexibleServerId) FromParseResult

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

func (FlexibleServerId) ID

func (id FlexibleServerId) ID() string

ID returns the formatted Flexible Server ID

func (FlexibleServerId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Flexible Server ID

func (FlexibleServerId) String

func (id FlexibleServerId) String() string

String returns a human-readable description of this Flexible Server ID

type OperationStatus

type OperationStatus string

const (
	OperationStatusCancelInProgress OperationStatus = "CancelInProgress"
	OperationStatusCanceled         OperationStatus = "Canceled"
	OperationStatusFailed           OperationStatus = "Failed"
	OperationStatusInProgress       OperationStatus = "InProgress"
	OperationStatusPending          OperationStatus = "Pending"
	OperationStatusSucceeded        OperationStatus = "Succeeded"
)

func (*OperationStatus) UnmarshalJSON

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

type RawBackupStoreDetailsImpl

type RawBackupStoreDetailsImpl struct {
	Type   string
	Values map[string]interface{}
}

RawBackupStoreDetailsImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type ValidateBackupOperationResponse

type ValidateBackupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ValidateBackupResponse
}

type ValidateBackupResponse

type ValidateBackupResponse struct {
	Properties *ValidateBackupResponseProperties `json:"properties,omitempty"`
}

type ValidateBackupResponseProperties

type ValidateBackupResponseProperties struct {
	NumberOfContainers *int64 `json:"numberOfContainers,omitempty"`
}