recoverypoint

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2023-08-01/recoverypoint Documentation

The recoverypoint SDK allows for interaction with the Azure Resource Manager Service recoveryservicesbackup (API Version 2023-08-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/recoveryservicesbackup/2023-08-01/recoverypoint"

Client Initialization

client := recoverypoint.NewRecoveryPointClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RecoveryPointClient.MoveRecoveryPoint

ctx := context.TODO()
id := recoverypoint.NewRecoveryPointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "backupFabricValue", "protectionContainerValue", "protectedItemValue", "recoveryPointIdValue")

payload := recoverypoint.MoveRPAcrossTiersRequest{
	// ...
}


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

Documentation

Index

• func PossibleValuesForRecoveryPointTierType() []string
• func ValidateRecoveryPointID(input interface{}, key string) (warnings []string, errors []error)
• type MoveRPAcrossTiersRequest
• type MoveRecoveryPointOperationResponse
• type RecoveryPointClient
  • func NewRecoveryPointClientWithBaseURI(endpoint string) RecoveryPointClient
  • func (c RecoveryPointClient) MoveRecoveryPoint(ctx context.Context, id RecoveryPointId, input MoveRPAcrossTiersRequest) (result MoveRecoveryPointOperationResponse, err error)
  • func (c RecoveryPointClient) MoveRecoveryPointThenPoll(ctx context.Context, id RecoveryPointId, input MoveRPAcrossTiersRequest) error
• type RecoveryPointId
  • func NewRecoveryPointID(subscriptionId string, resourceGroupName string, vaultName string, ...) RecoveryPointId
  • func ParseRecoveryPointID(input string) (*RecoveryPointId, error)
  • func ParseRecoveryPointIDInsensitively(input string) (*RecoveryPointId, error)
  • func (id *RecoveryPointId) FromParseResult(input resourceids.ParseResult) error
  • func (id RecoveryPointId) ID() string
  • func (id RecoveryPointId) Segments() []resourceids.Segment
  • func (id RecoveryPointId) String() string
• type RecoveryPointTierType

Functions

func PossibleValuesForRecoveryPointTierType

func PossibleValuesForRecoveryPointTierType() []string

func ValidateRecoveryPointID

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

ValidateRecoveryPointID checks that 'input' can be parsed as a Recovery Point ID

Types

type MoveRPAcrossTiersRequest

type MoveRPAcrossTiersRequest struct {
	ObjectType     *string                `json:"objectType,omitempty"`
	SourceTierType *RecoveryPointTierType `json:"sourceTierType,omitempty"`
	TargetTierType *RecoveryPointTierType `json:"targetTierType,omitempty"`
}

type MoveRecoveryPointOperationResponse

type MoveRecoveryPointOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type RecoveryPointClient

type RecoveryPointClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewRecoveryPointClientWithBaseURI

func NewRecoveryPointClientWithBaseURI(endpoint string) RecoveryPointClient

func (RecoveryPointClient) MoveRecoveryPoint

func (c RecoveryPointClient) MoveRecoveryPoint(ctx context.Context, id RecoveryPointId, input MoveRPAcrossTiersRequest) (result MoveRecoveryPointOperationResponse, err error)

MoveRecoveryPoint ...

func (RecoveryPointClient) MoveRecoveryPointThenPoll

func (c RecoveryPointClient) MoveRecoveryPointThenPoll(ctx context.Context, id RecoveryPointId, input MoveRPAcrossTiersRequest) error

MoveRecoveryPointThenPoll performs MoveRecoveryPoint then polls until it's completed

type RecoveryPointId

type RecoveryPointId struct {
	SubscriptionId          string
	ResourceGroupName       string
	VaultName               string
	BackupFabricName        string
	ProtectionContainerName string
	ProtectedItemName       string
	RecoveryPointId         string
}

RecoveryPointId is a struct representing the Resource ID for a Recovery Point

func NewRecoveryPointID

func NewRecoveryPointID(subscriptionId string, resourceGroupName string, vaultName string, backupFabricName string, protectionContainerName string, protectedItemName string, recoveryPointId string) RecoveryPointId

NewRecoveryPointID returns a new RecoveryPointId struct

func ParseRecoveryPointID

func ParseRecoveryPointID(input string) (*RecoveryPointId, error)

ParseRecoveryPointID parses 'input' into a RecoveryPointId

func ParseRecoveryPointIDInsensitively

func ParseRecoveryPointIDInsensitively(input string) (*RecoveryPointId, error)

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

func (*RecoveryPointId) FromParseResult

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

func (RecoveryPointId) ID

func (id RecoveryPointId) ID() string

ID returns the formatted Recovery Point ID

func (RecoveryPointId) Segments

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

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

func (RecoveryPointId) String

func (id RecoveryPointId) String() string

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

type RecoveryPointTierType

type RecoveryPointTierType string

const (
	RecoveryPointTierTypeArchivedRP RecoveryPointTierType = "ArchivedRP"
	RecoveryPointTierTypeHardenedRP RecoveryPointTierType = "HardenedRP"
	RecoveryPointTierTypeInstantRP  RecoveryPointTierType = "InstantRP"
	RecoveryPointTierTypeInvalid    RecoveryPointTierType = "Invalid"
)