recoverypoints

package
v0.20241206.1180327 Latest Latest
Warning

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

Go to latest
Published: Dec 6, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicessiterecovery/2024-04-01/recoverypoints Documentation

The recoverypoints SDK allows for interaction with Azure Resource Manager recoveryservicessiterecovery (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/recoveryservicessiterecovery/2024-04-01/recoverypoints"

Client Initialization

client := recoverypoints.NewRecoveryPointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RecoveryPointsClient.Get

ctx := context.TODO()
id := recoverypoints.NewRecoveryPointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultName", "replicationFabricName", "replicationProtectionContainerName", "replicationProtectedItemName", "recoveryPointName")

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: RecoveryPointsClient.ListByReplicationProtectedItems

ctx := context.TODO()
id := recoverypoints.NewReplicationProtectedItemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultName", "replicationFabricName", "replicationProtectionContainerName", "replicationProtectedItemName")

// alternatively `client.ListByReplicationProtectedItems(ctx, id)` can be used to do batched pagination
items, err := client.ListByReplicationProtectedItemsComplete(ctx, id)
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 PossibleValuesForRecoveryPointSyncType

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

func ValidateReplicationProtectedItemID

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

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

Types

type A2ARecoveryPointDetails

type A2ARecoveryPointDetails struct {
	Disks                 *[]string              `json:"disks,omitempty"`
	RecoveryPointSyncType *RecoveryPointSyncType `json:"recoveryPointSyncType,omitempty"`

	InstanceType string `json:"instanceType"`
}

func (A2ARecoveryPointDetails) MarshalJSON

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

func (A2ARecoveryPointDetails) ProviderSpecificRecoveryPointDetails added in v0.20240920.1135249

func (s A2ARecoveryPointDetails) ProviderSpecificRecoveryPointDetails() BaseProviderSpecificRecoveryPointDetailsImpl

type BaseProviderSpecificRecoveryPointDetailsImpl added in v0.20240920.1135249

type BaseProviderSpecificRecoveryPointDetailsImpl struct {
	InstanceType string `json:"instanceType"`
}

func (BaseProviderSpecificRecoveryPointDetailsImpl) ProviderSpecificRecoveryPointDetails added in v0.20240920.1135249

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RecoveryPoint
}

type InMageAzureV2RecoveryPointDetails

type InMageAzureV2RecoveryPointDetails struct {
	IsMultiVMSyncPoint *string `json:"isMultiVmSyncPoint,omitempty"`

	InstanceType string `json:"instanceType"`
}

func (InMageAzureV2RecoveryPointDetails) MarshalJSON

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

func (InMageAzureV2RecoveryPointDetails) ProviderSpecificRecoveryPointDetails added in v0.20240920.1135249

type InMageRcmRecoveryPointDetails

type InMageRcmRecoveryPointDetails struct {
	IsMultiVMSyncPoint *string `json:"isMultiVmSyncPoint,omitempty"`

	InstanceType string `json:"instanceType"`
}

func (InMageRcmRecoveryPointDetails) MarshalJSON

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

func (InMageRcmRecoveryPointDetails) ProviderSpecificRecoveryPointDetails added in v0.20240920.1135249

func (s InMageRcmRecoveryPointDetails) ProviderSpecificRecoveryPointDetails() BaseProviderSpecificRecoveryPointDetailsImpl

type ListByReplicationProtectedItemsCompleteResult

type ListByReplicationProtectedItemsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RecoveryPoint
}

type ListByReplicationProtectedItemsCustomPager added in v0.20240628.1153531

type ListByReplicationProtectedItemsCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

type ListByReplicationProtectedItemsOperationResponse

type ListByReplicationProtectedItemsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RecoveryPoint
}

type ProviderSpecificRecoveryPointDetails

type ProviderSpecificRecoveryPointDetails interface {
	ProviderSpecificRecoveryPointDetails() BaseProviderSpecificRecoveryPointDetailsImpl
}

func UnmarshalProviderSpecificRecoveryPointDetailsImplementation added in v0.20240920.1135249

func UnmarshalProviderSpecificRecoveryPointDetailsImplementation(input []byte) (ProviderSpecificRecoveryPointDetails, error)

type RawProviderSpecificRecoveryPointDetailsImpl

type RawProviderSpecificRecoveryPointDetailsImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawProviderSpecificRecoveryPointDetailsImpl 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).

func (RawProviderSpecificRecoveryPointDetailsImpl) ProviderSpecificRecoveryPointDetails added in v0.20240920.1135249

