datamove

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2024-04-01/datamove Documentation

The datamove SDK allows for interaction with Azure Resource Manager recoveryservicesbackup (API Version 2024-04-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/2024-04-01/datamove"

Client Initialization

client := datamove.NewDataMoveClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataMoveClient.BMSPrepareDataMove

ctx := context.TODO()
id := datamove.NewVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultName")

payload := datamove.PrepareDataMoveRequest{
	// ...
}


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

Example Usage: DataMoveClient.BMSTriggerDataMove

ctx := context.TODO()
id := datamove.NewVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultName")

payload := datamove.TriggerDataMoveRequest{
	// ...
}


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

Documentation

Index

• func PossibleValuesForDataMoveLevel() []string
• func ValidateVaultID(input interface{}, key string) (warnings []string, errors []error)
• type BMSPrepareDataMoveOperationResponse
• type BMSTriggerDataMoveOperationResponse
• type DataMoveClient
  • func NewDataMoveClientWithBaseURI(endpoint string) DataMoveClient
  • func (c DataMoveClient) BMSPrepareDataMove(ctx context.Context, id VaultId, input PrepareDataMoveRequest) (result BMSPrepareDataMoveOperationResponse, err error)
  • func (c DataMoveClient) BMSPrepareDataMoveThenPoll(ctx context.Context, id VaultId, input PrepareDataMoveRequest) error
  • func (c DataMoveClient) BMSTriggerDataMove(ctx context.Context, id VaultId, input TriggerDataMoveRequest) (result BMSTriggerDataMoveOperationResponse, err error)
  • func (c DataMoveClient) BMSTriggerDataMoveThenPoll(ctx context.Context, id VaultId, input TriggerDataMoveRequest) error
• type DataMoveLevel
• type PrepareDataMoveRequest
• type TriggerDataMoveRequest
• type VaultId
  • func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId
  • func ParseVaultID(input string) (*VaultId, error)
  • func ParseVaultIDInsensitively(input string) (*VaultId, error)
  • func (id *VaultId) FromParseResult(input resourceids.ParseResult) error
  • func (id VaultId) ID() string
  • func (id VaultId) Segments() []resourceids.Segment
  • func (id VaultId) String() string

Functions

func PossibleValuesForDataMoveLevel

func PossibleValuesForDataMoveLevel() []string

func ValidateVaultID

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

ValidateVaultID checks that 'input' can be parsed as a Vault ID

Types

type BMSPrepareDataMoveOperationResponse

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

type BMSTriggerDataMoveOperationResponse

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

type DataMoveClient

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

func NewDataMoveClientWithBaseURI

func NewDataMoveClientWithBaseURI(endpoint string) DataMoveClient

func (DataMoveClient) BMSPrepareDataMove

func (c DataMoveClient) BMSPrepareDataMove(ctx context.Context, id VaultId, input PrepareDataMoveRequest) (result BMSPrepareDataMoveOperationResponse, err error)

BMSPrepareDataMove ...

func (DataMoveClient) BMSPrepareDataMoveThenPoll

func (c DataMoveClient) BMSPrepareDataMoveThenPoll(ctx context.Context, id VaultId, input PrepareDataMoveRequest) error

BMSPrepareDataMoveThenPoll performs BMSPrepareDataMove then polls until it's completed

func (DataMoveClient) BMSTriggerDataMove

func (c DataMoveClient) BMSTriggerDataMove(ctx context.Context, id VaultId, input TriggerDataMoveRequest) (result BMSTriggerDataMoveOperationResponse, err error)

BMSTriggerDataMove ...

func (DataMoveClient) BMSTriggerDataMoveThenPoll

func (c DataMoveClient) BMSTriggerDataMoveThenPoll(ctx context.Context, id VaultId, input TriggerDataMoveRequest) error

BMSTriggerDataMoveThenPoll performs BMSTriggerDataMove then polls until it's completed

type DataMoveLevel

type DataMoveLevel string

const (
	DataMoveLevelContainer DataMoveLevel = "Container"
	DataMoveLevelInvalid   DataMoveLevel = "Invalid"
	DataMoveLevelVault     DataMoveLevel = "Vault"
)

type PrepareDataMoveRequest

type PrepareDataMoveRequest struct {
	DataMoveLevel         DataMoveLevel `json:"dataMoveLevel"`
	IgnoreMoved           *bool         `json:"ignoreMoved,omitempty"`
	SourceContainerArmIds *[]string     `json:"sourceContainerArmIds,omitempty"`
	TargetRegion          string        `json:"targetRegion"`
	TargetResourceId      string        `json:"targetResourceId"`
}

type TriggerDataMoveRequest

type TriggerDataMoveRequest struct {
	CorrelationId         string        `json:"correlationId"`
	DataMoveLevel         DataMoveLevel `json:"dataMoveLevel"`
	PauseGC               *bool         `json:"pauseGC,omitempty"`
	SourceContainerArmIds *[]string     `json:"sourceContainerArmIds,omitempty"`
	SourceRegion          string        `json:"sourceRegion"`
	SourceResourceId      string        `json:"sourceResourceId"`
}

type VaultId

type VaultId struct {
	SubscriptionId    string
	ResourceGroupName string
	VaultName         string
}

VaultId is a struct representing the Resource ID for a Vault

func NewVaultID

func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId

NewVaultID returns a new VaultId struct

func ParseVaultID

func ParseVaultID(input string) (*VaultId, error)

ParseVaultID parses 'input' into a VaultId

func ParseVaultIDInsensitively

func ParseVaultIDInsensitively(input string) (*VaultId, error)

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

func (*VaultId) FromParseResult

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

func (VaultId) ID

func (id VaultId) ID() string

ID returns the formatted Vault ID

func (VaultId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Vault ID

func (VaultId) String

func (id VaultId) String() string

String returns a human-readable description of this Vault ID