volumesrelocation

package
v0.20240603.1145333 Latest Latest
Warning

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

Go to latest
Published: Jun 3, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/netapp/2023-07-01/volumesrelocation Documentation

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

Constants

This section is empty.

Variables

This section is empty.

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

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

type VolumesRelocateOperationResponse

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

type VolumesRelocationClient

type VolumesRelocationClient struct {
	Client *resourcemanager.Client
}

func NewVolumesRelocationClientWithBaseURI

func NewVolumesRelocationClientWithBaseURI(sdkApi sdkEnv.Api) (*VolumesRelocationClient, error)

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

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       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL