filelocks

README

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

The filelocks 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/filelocks"

Client Initialization

client := filelocks.NewFileLocksClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FileLocksClient.VolumesBreakFileLocks

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

payload := filelocks.BreakFileLocksRequest{
	// ...
}


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

Documentation

Index

• func ValidateVolumeID(input interface{}, key string) (warnings []string, errors []error)
• type BreakFileLocksRequest
• type FileLocksClient
  • func NewFileLocksClientWithBaseURI(sdkApi sdkEnv.Api) (*FileLocksClient, error)
  • func (c FileLocksClient) VolumesBreakFileLocks(ctx context.Context, id VolumeId, input BreakFileLocksRequest) (result VolumesBreakFileLocksOperationResponse, err error)
  • func (c FileLocksClient) VolumesBreakFileLocksThenPoll(ctx context.Context, id VolumeId, input BreakFileLocksRequest) error
• 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 VolumesBreakFileLocksOperationResponse

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 BreakFileLocksRequest

type BreakFileLocksRequest struct {
	ClientIP                          *string `json:"clientIp,omitempty"`
	ConfirmRunningDisruptiveOperation *bool   `json:"confirmRunningDisruptiveOperation,omitempty"`
}

type FileLocksClient

type FileLocksClient struct {
	Client *resourcemanager.Client
}

func NewFileLocksClientWithBaseURI

func NewFileLocksClientWithBaseURI(sdkApi sdkEnv.Api) (*FileLocksClient, error)

func (FileLocksClient) VolumesBreakFileLocks

func (c FileLocksClient) VolumesBreakFileLocks(ctx context.Context, id VolumeId, input BreakFileLocksRequest) (result VolumesBreakFileLocksOperationResponse, err error)

VolumesBreakFileLocks ...

func (FileLocksClient) VolumesBreakFileLocksThenPoll

func (c FileLocksClient) VolumesBreakFileLocksThenPoll(ctx context.Context, id VolumeId, input BreakFileLocksRequest) error

VolumesBreakFileLocksThenPoll performs VolumesBreakFileLocks then polls until it's completed

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 VolumesBreakFileLocksOperationResponse

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