restore

README

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

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

Client Initialization

client := restore.NewRestoreClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RestoreClient.BackupsGetVolumeRestoreStatus

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

read, err := client.BackupsGetVolumeRestoreStatus(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func PossibleValuesForMirrorState() []string
• func PossibleValuesForRelationshipStatus() []string
• func ValidateVolumeID(input interface{}, key string) (warnings []string, errors []error)
• type BackupsGetVolumeRestoreStatusOperationResponse
• type MirrorState
  • func (s *MirrorState) UnmarshalJSON(bytes []byte) error
• type RelationshipStatus
  • func (s *RelationshipStatus) UnmarshalJSON(bytes []byte) error
• type RestoreClient
  • func NewRestoreClientWithBaseURI(sdkApi sdkEnv.Api) (*RestoreClient, error)
  • func (c RestoreClient) BackupsGetVolumeRestoreStatus(ctx context.Context, id VolumeId) (result BackupsGetVolumeRestoreStatusOperationResponse, err error)
• type RestoreStatus
• 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

Functions

func PossibleValuesForMirrorState

func PossibleValuesForMirrorState() []string

func PossibleValuesForRelationshipStatus

func PossibleValuesForRelationshipStatus() []string

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 BackupsGetVolumeRestoreStatusOperationResponse

type BackupsGetVolumeRestoreStatusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RestoreStatus
}

type MirrorState

type MirrorState string

const (
	MirrorStateBroken        MirrorState = "Broken"
	MirrorStateMirrored      MirrorState = "Mirrored"
	MirrorStateUninitialized MirrorState = "Uninitialized"
)

func (*MirrorState) UnmarshalJSON

func (s *MirrorState) UnmarshalJSON(bytes []byte) error

type RelationshipStatus

type RelationshipStatus string

const (
	RelationshipStatusFailed       RelationshipStatus = "Failed"
	RelationshipStatusIdle         RelationshipStatus = "Idle"
	RelationshipStatusTransferring RelationshipStatus = "Transferring"
	RelationshipStatusUnknown      RelationshipStatus = "Unknown"
)

func (*RelationshipStatus) UnmarshalJSON

func (s *RelationshipStatus) UnmarshalJSON(bytes []byte) error

type RestoreClient

type RestoreClient struct {
	Client *resourcemanager.Client
}

func NewRestoreClientWithBaseURI

func NewRestoreClientWithBaseURI(sdkApi sdkEnv.Api) (*RestoreClient, error)

func (RestoreClient) BackupsGetVolumeRestoreStatus

func (c RestoreClient) BackupsGetVolumeRestoreStatus(ctx context.Context, id VolumeId) (result BackupsGetVolumeRestoreStatusOperationResponse, err error)

BackupsGetVolumeRestoreStatus ...

type RestoreStatus

type RestoreStatus struct {
	ErrorMessage       *string             `json:"errorMessage,omitempty"`
	Healthy            *bool               `json:"healthy,omitempty"`
	MirrorState        *MirrorState        `json:"mirrorState,omitempty"`
	RelationshipStatus *RelationshipStatus `json:"relationshipStatus,omitempty"`
	TotalTransferBytes *int64              `json:"totalTransferBytes,omitempty"`
	UnhealthyReason    *string             `json:"unhealthyReason,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