volumesrelocation

README

github.com/hashicorp/go-azure-sdk/resource-manager/netapp/2022-11-01/volumesrelocation Documentation

The volumesrelocation SDK allows for interaction with the Azure Resource Manager Service netapp (API Version 2022-11-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/2022-11-01/volumesrelocation"

Client Initialization

client := volumesrelocation.NewVolumesRelocationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VolumesRelocationClient.VolumesFinalizeRelocation

ctx := context.TODO()
id := volumesrelocation.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue")

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

Example Usage: VolumesRelocationClient.VolumesRelocate

ctx := context.TODO()
id := volumesrelocation.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue")

payload := volumesrelocation.RelocateVolumeRequest{
	// ...
}


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

Example Usage: VolumesRelocationClient.VolumesRevertRelocation

ctx := context.TODO()
id := volumesrelocation.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue")

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

Documentation

Index

• func ValidateVolumeID(input interface{}, key string) (warnings []string, errors []error)
• type RelocateVolumeRequest
• 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) ID() string
  • func (id VolumeId) Segments() []resourceids.Segment
  • func (id VolumeId) String() string
• type VolumesFinalizeRelocationOperationResponse
• type VolumesRelocateOperationResponse
• type VolumesRelocationClient
  • func NewVolumesRelocationClientWithBaseURI(endpoint string) VolumesRelocationClient
  • func (c VolumesRelocationClient) VolumesFinalizeRelocation(ctx context.Context, id VolumeId) (result VolumesFinalizeRelocationOperationResponse, err error)
  • func (c VolumesRelocationClient) VolumesFinalizeRelocationThenPoll(ctx context.Context, id VolumeId) error
  • func (c VolumesRelocationClient) VolumesRelocate(ctx context.Context, id VolumeId, input RelocateVolumeRequest) (result VolumesRelocateOperationResponse, err error)
  • func (c VolumesRelocationClient) VolumesRelocateThenPoll(ctx context.Context, id VolumeId, input RelocateVolumeRequest) error
  • func (c VolumesRelocationClient) VolumesRevertRelocation(ctx context.Context, id VolumeId) (result VolumesRevertRelocationOperationResponse, err error)
  • func (c VolumesRelocationClient) VolumesRevertRelocationThenPoll(ctx context.Context, id VolumeId) error
• type VolumesRevertRelocationOperationResponse

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 RelocateVolumeRequest

type RelocateVolumeRequest struct {
	CreationToken *string `json:"creationToken,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) 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 VolumesFinalizeRelocationOperationResponse

type VolumesFinalizeRelocationOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type VolumesRelocateOperationResponse

type VolumesRelocateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type VolumesRelocationClient

type VolumesRelocationClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewVolumesRelocationClientWithBaseURI

func NewVolumesRelocationClientWithBaseURI(endpoint string) VolumesRelocationClient

func (VolumesRelocationClient) VolumesFinalizeRelocation

func (c VolumesRelocationClient) VolumesFinalizeRelocation(ctx context.Context, id VolumeId) (result VolumesFinalizeRelocationOperationResponse, err error)

VolumesFinalizeRelocation ...

func (VolumesRelocationClient) VolumesFinalizeRelocationThenPoll

func (c VolumesRelocationClient) VolumesFinalizeRelocationThenPoll(ctx context.Context, id VolumeId) error

VolumesFinalizeRelocationThenPoll performs VolumesFinalizeRelocation then polls until it's completed

func (VolumesRelocationClient) VolumesRelocate

func (c VolumesRelocationClient) VolumesRelocate(ctx context.Context, id VolumeId, input RelocateVolumeRequest) (result VolumesRelocateOperationResponse, err error)

VolumesRelocate ...

func (VolumesRelocationClient) VolumesRelocateThenPoll

func (c VolumesRelocationClient) VolumesRelocateThenPoll(ctx context.Context, id VolumeId, input RelocateVolumeRequest) error

VolumesRelocateThenPoll performs VolumesRelocate then polls until it's completed

func (VolumesRelocationClient) VolumesRevertRelocation

func (c VolumesRelocationClient) VolumesRevertRelocation(ctx context.Context, id VolumeId) (result VolumesRevertRelocationOperationResponse, err error)

VolumesRevertRelocation ...

func (VolumesRelocationClient) VolumesRevertRelocationThenPoll

func (c VolumesRelocationClient) VolumesRevertRelocationThenPoll(ctx context.Context, id VolumeId) error

VolumesRevertRelocationThenPoll performs VolumesRevertRelocation then polls until it's completed

type VolumesRevertRelocationOperationResponse

type VolumesRevertRelocationOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}