recoverypointscrr

package
v0.20240126.1105227 Latest Latest
Warning

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

Go to latest
Published: Jan 26, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2023-01-15/recoverypointscrr Documentation

The recoverypointscrr SDK allows for interaction with the Azure Resource Manager Service recoveryservicesbackup (API Version 2023-01-15).

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-01-15/recoverypointscrr"

Client Initialization

client := recoverypointscrr.NewRecoveryPointsCrrClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RecoveryPointsCrrClient.Get

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

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

Example Usage: RecoveryPointsCrrClient.List

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

// alternatively `client.List(ctx, id, recoverypointscrr.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, recoverypointscrr.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForRecoveryPointTierStatus

func PossibleValuesForRecoveryPointTierStatus() []string

func PossibleValuesForRecoveryPointTierType

func PossibleValuesForRecoveryPointTierType() []string

func PossibleValuesForRestorePointType

func PossibleValuesForRestorePointType() []string

func PossibleValuesForSQLDataDirectoryType

func PossibleValuesForSQLDataDirectoryType() []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

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 AzureFileShareRecoveryPoint

type AzureFileShareRecoveryPoint struct {
	FileShareSnapshotUri    *string                  `json:"fileShareSnapshotUri,omitempty"`
	RecoveryPointProperties *RecoveryPointProperties `json:"recoveryPointProperties,omitempty"`
	RecoveryPointSizeInGB   *int64                   `json:"recoveryPointSizeInGB,omitempty"`
	RecoveryPointTime       *string                  `json:"recoveryPointTime,omitempty"`
	RecoveryPointType       *string                  `json:"recoveryPointType,omitempty"`
}

func (AzureFileShareRecoveryPoint) MarshalJSON

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

type AzureWorkloadPointInTimeRecoveryPoint

type AzureWorkloadPointInTimeRecoveryPoint struct {
	RecoveryPointMoveReadinessInfo *map[string]RecoveryPointMoveReadinessInfo `json:"recoveryPointMoveReadinessInfo,omitempty"`
	RecoveryPointProperties        *RecoveryPointProperties                   `json:"recoveryPointProperties,omitempty"`
	RecoveryPointTierDetails       *[]RecoveryPointTierInformation            `json:"recoveryPointTierDetails,omitempty"`
	RecoveryPointTimeInUTC         *string                                    `json:"recoveryPointTimeInUTC,omitempty"`
	TimeRanges                     *[]PointInTimeRange                        `json:"timeRanges,omitempty"`
	Type                           *RestorePointType                          `json:"type,omitempty"`
}

func (AzureWorkloadPointInTimeRecoveryPoint) MarshalJSON

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

type AzureWorkloadRecoveryPoint

type AzureWorkloadRecoveryPoint struct {
	RecoveryPointMoveReadinessInfo *map[string]RecoveryPointMoveReadinessInfo `json:"recoveryPointMoveReadinessInfo,omitempty"`
	RecoveryPointProperties        *RecoveryPointProperties                   `json:"recoveryPointProperties,omitempty"`
	RecoveryPointTierDetails       *[]RecoveryPointTierInformation            `json:"recoveryPointTierDetails,omitempty"`
	RecoveryPointTimeInUTC         *string                                    `json:"recoveryPointTimeInUTC,omitempty"`
	Type                           *RestorePointType                          `json:"type,omitempty"`
}

func (AzureWorkloadRecoveryPoint) MarshalJSON

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

type AzureWorkloadSAPHanaPointInTimeRecoveryPoint

type AzureWorkloadSAPHanaPointInTimeRecoveryPoint struct {
	RecoveryPointMoveReadinessInfo *map[string]RecoveryPointMoveReadinessInfo `json:"recoveryPointMoveReadinessInfo,omitempty"`
	RecoveryPointProperties        *RecoveryPointProperties                   `json:"recoveryPointProperties,omitempty"`
	RecoveryPointTierDetails       *[]RecoveryPointTierInformation            `json:"recoveryPointTierDetails,omitempty"`
	RecoveryPointTimeInUTC         *string                                    `json:"recoveryPointTimeInUTC,omitempty"`
	TimeRanges                     *[]PointInTimeRange                        `json:"timeRanges,omitempty"`
	Type                           *RestorePointType                          `json:"type,omitempty"`
}

func (AzureWorkloadSAPHanaPointInTimeRecoveryPoint) MarshalJSON

type AzureWorkloadSAPHanaRecoveryPoint

type AzureWorkloadSAPHanaRecoveryPoint struct {
	RecoveryPointMoveReadinessInfo *map[string]RecoveryPointMoveReadinessInfo `json:"recoveryPointMoveReadinessInfo,omitempty"`
	RecoveryPointProperties        *RecoveryPointProperties                   `json:"recoveryPointProperties,omitempty"`
	RecoveryPointTierDetails       *[]RecoveryPointTierInformation            `json:"recoveryPointTierDetails,omitempty"`
	RecoveryPointTimeInUTC         *string                                    `json:"recoveryPointTimeInUTC,omitempty"`
	Type                           *RestorePointType                          `json:"type,omitempty"`
}

func (AzureWorkloadSAPHanaRecoveryPoint) MarshalJSON

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

type AzureWorkloadSQLPointInTimeRecoveryPoint

type AzureWorkloadSQLPointInTimeRecoveryPoint struct {
	ExtendedInfo                   *AzureWorkloadSQLRecoveryPointExtendedInfo `json:"extendedInfo,omitempty"`
	RecoveryPointMoveReadinessInfo *map[string]RecoveryPointMoveReadinessInfo `json:"recoveryPointMoveReadinessInfo,omitempty"`
	RecoveryPointProperties        *RecoveryPointProperties                   `json:"recoveryPointProperties,omitempty"`
	RecoveryPointTierDetails       *[]RecoveryPointTierInformation            `json:"recoveryPointTierDetails,omitempty"`
	RecoveryPointTimeInUTC         *string                                    `json:"recoveryPointTimeInUTC,omitempty"`
	TimeRanges                     *[]PointInTimeRange                        `json:"timeRanges,omitempty"`
	Type                           *RestorePointType                          `json:"type,omitempty"`
}

func (AzureWorkloadSQLPointInTimeRecoveryPoint) MarshalJSON

type AzureWorkloadSQLRecoveryPoint

type AzureWorkloadSQLRecoveryPoint struct {
	ExtendedInfo                   *AzureWorkloadSQLRecoveryPointExtendedInfo `json:"extendedInfo,omitempty"`
	RecoveryPointMoveReadinessInfo *map[string]RecoveryPointMoveReadinessInfo `json:"recoveryPointMoveReadinessInfo,omitempty"`
	RecoveryPointProperties        *RecoveryPointProperties                   `json:"recoveryPointProperties,omitempty"`
	RecoveryPointTierDetails       *[]RecoveryPointTierInformation            `json:"recoveryPointTierDetails,omitempty"`
	RecoveryPointTimeInUTC         *string                                    `json:"recoveryPointTimeInUTC,omitempty"`
	Type                           *RestorePointType                          `json:"type,omitempty"`
}

func (AzureWorkloadSQLRecoveryPoint) MarshalJSON

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

type AzureWorkloadSQLRecoveryPointExtendedInfo

type AzureWorkloadSQLRecoveryPointExtendedInfo struct {
	DataDirectoryPaths     *[]SQLDataDirectory `json:"dataDirectoryPaths,omitempty"`
	DataDirectoryTimeInUTC *string             `json:"dataDirectoryTimeInUTC,omitempty"`
}

func (*AzureWorkloadSQLRecoveryPointExtendedInfo) GetDataDirectoryTimeInUTCAsTime

func (o *AzureWorkloadSQLRecoveryPointExtendedInfo) GetDataDirectoryTimeInUTCAsTime() (*time.Time, error)

func (*AzureWorkloadSQLRecoveryPointExtendedInfo) SetDataDirectoryTimeInUTCAsTime

func (o *AzureWorkloadSQLRecoveryPointExtendedInfo) SetDataDirectoryTimeInUTCAsTime(input time.Time)

type BEKDetails

type BEKDetails struct {
	SecretData    *string `json:"secretData,omitempty"`
	SecretUrl     *string `json:"secretUrl,omitempty"`
	SecretVaultId *string `json:"secretVaultId,omitempty"`
}

type DiskInformation

type DiskInformation struct {
	Lun  *int64  `json:"lun,omitempty"`
	Name *string `json:"name,omitempty"`
}

type GenericRecoveryPoint

type GenericRecoveryPoint struct {
	FriendlyName                *string                  `json:"friendlyName,omitempty"`
	RecoveryPointAdditionalInfo *string                  `json:"recoveryPointAdditionalInfo,omitempty"`
	RecoveryPointProperties     *RecoveryPointProperties `json:"recoveryPointProperties,omitempty"`
	RecoveryPointTime           *string                  `json:"recoveryPointTime,omitempty"`
	RecoveryPointType           *string                  `json:"recoveryPointType,omitempty"`
}

func (GenericRecoveryPoint) MarshalJSON

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

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *RecoveryPointResource
}

type IaasVMRecoveryPoint

type IaasVMRecoveryPoint struct {
	IsInstantIlrSessionActive      *bool                                      `json:"isInstantIlrSessionActive,omitempty"`
	IsManagedVirtualMachine        *bool                                      `json:"isManagedVirtualMachine,omitempty"`
	IsSourceVMEncrypted            *bool                                      `json:"isSourceVMEncrypted,omitempty"`
	KeyAndSecret                   *KeyAndSecretDetails                       `json:"keyAndSecret,omitempty"`
	OriginalStorageAccountOption   *bool                                      `json:"originalStorageAccountOption,omitempty"`
	OsType                         *string                                    `json:"osType,omitempty"`
	RecoveryPointAdditionalInfo    *string                                    `json:"recoveryPointAdditionalInfo,omitempty"`
	RecoveryPointDiskConfiguration *RecoveryPointDiskConfiguration            `json:"recoveryPointDiskConfiguration,omitempty"`
	RecoveryPointMoveReadinessInfo *map[string]RecoveryPointMoveReadinessInfo `json:"recoveryPointMoveReadinessInfo,omitempty"`
	RecoveryPointProperties        *RecoveryPointProperties                   `json:"recoveryPointProperties,omitempty"`
	RecoveryPointTierDetails       *[]RecoveryPointTierInformation            `json:"recoveryPointTierDetails,omitempty"`
	RecoveryPointTime              *string                                    `json:"recoveryPointTime,omitempty"`
	RecoveryPointType              *string                                    `json:"recoveryPointType,omitempty"`
	SourceVMStorageType            *string                                    `json:"sourceVMStorageType,omitempty"`
	VirtualMachineSize             *string                                    `json:"virtualMachineSize,omitempty"`
	Zones                          *zones.Schema                              `json:"zones,omitempty"`
}

func (IaasVMRecoveryPoint) MarshalJSON

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

type KEKDetails

type KEKDetails struct {
	KeyBackupData *string `json:"keyBackupData,omitempty"`
	KeyUrl        *string `json:"keyUrl,omitempty"`
	KeyVaultId    *string `json:"keyVaultId,omitempty"`
}

type KeyAndSecretDetails

type KeyAndSecretDetails struct {
	BekDetails          *BEKDetails `json:"bekDetails,omitempty"`
	EncryptionMechanism *string     `json:"encryptionMechanism,omitempty"`
	KekDetails          *KEKDetails `json:"kekDetails,omitempty"`
}

type ListCompleteResult

type ListCompleteResult struct {
	Items []RecoveryPointResource
}

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]RecoveryPointResource
	// contains filtered or unexported fields
}

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

type PointInTimeRange

type PointInTimeRange struct {
	EndTime   *string `json:"endTime,omitempty"`
	StartTime *string `json:"startTime,omitempty"`
}

func (*PointInTimeRange) GetEndTimeAsTime

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

func (*PointInTimeRange) GetStartTimeAsTime

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

