clusterrecoverypoints

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicessiterecovery/2024-02-01/clusterrecoverypoints Documentation

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

Client Initialization

client := clusterrecoverypoints.NewClusterRecoveryPointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ClusterRecoveryPointsClient.ListByReplicationProtectionCluster

ctx := context.TODO()
id := clusterrecoverypoints.NewReplicationProtectionClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationFabricValue", "replicationProtectionContainerValue", "replicationProtectionClusterValue")

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

Documentation

Index

• func PossibleValuesForClusterRecoveryPointType() []string
• func PossibleValuesForRecoveryPointSyncType() []string
• func ValidateReplicationProtectionClusterID(input interface{}, key string) (warnings []string, errors []error)
• type A2AClusterRecoveryPointDetails
  • func (s A2AClusterRecoveryPointDetails) MarshalJSON() ([]byte, error)
• type ClusterProviderSpecificRecoveryPointDetails
• type ClusterRecoveryPoint
• type ClusterRecoveryPointOperationPredicate
  • func (p ClusterRecoveryPointOperationPredicate) Matches(input ClusterRecoveryPoint) bool
• type ClusterRecoveryPointProperties
  • func (o *ClusterRecoveryPointProperties) GetRecoveryPointTimeAsTime() (*time.Time, error)
  • func (o *ClusterRecoveryPointProperties) SetRecoveryPointTimeAsTime(input time.Time)
  • func (s *ClusterRecoveryPointProperties) UnmarshalJSON(bytes []byte) error
• type ClusterRecoveryPointType
  • func (s *ClusterRecoveryPointType) UnmarshalJSON(bytes []byte) error
• type ClusterRecoveryPointsClient
  • func NewClusterRecoveryPointsClientWithBaseURI(sdkApi sdkEnv.Api) (*ClusterRecoveryPointsClient, error)
  • func (c ClusterRecoveryPointsClient) ListByReplicationProtectionCluster(ctx context.Context, id ReplicationProtectionClusterId) (result ListByReplicationProtectionClusterOperationResponse, err error)
  • func (c ClusterRecoveryPointsClient) ListByReplicationProtectionClusterComplete(ctx context.Context, id ReplicationProtectionClusterId) (ListByReplicationProtectionClusterCompleteResult, error)
  • func (c ClusterRecoveryPointsClient) ListByReplicationProtectionClusterCompleteMatchingPredicate(ctx context.Context, id ReplicationProtectionClusterId, ...) (result ListByReplicationProtectionClusterCompleteResult, err error)
• type ListByReplicationProtectionClusterCompleteResult
• type ListByReplicationProtectionClusterOperationResponse
• type RawClusterProviderSpecificRecoveryPointDetailsImpl
• type RecoveryPointSyncType
  • func (s *RecoveryPointSyncType) UnmarshalJSON(bytes []byte) error
• type ReplicationProtectionClusterId
  • func NewReplicationProtectionClusterID(subscriptionId string, resourceGroupName string, vaultName string, ...) ReplicationProtectionClusterId
  • func ParseReplicationProtectionClusterID(input string) (*ReplicationProtectionClusterId, error)
  • func ParseReplicationProtectionClusterIDInsensitively(input string) (*ReplicationProtectionClusterId, error)
  • func (id *ReplicationProtectionClusterId) FromParseResult(input resourceids.ParseResult) error
  • func (id ReplicationProtectionClusterId) ID() string
  • func (id ReplicationProtectionClusterId) Segments() []resourceids.Segment
  • func (id ReplicationProtectionClusterId) String() string

Functions

func PossibleValuesForClusterRecoveryPointType

func PossibleValuesForClusterRecoveryPointType() []string

func PossibleValuesForRecoveryPointSyncType

func PossibleValuesForRecoveryPointSyncType() []string

func ValidateReplicationProtectionClusterID

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

ValidateReplicationProtectionClusterID checks that 'input' can be parsed as a Replication Protection Cluster ID

Types

type A2AClusterRecoveryPointDetails

type A2AClusterRecoveryPointDetails struct {
	Nodes                 *[]string              `json:"nodes,omitempty"`
	RecoveryPointSyncType *RecoveryPointSyncType `json:"recoveryPointSyncType,omitempty"`
}

func (A2AClusterRecoveryPointDetails) MarshalJSON

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

type ClusterProviderSpecificRecoveryPointDetails

type ClusterProviderSpecificRecoveryPointDetails interface {
}

type ClusterRecoveryPoint

type ClusterRecoveryPoint struct {
	Id         *string                         `json:"id,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties *ClusterRecoveryPointProperties `json:"properties,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type ClusterRecoveryPointOperationPredicate

type ClusterRecoveryPointOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (ClusterRecoveryPointOperationPredicate) Matches

func (p ClusterRecoveryPointOperationPredicate) Matches(input ClusterRecoveryPoint) bool

type ClusterRecoveryPointProperties

type ClusterRecoveryPointProperties struct {
	ProviderSpecificDetails ClusterProviderSpecificRecoveryPointDetails `json:"providerSpecificDetails"`
	RecoveryPointTime       *string                                     `json:"recoveryPointTime,omitempty"`
	RecoveryPointType       *ClusterRecoveryPointType                   `json:"recoveryPointType,omitempty"`
}

func (*ClusterRecoveryPointProperties) GetRecoveryPointTimeAsTime

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

func (*ClusterRecoveryPointProperties) SetRecoveryPointTimeAsTime

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

func (*ClusterRecoveryPointProperties) UnmarshalJSON

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

type ClusterRecoveryPointType

type ClusterRecoveryPointType string

const (
	ClusterRecoveryPointTypeApplicationConsistent ClusterRecoveryPointType = "ApplicationConsistent"
	ClusterRecoveryPointTypeCrashConsistent       ClusterRecoveryPointType = "CrashConsistent"
	ClusterRecoveryPointTypeNotSpecified          ClusterRecoveryPointType = "NotSpecified"
)

func (*ClusterRecoveryPointType) UnmarshalJSON

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

type ClusterRecoveryPointsClient

type ClusterRecoveryPointsClient struct {
	Client *resourcemanager.Client
}

func NewClusterRecoveryPointsClientWithBaseURI

func NewClusterRecoveryPointsClientWithBaseURI(sdkApi sdkEnv.Api) (*ClusterRecoveryPointsClient, error)

func (ClusterRecoveryPointsClient) ListByReplicationProtectionCluster

func (c ClusterRecoveryPointsClient) ListByReplicationProtectionCluster(ctx context.Context, id ReplicationProtectionClusterId) (result ListByReplicationProtectionClusterOperationResponse, err error)

ListByReplicationProtectionCluster ...

func (ClusterRecoveryPointsClient) ListByReplicationProtectionClusterComplete

func (c ClusterRecoveryPointsClient) ListByReplicationProtectionClusterComplete(ctx context.Context, id ReplicationProtectionClusterId) (ListByReplicationProtectionClusterCompleteResult, error)

ListByReplicationProtectionClusterComplete retrieves all the results into a single object

func (ClusterRecoveryPointsClient) ListByReplicationProtectionClusterCompleteMatchingPredicate

func (c ClusterRecoveryPointsClient) ListByReplicationProtectionClusterCompleteMatchingPredicate(ctx context.Context, id ReplicationProtectionClusterId, predicate ClusterRecoveryPointOperationPredicate) (result ListByReplicationProtectionClusterCompleteResult, err error)

ListByReplicationProtectionClusterCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListByReplicationProtectionClusterCompleteResult

type ListByReplicationProtectionClusterCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ClusterRecoveryPoint
}

type ListByReplicationProtectionClusterOperationResponse

type ListByReplicationProtectionClusterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ClusterRecoveryPoint
}

type RawClusterProviderSpecificRecoveryPointDetailsImpl

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

RawClusterProviderSpecificRecoveryPointDetailsImpl 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 RecoveryPointSyncType

type RecoveryPointSyncType string

const (
	RecoveryPointSyncTypeMultiVMSyncRecoveryPoint RecoveryPointSyncType = "MultiVmSyncRecoveryPoint"
)

func (*RecoveryPointSyncType) UnmarshalJSON

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

type ReplicationProtectionClusterId

type ReplicationProtectionClusterId struct {
	SubscriptionId                     string
	ResourceGroupName                  string
	VaultName                          string
	ReplicationFabricName              string
	ReplicationProtectionContainerName string
	ReplicationProtectionClusterName   string
}

ReplicationProtectionClusterId is a struct representing the Resource ID for a Replication Protection Cluster

func NewReplicationProtectionClusterID

func NewReplicationProtectionClusterID(subscriptionId string, resourceGroupName string, vaultName string, replicationFabricName string, replicationProtectionContainerName string, replicationProtectionClusterName string) ReplicationProtectionClusterId

NewReplicationProtectionClusterID returns a new ReplicationProtectionClusterId struct

func ParseReplicationProtectionClusterID

func ParseReplicationProtectionClusterID(input string) (*ReplicationProtectionClusterId, error)

ParseReplicationProtectionClusterID parses 'input' into a ReplicationProtectionClusterId

func ParseReplicationProtectionClusterIDInsensitively

func ParseReplicationProtectionClusterIDInsensitively(input string) (*ReplicationProtectionClusterId, error)

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

func (*ReplicationProtectionClusterId) FromParseResult

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

func (ReplicationProtectionClusterId) ID

func (id ReplicationProtectionClusterId) ID() string

ID returns the formatted Replication Protection Cluster ID

func (ReplicationProtectionClusterId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Replication Protection Cluster ID

func (ReplicationProtectionClusterId) String

func (id ReplicationProtectionClusterId) String() string

String returns a human-readable description of this Replication Protection Cluster ID