backups

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2023-02-01/backups Documentation

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

Client Initialization

client := backups.NewBackupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BackupsClient.Trigger

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

payload := backups.BackupRequestResource{
	// ...
}


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

Documentation

Index

• func PossibleValuesForBackupType() []string
• func ValidateProtectedItemID(input interface{}, key string) (warnings []string, errors []error)
• type AzureFileShareBackupRequest
  • func (s AzureFileShareBackupRequest) MarshalJSON() ([]byte, error)
• type AzureWorkloadBackupRequest
  • func (s AzureWorkloadBackupRequest) MarshalJSON() ([]byte, error)
• type BackupRequest
• type BackupRequestResource
  • func (s *BackupRequestResource) UnmarshalJSON(bytes []byte) error
• type BackupType
• type BackupsClient
  • func NewBackupsClientWithBaseURI(endpoint string) BackupsClient
  • func (c BackupsClient) Trigger(ctx context.Context, id ProtectedItemId, input BackupRequestResource) (result TriggerOperationResponse, err error)
• type IaasVMBackupRequest
  • func (s IaasVMBackupRequest) MarshalJSON() ([]byte, error)
• type ProtectedItemId
  • func NewProtectedItemID(subscriptionId string, resourceGroupName string, vaultName string, ...) ProtectedItemId
  • func ParseProtectedItemID(input string) (*ProtectedItemId, error)
  • func ParseProtectedItemIDInsensitively(input string) (*ProtectedItemId, error)
  • func (id ProtectedItemId) ID() string
  • func (id ProtectedItemId) Segments() []resourceids.Segment
  • func (id ProtectedItemId) String() string
• type RawBackupRequestImpl
• type TriggerOperationResponse

Functions

func PossibleValuesForBackupType

func PossibleValuesForBackupType() []string

func ValidateProtectedItemID

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

ValidateProtectedItemID checks that 'input' can be parsed as a Protected Item ID

Types

type AzureFileShareBackupRequest

type AzureFileShareBackupRequest struct {
	RecoveryPointExpiryTimeInUTC *string `json:"recoveryPointExpiryTimeInUTC,omitempty"`
}

func (AzureFileShareBackupRequest) MarshalJSON

func (s AzureFileShareBackupRequest) MarshalJSON() ([]byte, error)

type AzureWorkloadBackupRequest

type AzureWorkloadBackupRequest struct {
	BackupType                   *BackupType `json:"backupType,omitempty"`
	EnableCompression            *bool       `json:"enableCompression,omitempty"`
	RecoveryPointExpiryTimeInUTC *string     `json:"recoveryPointExpiryTimeInUTC,omitempty"`
}

func (AzureWorkloadBackupRequest) MarshalJSON

func (s AzureWorkloadBackupRequest) MarshalJSON() ([]byte, error)

type BackupRequest

type BackupRequest interface {
}

type BackupRequestResource

type BackupRequestResource struct {
	ETag       *string            `json:"eTag,omitempty"`
	Id         *string            `json:"id,omitempty"`
	Location   *string            `json:"location,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties BackupRequest      `json:"properties"`
	Tags       *map[string]string `json:"tags,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

func (*BackupRequestResource) UnmarshalJSON

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

type BackupType

type BackupType string

const (
	BackupTypeCopyOnlyFull         BackupType = "CopyOnlyFull"
	BackupTypeDifferential         BackupType = "Differential"
	BackupTypeFull                 BackupType = "Full"
	BackupTypeIncremental          BackupType = "Incremental"
	BackupTypeInvalid              BackupType = "Invalid"
	BackupTypeLog                  BackupType = "Log"
	BackupTypeSnapshotCopyOnlyFull BackupType = "SnapshotCopyOnlyFull"
	BackupTypeSnapshotFull         BackupType = "SnapshotFull"
)

type BackupsClient

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

func NewBackupsClientWithBaseURI

func NewBackupsClientWithBaseURI(endpoint string) BackupsClient

func (BackupsClient) Trigger

func (c BackupsClient) Trigger(ctx context.Context, id ProtectedItemId, input BackupRequestResource) (result TriggerOperationResponse, err error)

Trigger ...

type IaasVMBackupRequest

type IaasVMBackupRequest struct {
	RecoveryPointExpiryTimeInUTC *string `json:"recoveryPointExpiryTimeInUTC,omitempty"`
}

func (IaasVMBackupRequest) MarshalJSON

func (s IaasVMBackupRequest) MarshalJSON() ([]byte, error)

type ProtectedItemId

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

ProtectedItemId is a struct representing the Resource ID for a Protected Item

func NewProtectedItemID

func NewProtectedItemID(subscriptionId string, resourceGroupName string, vaultName string, backupFabricName string, protectionContainerName string, protectedItemName string) ProtectedItemId

NewProtectedItemID returns a new ProtectedItemId struct

func ParseProtectedItemID

func ParseProtectedItemID(input string) (*ProtectedItemId, error)

ParseProtectedItemID parses 'input' into a ProtectedItemId

func ParseProtectedItemIDInsensitively

func ParseProtectedItemIDInsensitively(input string) (*ProtectedItemId, error)

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

func (ProtectedItemId) ID

func (id ProtectedItemId) ID() string

ID returns the formatted Protected Item ID

func (ProtectedItemId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Protected Item ID

func (ProtectedItemId) String

func (id ProtectedItemId) String() string

String returns a human-readable description of this Protected Item ID

type RawBackupRequestImpl

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

RawModeOfTransitImpl 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 TriggerOperationResponse

type TriggerOperationResponse struct {
	HttpResponse *http.Response
}