volumesonpremmigration

README

github.com/hashicorp/go-azure-sdk/resource-manager/netapp/2024-07-01/volumesonpremmigration Documentation

The volumesonpremmigration SDK allows for interaction with Azure Resource Manager netapp (API Version 2024-07-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/2024-07-01/volumesonpremmigration"

Client Initialization

client := volumesonpremmigration.NewVolumesOnPremMigrationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VolumesOnPremMigrationClient.VolumesAuthorizeExternalReplication

ctx := context.TODO()
id := volumesonpremmigration.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountName", "capacityPoolName", "volumeName")

if err := client.VolumesAuthorizeExternalReplicationThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: VolumesOnPremMigrationClient.VolumesPeerExternalCluster

ctx := context.TODO()
id := volumesonpremmigration.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountName", "capacityPoolName", "volumeName")

payload := volumesonpremmigration.PeerClusterForVolumeMigrationRequest{
	// ...
}


if err := client.VolumesPeerExternalClusterThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: VolumesOnPremMigrationClient.VolumesPerformReplicationTransfer

ctx := context.TODO()
id := volumesonpremmigration.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountName", "capacityPoolName", "volumeName")

if err := client.VolumesPerformReplicationTransferThenPoll(ctx, id); err != nil {
	// handle the error
}

Documentation

Index

• func ValidateVolumeID(input interface{}, key string) (warnings []string, errors []error)
• type ClusterPeerCommandResponse
• type PeerClusterForVolumeMigrationRequest
• type SVMPeerCommandResponse
• type VolumeId
  • func NewVolumeID(subscriptionId string, resourceGroupName string, netAppAccountName string, ...) VolumeId
  • func ParseVolumeID(input string) (*VolumeId, error)
  • func ParseVolumeIDInsensitively(input string) (*VolumeId, error)
  • func (id *VolumeId) FromParseResult(input resourceids.ParseResult) error
  • func (id VolumeId) ID() string
  • func (id VolumeId) Segments() []resourceids.Segment
  • func (id VolumeId) String() string
• type VolumesAuthorizeExternalReplicationOperationResponse
• type VolumesOnPremMigrationClient
  • func NewVolumesOnPremMigrationClientWithBaseURI(sdkApi sdkEnv.Api) (*VolumesOnPremMigrationClient, error)
  • func (c VolumesOnPremMigrationClient) VolumesAuthorizeExternalReplication(ctx context.Context, id VolumeId) (result VolumesAuthorizeExternalReplicationOperationResponse, err error)
  • func (c VolumesOnPremMigrationClient) VolumesAuthorizeExternalReplicationThenPoll(ctx context.Context, id VolumeId) error
  • func (c VolumesOnPremMigrationClient) VolumesPeerExternalCluster(ctx context.Context, id VolumeId, input PeerClusterForVolumeMigrationRequest) (result VolumesPeerExternalClusterOperationResponse, err error)
  • func (c VolumesOnPremMigrationClient) VolumesPeerExternalClusterThenPoll(ctx context.Context, id VolumeId, input PeerClusterForVolumeMigrationRequest) error
  • func (c VolumesOnPremMigrationClient) VolumesPerformReplicationTransfer(ctx context.Context, id VolumeId) (result VolumesPerformReplicationTransferOperationResponse, err error)
  • func (c VolumesOnPremMigrationClient) VolumesPerformReplicationTransferThenPoll(ctx context.Context, id VolumeId) error
• type VolumesPeerExternalClusterOperationResponse
• type VolumesPerformReplicationTransferOperationResponse

Functions

func ValidateVolumeID

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

ValidateVolumeID checks that 'input' can be parsed as a Volume ID

Types

type ClusterPeerCommandResponse

type ClusterPeerCommandResponse struct {
	PeerAcceptCommand *string `json:"peerAcceptCommand,omitempty"`
}

type PeerClusterForVolumeMigrationRequest

type PeerClusterForVolumeMigrationRequest struct {
	PeerIPAddresses []string `json:"peerIpAddresses"`
}

type SVMPeerCommandResponse

type SVMPeerCommandResponse struct {
	SVMPeeringCommand *string `json:"svmPeeringCommand,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

func ParseVolumeID(input string) (*VolumeId, error)

ParseVolumeID parses 'input' into a VolumeId

func ParseVolumeIDInsensitively

func ParseVolumeIDInsensitively(input string) (*VolumeId, error)

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

func (id VolumeId) ID() string

ID returns the formatted Volume ID

func (VolumeId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Volume ID

func (VolumeId) String

func (id VolumeId) String() string

String returns a human-readable description of this Volume ID

type VolumesAuthorizeExternalReplicationOperationResponse

type VolumesAuthorizeExternalReplicationOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SVMPeerCommandResponse
}

type VolumesOnPremMigrationClient

type VolumesOnPremMigrationClient struct {
	Client *resourcemanager.Client
}

func NewVolumesOnPremMigrationClientWithBaseURI

func NewVolumesOnPremMigrationClientWithBaseURI(sdkApi sdkEnv.Api) (*VolumesOnPremMigrationClient, error)

func (VolumesOnPremMigrationClient) VolumesAuthorizeExternalReplication

func (c VolumesOnPremMigrationClient) VolumesAuthorizeExternalReplication(ctx context.Context, id VolumeId) (result VolumesAuthorizeExternalReplicationOperationResponse, err error)

VolumesAuthorizeExternalReplication ...

func (VolumesOnPremMigrationClient) VolumesAuthorizeExternalReplicationThenPoll

func (c VolumesOnPremMigrationClient) VolumesAuthorizeExternalReplicationThenPoll(ctx context.Context, id VolumeId) error

VolumesAuthorizeExternalReplicationThenPoll performs VolumesAuthorizeExternalReplication then polls until it's completed

func (VolumesOnPremMigrationClient) VolumesPeerExternalCluster

func (c VolumesOnPremMigrationClient) VolumesPeerExternalCluster(ctx context.Context, id VolumeId, input PeerClusterForVolumeMigrationRequest) (result VolumesPeerExternalClusterOperationResponse, err error)

VolumesPeerExternalCluster ...

func (VolumesOnPremMigrationClient) VolumesPeerExternalClusterThenPoll

func (c VolumesOnPremMigrationClient) VolumesPeerExternalClusterThenPoll(ctx context.Context, id VolumeId, input PeerClusterForVolumeMigrationRequest) error

VolumesPeerExternalClusterThenPoll performs VolumesPeerExternalCluster then polls until it's completed

func (VolumesOnPremMigrationClient) VolumesPerformReplicationTransfer

func (c VolumesOnPremMigrationClient) VolumesPerformReplicationTransfer(ctx context.Context, id VolumeId) (result VolumesPerformReplicationTransferOperationResponse, err error)

VolumesPerformReplicationTransfer ...

func (VolumesOnPremMigrationClient) VolumesPerformReplicationTransferThenPoll

func (c VolumesOnPremMigrationClient) VolumesPerformReplicationTransferThenPoll(ctx context.Context, id VolumeId) error

VolumesPerformReplicationTransferThenPoll performs VolumesPerformReplicationTransfer then polls until it's completed

type VolumesPeerExternalClusterOperationResponse

type VolumesPeerExternalClusterOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ClusterPeerCommandResponse
}

type VolumesPerformReplicationTransferOperationResponse

type VolumesPerformReplicationTransferOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}