poolchange

README

github.com/hashicorp/go-azure-sdk/resource-manager/netapp/2023-05-01/poolchange Documentation

The poolchange SDK allows for interaction with the Azure Resource Manager Service 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/poolchange"

Client Initialization

client := poolchange.NewPoolChangeClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PoolChangeClient.VolumesPoolChange

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

payload := poolchange.PoolChangeRequest{
	// ...
}


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

Documentation

Index

• func ValidateVolumeID(input interface{}, key string) (warnings []string, errors []error)
• type PoolChangeClient
  • func NewPoolChangeClientWithBaseURI(sdkApi sdkEnv.Api) (*PoolChangeClient, error)
  • func (c PoolChangeClient) VolumesPoolChange(ctx context.Context, id VolumeId, input PoolChangeRequest) (result VolumesPoolChangeOperationResponse, err error)
  • func (c PoolChangeClient) VolumesPoolChangeThenPoll(ctx context.Context, id VolumeId, input PoolChangeRequest) error
• type PoolChangeRequest
• 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 VolumesPoolChangeOperationResponse

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 PoolChangeClient

type PoolChangeClient struct {
	Client *resourcemanager.Client
}

func NewPoolChangeClientWithBaseURI

func NewPoolChangeClientWithBaseURI(sdkApi sdkEnv.Api) (*PoolChangeClient, error)

func (PoolChangeClient) VolumesPoolChange

func (c PoolChangeClient) VolumesPoolChange(ctx context.Context, id VolumeId, input PoolChangeRequest) (result VolumesPoolChangeOperationResponse, err error)

VolumesPoolChange ...

func (PoolChangeClient) VolumesPoolChangeThenPoll

func (c PoolChangeClient) VolumesPoolChangeThenPoll(ctx context.Context, id VolumeId, input PoolChangeRequest) error

VolumesPoolChangeThenPoll performs VolumesPoolChange then polls until it's completed

type PoolChangeRequest

type PoolChangeRequest struct {
	NewPoolResourceId string `json:"newPoolResourceId"`
}

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 VolumesPoolChangeOperationResponse

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