README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/netapp/2023-05-01/volumesreplication
Documentation
The volumesreplication
SDK allows for interaction with Azure Resource Manager netapp
(API Version 2023-05-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/netapp/2023-05-01/volumesreplication"
Client Initialization
client := volumesreplication.NewVolumesReplicationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: VolumesReplicationClient.VolumesAuthorizeReplication
ctx := context.TODO()
id := volumesreplication.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountName", "capacityPoolName", "volumeName")
payload := volumesreplication.AuthorizeRequest{
// ...
}
if err := client.VolumesAuthorizeReplicationThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: VolumesReplicationClient.VolumesBreakReplication
ctx := context.TODO()
id := volumesreplication.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountName", "capacityPoolName", "volumeName")
payload := volumesreplication.BreakReplicationRequest{
// ...
}
if err := client.VolumesBreakReplicationThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: VolumesReplicationClient.VolumesDeleteReplication
ctx := context.TODO()
id := volumesreplication.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountName", "capacityPoolName", "volumeName")
if err := client.VolumesDeleteReplicationThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: VolumesReplicationClient.VolumesListReplications
ctx := context.TODO()
id := volumesreplication.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountName", "capacityPoolName", "volumeName")
read, err := client.VolumesListReplications(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: VolumesReplicationClient.VolumesReInitializeReplication
ctx := context.TODO()
id := volumesreplication.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountName", "capacityPoolName", "volumeName")
if err := client.VolumesReInitializeReplicationThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: VolumesReplicationClient.VolumesReestablishReplication
ctx := context.TODO()
id := volumesreplication.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountName", "capacityPoolName", "volumeName")
payload := volumesreplication.ReestablishReplicationRequest{
// ...
}
if err := client.VolumesReestablishReplicationThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: VolumesReplicationClient.VolumesReplicationStatus
ctx := context.TODO()
id := volumesreplication.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountName", "capacityPoolName", "volumeName")
read, err := client.VolumesReplicationStatus(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: VolumesReplicationClient.VolumesResyncReplication
ctx := context.TODO()
id := volumesreplication.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountName", "capacityPoolName", "volumeName")
if err := client.VolumesResyncReplicationThenPoll(ctx, id); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func PossibleValuesForEndpointType() []string
- func PossibleValuesForMirrorState() []string
- func PossibleValuesForRelationshipStatus() []string
- func PossibleValuesForReplicationSchedule() []string
- func ValidateVolumeID(input interface{}, key string) (warnings []string, errors []error)
- type AuthorizeRequest
- type BreakReplicationRequest
- type EndpointType
- type ListReplications
- type MirrorState
- type ReestablishReplicationRequest
- type RelationshipStatus
- type Replication
- type ReplicationSchedule
- type ReplicationStatus
- type VolumeId
- type VolumesAuthorizeReplicationOperationResponse
- type VolumesBreakReplicationOperationResponse
- type VolumesDeleteReplicationOperationResponse
- type VolumesListReplicationsOperationResponse
- type VolumesReInitializeReplicationOperationResponse
- type VolumesReestablishReplicationOperationResponse
- type VolumesReplicationClient
- func (c VolumesReplicationClient) VolumesAuthorizeReplication(ctx context.Context, id VolumeId, input AuthorizeRequest) (result VolumesAuthorizeReplicationOperationResponse, err error)
- func (c VolumesReplicationClient) VolumesAuthorizeReplicationThenPoll(ctx context.Context, id VolumeId, input AuthorizeRequest) error
- func (c VolumesReplicationClient) VolumesBreakReplication(ctx context.Context, id VolumeId, input BreakReplicationRequest) (result VolumesBreakReplicationOperationResponse, err error)
- func (c VolumesReplicationClient) VolumesBreakReplicationThenPoll(ctx context.Context, id VolumeId, input BreakReplicationRequest) error
- func (c VolumesReplicationClient) VolumesDeleteReplication(ctx context.Context, id VolumeId) (result VolumesDeleteReplicationOperationResponse, err error)
- func (c VolumesReplicationClient) VolumesDeleteReplicationThenPoll(ctx context.Context, id VolumeId) error
- func (c VolumesReplicationClient) VolumesListReplications(ctx context.Context, id VolumeId) (result VolumesListReplicationsOperationResponse, err error)
- func (c VolumesReplicationClient) VolumesReInitializeReplication(ctx context.Context, id VolumeId) (result VolumesReInitializeReplicationOperationResponse, err error)
- func (c VolumesReplicationClient) VolumesReInitializeReplicationThenPoll(ctx context.Context, id VolumeId) error
- func (c VolumesReplicationClient) VolumesReestablishReplication(ctx context.Context, id VolumeId, input ReestablishReplicationRequest) (result VolumesReestablishReplicationOperationResponse, err error)
- func (c VolumesReplicationClient) VolumesReestablishReplicationThenPoll(ctx context.Context, id VolumeId, input ReestablishReplicationRequest) error
- func (c VolumesReplicationClient) VolumesReplicationStatus(ctx context.Context, id VolumeId) (result VolumesReplicationStatusOperationResponse, err error)
- func (c VolumesReplicationClient) VolumesResyncReplication(ctx context.Context, id VolumeId) (result VolumesResyncReplicationOperationResponse, err error)
- func (c VolumesReplicationClient) VolumesResyncReplicationThenPoll(ctx context.Context, id VolumeId) error
- type VolumesReplicationStatusOperationResponse
- type VolumesResyncReplicationOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForEndpointType ¶
func PossibleValuesForEndpointType() []string
func PossibleValuesForMirrorState ¶
func PossibleValuesForMirrorState() []string
func PossibleValuesForRelationshipStatus ¶
func PossibleValuesForRelationshipStatus() []string
func PossibleValuesForReplicationSchedule ¶
func PossibleValuesForReplicationSchedule() []string
func ValidateVolumeID ¶
ValidateVolumeID checks that 'input' can be parsed as a Volume ID
Types ¶
type AuthorizeRequest ¶
type AuthorizeRequest struct {
RemoteVolumeResourceId *string `json:"remoteVolumeResourceId,omitempty"`
}
type BreakReplicationRequest ¶
type BreakReplicationRequest struct {
ForceBreakReplication *bool `json:"forceBreakReplication,omitempty"`
}
type EndpointType ¶
type EndpointType string
const ( EndpointTypeDst EndpointType = "dst" EndpointTypeSrc EndpointType = "src" )
func (*EndpointType) UnmarshalJSON ¶
func (s *EndpointType) UnmarshalJSON(bytes []byte) error
type ListReplications ¶
type ListReplications struct {
Value *[]Replication `json:"value,omitempty"`
}
type MirrorState ¶
type MirrorState string
const ( MirrorStateBroken MirrorState = "Broken" MirrorStateMirrored MirrorState = "Mirrored" MirrorStateUninitialized MirrorState = "Uninitialized" )
func (*MirrorState) UnmarshalJSON ¶
func (s *MirrorState) UnmarshalJSON(bytes []byte) error
type ReestablishReplicationRequest ¶
type ReestablishReplicationRequest struct {
SourceVolumeId *string `json:"sourceVolumeId,omitempty"`
}
type RelationshipStatus ¶
type RelationshipStatus string
const ( RelationshipStatusIdle RelationshipStatus = "Idle" RelationshipStatusTransferring RelationshipStatus = "Transferring" )
func (*RelationshipStatus) UnmarshalJSON ¶
func (s *RelationshipStatus) UnmarshalJSON(bytes []byte) error
type Replication ¶
type Replication struct { EndpointType *EndpointType `json:"endpointType,omitempty"` RemoteVolumeRegion *string `json:"remoteVolumeRegion,omitempty"` RemoteVolumeResourceId string `json:"remoteVolumeResourceId"` ReplicationSchedule *ReplicationSchedule `json:"replicationSchedule,omitempty"` }
type ReplicationSchedule ¶
type ReplicationSchedule string
const ( ReplicationScheduleDaily ReplicationSchedule = "daily" ReplicationScheduleHourly ReplicationSchedule = "hourly" ReplicationScheduleOneZerominutely ReplicationSchedule = "_10minutely" )
func (*ReplicationSchedule) UnmarshalJSON ¶
func (s *ReplicationSchedule) UnmarshalJSON(bytes []byte) error
type ReplicationStatus ¶
type ReplicationStatus struct { ErrorMessage *string `json:"errorMessage,omitempty"` Healthy *bool `json:"healthy,omitempty"` MirrorState *MirrorState `json:"mirrorState,omitempty"` RelationshipStatus *RelationshipStatus `json:"relationshipStatus,omitempty"` TotalProgress *string `json:"totalProgress,omitempty"` }
type VolumeId ¶
type VolumeId struct { SubscriptionId string ResourceGroupName string NetAppAccountName string CapacityPoolName string VolumeName string }
VolumeId is a struct representing the Resource ID for a Volume
func NewVolumeID ¶
func NewVolumeID(subscriptionId string, resourceGroupName string, netAppAccountName string, capacityPoolName string, volumeName string) VolumeId
NewVolumeID returns a new VolumeId struct
func ParseVolumeID ¶
ParseVolumeID parses 'input' into a VolumeId
func ParseVolumeIDInsensitively ¶
ParseVolumeIDInsensitively parses 'input' case-insensitively into a VolumeId note: this method should only be used for API response data and not user input
func (*VolumeId) FromParseResult ¶
func (id *VolumeId) FromParseResult(input resourceids.ParseResult) error
func (VolumeId) Segments ¶
func (id VolumeId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Volume ID
type VolumesListReplicationsOperationResponse ¶
type VolumesListReplicationsOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *ListReplications }
type VolumesReplicationClient ¶
type VolumesReplicationClient struct {
Client *resourcemanager.Client
}
func NewVolumesReplicationClientWithBaseURI ¶
func NewVolumesReplicationClientWithBaseURI(sdkApi sdkEnv.Api) (*VolumesReplicationClient, error)
func (VolumesReplicationClient) VolumesAuthorizeReplication ¶
func (c VolumesReplicationClient) VolumesAuthorizeReplication(ctx context.Context, id VolumeId, input AuthorizeRequest) (result VolumesAuthorizeReplicationOperationResponse, err error)
VolumesAuthorizeReplication ...
func (VolumesReplicationClient) VolumesAuthorizeReplicationThenPoll ¶
func (c VolumesReplicationClient) VolumesAuthorizeReplicationThenPoll(ctx context.Context, id VolumeId, input AuthorizeRequest) error
VolumesAuthorizeReplicationThenPoll performs VolumesAuthorizeReplication then polls until it's completed
func (VolumesReplicationClient) VolumesBreakReplication ¶
func (c VolumesReplicationClient) VolumesBreakReplication(ctx context.Context, id VolumeId, input BreakReplicationRequest) (result VolumesBreakReplicationOperationResponse, err error)
VolumesBreakReplication ...
func (VolumesReplicationClient) VolumesBreakReplicationThenPoll ¶
func (c VolumesReplicationClient) VolumesBreakReplicationThenPoll(ctx context.Context, id VolumeId, input BreakReplicationRequest) error
VolumesBreakReplicationThenPoll performs VolumesBreakReplication then polls until it's completed
func (VolumesReplicationClient) VolumesDeleteReplication ¶
func (c VolumesReplicationClient) VolumesDeleteReplication(ctx context.Context, id VolumeId) (result VolumesDeleteReplicationOperationResponse, err error)
VolumesDeleteReplication ...
func (VolumesReplicationClient) VolumesDeleteReplicationThenPoll ¶
func (c VolumesReplicationClient) VolumesDeleteReplicationThenPoll(ctx context.Context, id VolumeId) error
VolumesDeleteReplicationThenPoll performs VolumesDeleteReplication then polls until it's completed
func (VolumesReplicationClient) VolumesListReplications ¶
func (c VolumesReplicationClient) VolumesListReplications(ctx context.Context, id VolumeId) (result VolumesListReplicationsOperationResponse, err error)
VolumesListReplications ...
func (VolumesReplicationClient) VolumesReInitializeReplication ¶
func (c VolumesReplicationClient) VolumesReInitializeReplication(ctx context.Context, id VolumeId) (result VolumesReInitializeReplicationOperationResponse, err error)
VolumesReInitializeReplication ...
func (VolumesReplicationClient) VolumesReInitializeReplicationThenPoll ¶
func (c VolumesReplicationClient) VolumesReInitializeReplicationThenPoll(ctx context.Context, id VolumeId) error
VolumesReInitializeReplicationThenPoll performs VolumesReInitializeReplication then polls until it's completed
func (VolumesReplicationClient) VolumesReestablishReplication ¶
func (c VolumesReplicationClient) VolumesReestablishReplication(ctx context.Context, id VolumeId, input ReestablishReplicationRequest) (result VolumesReestablishReplicationOperationResponse, err error)
VolumesReestablishReplication ...
func (VolumesReplicationClient) VolumesReestablishReplicationThenPoll ¶
func (c VolumesReplicationClient) VolumesReestablishReplicationThenPoll(ctx context.Context, id VolumeId, input ReestablishReplicationRequest) error
VolumesReestablishReplicationThenPoll performs VolumesReestablishReplication then polls until it's completed
func (VolumesReplicationClient) VolumesReplicationStatus ¶
func (c VolumesReplicationClient) VolumesReplicationStatus(ctx context.Context, id VolumeId) (result VolumesReplicationStatusOperationResponse, err error)
VolumesReplicationStatus ...
func (VolumesReplicationClient) VolumesResyncReplication ¶
func (c VolumesReplicationClient) VolumesResyncReplication(ctx context.Context, id VolumeId) (result VolumesResyncReplicationOperationResponse, err error)
VolumesResyncReplication ...
func (VolumesReplicationClient) VolumesResyncReplicationThenPoll ¶
func (c VolumesReplicationClient) VolumesResyncReplicationThenPoll(ctx context.Context, id VolumeId) error
VolumesResyncReplicationThenPoll performs VolumesResyncReplication then polls until it's completed
type VolumesReplicationStatusOperationResponse ¶
type VolumesReplicationStatusOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *ReplicationStatus }
Source Files ¶
- client.go
- constants.go
- id_volume.go
- method_volumesauthorizereplication.go
- method_volumesbreakreplication.go
- method_volumesdeletereplication.go
- method_volumeslistreplications.go
- method_volumesreestablishreplication.go
- method_volumesreinitializereplication.go
- method_volumesreplicationstatus.go
- method_volumesresyncreplication.go
- model_authorizerequest.go
- model_breakreplicationrequest.go
- model_listreplications.go
- model_reestablishreplicationrequest.go
- model_replication.go
- model_replicationstatus.go
- version.go