backuprestore

package
v0.20240326.1143657 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 26, 2024 License: MPL-2.0 Imports: 10 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/storagesync/2022-09-01/backuprestore Documentation

The backuprestore SDK allows for interaction with the Azure Resource Manager Service storagesync (API Version 2022-09-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/storagesync/2022-09-01/backuprestore"

Client Initialization

client := backuprestore.NewBackupRestoreClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BackupRestoreClient.CloudEndpointsAfsShareMetadataCertificatePublicKeys

ctx := context.TODO()
id := backuprestore.NewCloudEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "cloudEndpointValue")

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

Example Usage: BackupRestoreClient.CloudEndpointsPostBackup

ctx := context.TODO()
id := backuprestore.NewCloudEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "cloudEndpointValue")

payload := backuprestore.BackupRequest{
	// ...
}


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

Example Usage: BackupRestoreClient.CloudEndpointsPostRestore

ctx := context.TODO()
id := backuprestore.NewCloudEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "cloudEndpointValue")

payload := backuprestore.PostRestoreRequest{
	// ...
}


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

Example Usage: BackupRestoreClient.CloudEndpointsPreBackup

ctx := context.TODO()
id := backuprestore.NewCloudEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "cloudEndpointValue")

payload := backuprestore.BackupRequest{
	// ...
}


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

Example Usage: BackupRestoreClient.CloudEndpointsPreRestore

ctx := context.TODO()
id := backuprestore.NewCloudEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "cloudEndpointValue")

payload := backuprestore.PreRestoreRequest{
	// ...
}


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

Example Usage: BackupRestoreClient.CloudEndpointsrestoreheartbeat

ctx := context.TODO()
id := backuprestore.NewCloudEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "cloudEndpointValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateCloudEndpointID

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

ValidateCloudEndpointID checks that 'input' can be parsed as a Cloud Endpoint ID

Types

type BackupRequest

type BackupRequest struct {
	AzureFileShare *string `json:"azureFileShare,omitempty"`
}

type BackupRestoreClient

type BackupRestoreClient struct {
	Client *resourcemanager.Client
}

func NewBackupRestoreClientWithBaseURI

func NewBackupRestoreClientWithBaseURI(sdkApi sdkEnv.Api) (*BackupRestoreClient, error)

func (BackupRestoreClient) CloudEndpointsAfsShareMetadataCertificatePublicKeys

func (c BackupRestoreClient) CloudEndpointsAfsShareMetadataCertificatePublicKeys(ctx context.Context, id CloudEndpointId) (result CloudEndpointsAfsShareMetadataCertificatePublicKeysOperationResponse, err error)

CloudEndpointsAfsShareMetadataCertificatePublicKeys ...

func (BackupRestoreClient) CloudEndpointsPostBackup

func (c BackupRestoreClient) CloudEndpointsPostBackup(ctx context.Context, id CloudEndpointId, input BackupRequest) (result CloudEndpointsPostBackupOperationResponse, err error)

CloudEndpointsPostBackup ...

func (BackupRestoreClient) CloudEndpointsPostBackupThenPoll

func (c BackupRestoreClient) CloudEndpointsPostBackupThenPoll(ctx context.Context, id CloudEndpointId, input BackupRequest) error

CloudEndpointsPostBackupThenPoll performs CloudEndpointsPostBackup then polls until it's completed

func (BackupRestoreClient) CloudEndpointsPostRestore

CloudEndpointsPostRestore ...

func (BackupRestoreClient) CloudEndpointsPostRestoreThenPoll

func (c BackupRestoreClient) CloudEndpointsPostRestoreThenPoll(ctx context.Context, id CloudEndpointId, input PostRestoreRequest) error

CloudEndpointsPostRestoreThenPoll performs CloudEndpointsPostRestore then polls until it's completed

func (BackupRestoreClient) CloudEndpointsPreBackup

func (c BackupRestoreClient) CloudEndpointsPreBackup(ctx context.Context, id CloudEndpointId, input BackupRequest) (result CloudEndpointsPreBackupOperationResponse, err error)

CloudEndpointsPreBackup ...

func (BackupRestoreClient) CloudEndpointsPreBackupThenPoll

func (c BackupRestoreClient) CloudEndpointsPreBackupThenPoll(ctx context.Context, id CloudEndpointId, input BackupRequest) error

CloudEndpointsPreBackupThenPoll performs CloudEndpointsPreBackup then polls until it's completed

func (BackupRestoreClient) CloudEndpointsPreRestore

CloudEndpointsPreRestore ...

func (BackupRestoreClient) CloudEndpointsPreRestoreThenPoll