type RecoveryPoint

type RecoveryPoint struct {
	Id         *string                  `json:"id,omitempty"`
	Location   *string                  `json:"location,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Properties *RecoveryPointProperties `json:"properties,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type RecoveryPointId

type RecoveryPointId struct {
	SubscriptionId                     string
	ResourceGroupName                  string
	VaultName                          string
	ReplicationFabricName              string
	ReplicationProtectionContainerName string
	ReplicationProtectedItemName       string
	RecoveryPointName                  string
}

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

func NewRecoveryPointID

func NewRecoveryPointID(subscriptionId string, resourceGroupName string, vaultName string, replicationFabricName string, replicationProtectionContainerName string, replicationProtectedItemName string, recoveryPointName 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 RecoveryPointOperationPredicate

type RecoveryPointOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (RecoveryPointOperationPredicate) Matches

type RecoveryPointProperties

type RecoveryPointProperties struct {
	ProviderSpecificDetails ProviderSpecificRecoveryPointDetails `json:"providerSpecificDetails"`
	RecoveryPointTime       *string                              `json:"recoveryPointTime,omitempty"`
	RecoveryPointType       *string                              `json:"recoveryPointType,omitempty"`
}

func (*RecoveryPointProperties) GetRecoveryPointTimeAsTime

func (o *RecoveryPointProperties) GetRecoveryPointTimeAsTime() (*time.Time, error)

func (*RecoveryPointProperties) SetRecoveryPointTimeAsTime

func (o *RecoveryPointProperties) SetRecoveryPointTimeAsTime(input time.Time)

func (*RecoveryPointProperties) UnmarshalJSON

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

type RecoveryPointSyncType

type RecoveryPointSyncType string
const (
	RecoveryPointSyncTypeMultiVMSyncRecoveryPoint RecoveryPointSyncType = "MultiVmSyncRecoveryPoint"
	RecoveryPointSyncTypePerVMRecoveryPoint       RecoveryPointSyncType = "PerVmRecoveryPoint"
)

func (*RecoveryPointSyncType) UnmarshalJSON

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

type RecoveryPointsClient

type RecoveryPointsClient struct {
	Client *resourcemanager.Client
}

func NewRecoveryPointsClientWithBaseURI

func NewRecoveryPointsClientWithBaseURI(sdkApi sdkEnv.Api) (*RecoveryPointsClient, error)

func (RecoveryPointsClient) Get

Get ...

func (RecoveryPointsClient) ListByReplicationProtectedItems

ListByReplicationProtectedItems ...

func (RecoveryPointsClient) ListByReplicationProtectedItemsComplete

ListByReplicationProtectedItemsComplete retrieves all the results into a single object

func (RecoveryPointsClient) ListByReplicationProtectedItemsCompleteMatchingPredicate

func (c RecoveryPointsClient) ListByReplicationProtectedItemsCompleteMatchingPredicate(ctx context.Context, id ReplicationProtectedItemId, predicate RecoveryPointOperationPredicate) (result ListByReplicationProtectedItemsCompleteResult, err error)

ListByReplicationProtectedItemsCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ReplicationProtectedItemId

type ReplicationProtectedItemId struct {
	SubscriptionId                     string
	ResourceGroupName                  string
	VaultName                          string
	ReplicationFabricName              string
	ReplicationProtectionContainerName string
	ReplicationProtectedItemName       string
}

ReplicationProtectedItemId is a struct representing the Resource ID for a Replication Protected Item

func NewReplicationProtectedItemID

func NewReplicationProtectedItemID(subscriptionId string, resourceGroupName string, vaultName string, replicationFabricName string, replicationProtectionContainerName string, replicationProtectedItemName string) ReplicationProtectedItemId

NewReplicationProtectedItemID returns a new ReplicationProtectedItemId struct

func ParseReplicationProtectedItemID

func ParseReplicationProtectedItemID(input string) (*ReplicationProtectedItemId, error)

ParseReplicationProtectedItemID parses 'input' into a ReplicationProtectedItemId

func ParseReplicationProtectedItemIDInsensitively

func ParseReplicationProtectedItemIDInsensitively(input string) (*ReplicationProtectedItemId, error)

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

func (*ReplicationProtectedItemId) FromParseResult

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

func (ReplicationProtectedItemId) ID

ID returns the formatted Replication Protected Item ID

func (ReplicationProtectedItemId) Segments

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

func (ReplicationProtectedItemId) String

func (id ReplicationProtectedItemId) String() string

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

Jump to

Keyboard shortcuts

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