func (*PointInTimeRange) SetEndTimeAsTime

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

func (*PointInTimeRange) SetStartTimeAsTime

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

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) FromParseResult

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

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 RawRecoveryPointImpl

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

RawRecoveryPointImpl 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 RecoveryPoint

type RecoveryPoint interface {
}

type RecoveryPointDiskConfiguration

type RecoveryPointDiskConfiguration struct {
	ExcludedDiskList              *[]DiskInformation `json:"excludedDiskList,omitempty"`
	IncludedDiskList              *[]DiskInformation `json:"includedDiskList,omitempty"`
	NumberOfDisksAttachedToVM     *int64             `json:"numberOfDisksAttachedToVm,omitempty"`
	NumberOfDisksIncludedInBackup *int64             `json:"numberOfDisksIncludedInBackup,omitempty"`
}

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 RecoveryPointMoveReadinessInfo

type RecoveryPointMoveReadinessInfo struct {
	AdditionalInfo *string `json:"additionalInfo,omitempty"`
	IsReadyForMove *bool   `json:"isReadyForMove,omitempty"`
}

type RecoveryPointProperties

type RecoveryPointProperties struct {
	ExpiryTime    *string `json:"expiryTime,omitempty"`
	IsSoftDeleted *bool   `json:"isSoftDeleted,omitempty"`
	RuleName      *string `json:"ruleName,omitempty"`
}

type RecoveryPointResource

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

func (*RecoveryPointResource) UnmarshalJSON

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

type RecoveryPointResourceOperationPredicate

type RecoveryPointResourceOperationPredicate struct {
	ETag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (RecoveryPointResourceOperationPredicate) Matches

type RecoveryPointTierInformation

type RecoveryPointTierInformation struct {
	ExtendedInfo *map[string]string       `json:"extendedInfo,omitempty"`
	Status       *RecoveryPointTierStatus `json:"status,omitempty"`
	Type         *RecoveryPointTierType   `json:"type,omitempty"`
}

type RecoveryPointTierStatus

type RecoveryPointTierStatus string
const (
	RecoveryPointTierStatusDeleted    RecoveryPointTierStatus = "Deleted"
	RecoveryPointTierStatusDisabled   RecoveryPointTierStatus = "Disabled"
	RecoveryPointTierStatusInvalid    RecoveryPointTierStatus = "Invalid"
	RecoveryPointTierStatusRehydrated RecoveryPointTierStatus = "Rehydrated"
	RecoveryPointTierStatusValid      RecoveryPointTierStatus = "Valid"
)

type RecoveryPointTierType

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

type RecoveryPointsCrrClient

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

func NewRecoveryPointsCrrClientWithBaseURI

func NewRecoveryPointsCrrClientWithBaseURI(endpoint string) RecoveryPointsCrrClient

func (RecoveryPointsCrrClient) Get

Get ...

func (RecoveryPointsCrrClient) List

List ...

func (RecoveryPointsCrrClient) ListComplete

ListComplete retrieves all of the results into a single object

func (RecoveryPointsCrrClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type RestorePointType

type RestorePointType string
const (
	RestorePointTypeDifferential RestorePointType = "Differential"
	RestorePointTypeFull         RestorePointType = "Full"
	RestorePointTypeIncremental  RestorePointType = "Incremental"
	RestorePointTypeInvalid      RestorePointType = "Invalid"
	RestorePointTypeLog          RestorePointType = "Log"
)

type SQLDataDirectory

type SQLDataDirectory struct {
	LogicalName *string               `json:"logicalName,omitempty"`
	Path        *string               `json:"path,omitempty"`
	Type        *SQLDataDirectoryType `json:"type,omitempty"`
}

type SQLDataDirectoryType

type SQLDataDirectoryType string
const (
	SQLDataDirectoryTypeData    SQLDataDirectoryType = "Data"
	SQLDataDirectoryTypeInvalid SQLDataDirectoryType = "Invalid"
	SQLDataDirectoryTypeLog     SQLDataDirectoryType = "Log"
)

Jump to

Keyboard shortcuts

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