func (c BackupRestoreClient) CloudEndpointsPreRestoreThenPoll(ctx context.Context, id CloudEndpointId, input PreRestoreRequest) error

CloudEndpointsPreRestoreThenPoll performs CloudEndpointsPreRestore then polls until it's completed

func (BackupRestoreClient) CloudEndpointsrestoreheartbeat

func (c BackupRestoreClient) CloudEndpointsrestoreheartbeat(ctx context.Context, id CloudEndpointId) (result CloudEndpointsrestoreheartbeatOperationResponse, err error)

CloudEndpointsrestoreheartbeat ...

type CloudEndpointAfsShareMetadataCertificatePublicKeys

type CloudEndpointAfsShareMetadataCertificatePublicKeys struct {
	FirstKey  *string `json:"firstKey,omitempty"`
	SecondKey *string `json:"secondKey,omitempty"`
}

type CloudEndpointId

type CloudEndpointId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
	SyncGroupName          string
	CloudEndpointName      string
}

CloudEndpointId is a struct representing the Resource ID for a Cloud Endpoint

func NewCloudEndpointID

func NewCloudEndpointID(subscriptionId string, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string) CloudEndpointId

NewCloudEndpointID returns a new CloudEndpointId struct

func ParseCloudEndpointID

func ParseCloudEndpointID(input string) (*CloudEndpointId, error)

ParseCloudEndpointID parses 'input' into a CloudEndpointId

func ParseCloudEndpointIDInsensitively

func ParseCloudEndpointIDInsensitively(input string) (*CloudEndpointId, error)

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

func (*CloudEndpointId) FromParseResult

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

func (CloudEndpointId) ID

func (id CloudEndpointId) ID() string

ID returns the formatted Cloud Endpoint ID

func (CloudEndpointId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Cloud Endpoint ID

func (CloudEndpointId) String

func (id CloudEndpointId) String() string

String returns a human-readable description of this Cloud Endpoint ID

type CloudEndpointsAfsShareMetadataCertificatePublicKeysOperationResponse

type CloudEndpointsAfsShareMetadataCertificatePublicKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CloudEndpointAfsShareMetadataCertificatePublicKeys
}

type CloudEndpointsPostBackupOperationResponse

type CloudEndpointsPostBackupOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PostBackupResponse
}

type CloudEndpointsPostRestoreOperationResponse

type CloudEndpointsPostRestoreOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type CloudEndpointsPreBackupOperationResponse

type CloudEndpointsPreBackupOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type CloudEndpointsPreRestoreOperationResponse

type CloudEndpointsPreRestoreOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type CloudEndpointsrestoreheartbeatOperationResponse

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

type PostBackupResponse

type PostBackupResponse struct {
	BackupMetadata *PostBackupResponseProperties `json:"backupMetadata,omitempty"`
}

type PostBackupResponseProperties

type PostBackupResponseProperties struct {
	CloudEndpointName *string `json:"cloudEndpointName,omitempty"`
}

type PostRestoreRequest

type PostRestoreRequest struct {
	AzureFileShareUri       *string            `json:"azureFileShareUri,omitempty"`
	FailedFileList          *string            `json:"failedFileList,omitempty"`
	Partition               *string            `json:"partition,omitempty"`
	ReplicaGroup            *string            `json:"replicaGroup,omitempty"`
	RequestId               *string            `json:"requestId,omitempty"`
	RestoreFileSpec         *[]RestoreFileSpec `json:"restoreFileSpec,omitempty"`
	SourceAzureFileShareUri *string            `json:"sourceAzureFileShareUri,omitempty"`
	Status                  *string            `json:"status,omitempty"`
}

type PreRestoreRequest

type PreRestoreRequest struct {
	AzureFileShareUri                        *string            `json:"azureFileShareUri,omitempty"`
	BackupMetadataPropertyBag                *string            `json:"backupMetadataPropertyBag,omitempty"`
	Partition                                *string            `json:"partition,omitempty"`
	PauseWaitForSyncDrainTimePeriodInSeconds *int64             `json:"pauseWaitForSyncDrainTimePeriodInSeconds,omitempty"`
	ReplicaGroup                             *string            `json:"replicaGroup,omitempty"`
	RequestId                                *string            `json:"requestId,omitempty"`
	RestoreFileSpec                          *[]RestoreFileSpec `json:"restoreFileSpec,omitempty"`
	SourceAzureFileShareUri                  *string            `json:"sourceAzureFileShareUri,omitempty"`
	Status                                   *string            `json:"status,omitempty"`
}

type RestoreFileSpec

type RestoreFileSpec struct {
	Isdir *bool   `json:"isdir,omitempty"`
	Path  *string `json:"path,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL