recoverypoints

package
v0.20231109.1104441 Latest Latest
Warning

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

 Go to latest Published: Nov 9, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

The recoverypoints SDK allows for interaction with the Azure Resource Manager Service recoveryservicessiterecovery (API Version 2023-01-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/2023-01-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", "vaultValue", "replicationFabricValue", "replicationProtectionContainerValue", "replicationProtectedItemValue", "recoveryPointValue")

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", "vaultValue", "replicationFabricValue", "replicationProtectionContainerValue", "replicationProtectedItemValue")

// 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"`
}

func (A2ARecoveryPointDetails) MarshalJSON 

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

type GetOperationResponse 

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

type InMageAzureV2RecoveryPointDetails 

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

func (InMageAzureV2RecoveryPointDetails) MarshalJSON 

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

type InMageRcmRecoveryPointDetails 

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

func (InMageRcmRecoveryPointDetails) MarshalJSON 

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

type ListByReplicationProtectedItemsCompleteResult 

type ListByReplicationProtectedItemsCompleteResult struct {
	Items []RecoveryPoint
}

type ListByReplicationProtectedItemsOperationResponse 

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

type ProviderSpecificRecoveryPointDetails 

type ProviderSpecificRecoveryPointDetails interface {
}

type RawProviderSpecificRecoveryPointDetailsImpl added in v0.20230807.1063129 

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

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

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

func (p RecoveryPointOperationPredicate) Matches(input RecoveryPoint) bool

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 added in v0.20230809.1081239 

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 

func (c RecoveryPointsClient) Get(ctx context.Context, id RecoveryPointId) (result GetOperationResponse, err error)

Get ...

func (RecoveryPointsClient) ListByReplicationProtectedItems 

func (c RecoveryPointsClient) ListByReplicationProtectedItems(ctx context.Context, id ReplicationProtectedItemId) (result ListByReplicationProtectedItemsOperationResponse, err error)

ListByReplicationProtectedItems ...

func (RecoveryPointsClient) ListByReplicationProtectedItemsComplete 

func (c RecoveryPointsClient) ListByReplicationProtectedItemsComplete(ctx context.Context, id ReplicationProtectedItemId) (ListByReplicationProtectedItemsCompleteResult, error)

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

func (id ReplicationProtectedItemId) ID() string

ID returns the formatted Replication Protected Item ID

func (ReplicationProtectedItemId) Segments 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.