snapshotpolicylistvolumes

package
v0.20241209.1115630 Latest Latest
Warning

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

Go to latest
Published: Dec 9, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/netapp/2024-03-01/snapshotpolicylistvolumes Documentation

The snapshotpolicylistvolumes SDK allows for interaction with Azure Resource Manager netapp (API Version 2024-03-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/2024-03-01/snapshotpolicylistvolumes"

Client Initialization

client := snapshotpolicylistvolumes.NewSnapshotPolicyListVolumesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SnapshotPolicyListVolumesClient.SnapshotPoliciesListVolumes

ctx := context.TODO()
id := snapshotpolicylistvolumes.NewSnapshotPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountName", "snapshotPolicyName")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAvsDataStore

func PossibleValuesForAvsDataStore() []string

func PossibleValuesForChownMode

func PossibleValuesForChownMode() []string

func PossibleValuesForCoolAccessRetrievalPolicy

func PossibleValuesForCoolAccessRetrievalPolicy() []string

func PossibleValuesForEnableSubvolumes

func PossibleValuesForEnableSubvolumes() []string

func PossibleValuesForEncryptionKeySource

func PossibleValuesForEncryptionKeySource() []string

func PossibleValuesForEndpointType

func PossibleValuesForEndpointType() []string

func PossibleValuesForFileAccessLogs

func PossibleValuesForFileAccessLogs() []string

func PossibleValuesForNetworkFeatures

func PossibleValuesForNetworkFeatures() []string

func PossibleValuesForReplicationSchedule

func PossibleValuesForReplicationSchedule() []string

func PossibleValuesForSecurityStyle

func PossibleValuesForSecurityStyle() []string

func PossibleValuesForServiceLevel

func PossibleValuesForServiceLevel() []string

func PossibleValuesForSmbAccessBasedEnumeration

func PossibleValuesForSmbAccessBasedEnumeration() []string

func PossibleValuesForSmbNonBrowsable

func PossibleValuesForSmbNonBrowsable() []string

func PossibleValuesForVolumeStorageToNetworkProximity

func PossibleValuesForVolumeStorageToNetworkProximity() []string

func ValidateSnapshotPolicyID

func ValidateSnapshotPolicyID(input interface{}, key string) (warnings []string, errors []error)

ValidateSnapshotPolicyID checks that 'input' can be parsed as a Snapshot Policy ID

Types

type AvsDataStore

type AvsDataStore string
const (
	AvsDataStoreDisabled AvsDataStore = "Disabled"
	AvsDataStoreEnabled  AvsDataStore = "Enabled"
)

func (*AvsDataStore) UnmarshalJSON

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

type ChownMode

type ChownMode string
const (
	ChownModeRestricted   ChownMode = "Restricted"
	ChownModeUnrestricted ChownMode = "Unrestricted"
)

func (*ChownMode) UnmarshalJSON

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

type CoolAccessRetrievalPolicy

type CoolAccessRetrievalPolicy string
const (
	CoolAccessRetrievalPolicyDefault CoolAccessRetrievalPolicy = "Default"
	CoolAccessRetrievalPolicyNever   CoolAccessRetrievalPolicy = "Never"
	CoolAccessRetrievalPolicyOnRead  CoolAccessRetrievalPolicy = "OnRead"
)

func (*CoolAccessRetrievalPolicy) UnmarshalJSON

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

type EnableSubvolumes

type EnableSubvolumes string
const (
	EnableSubvolumesDisabled EnableSubvolumes = "Disabled"
	EnableSubvolumesEnabled  EnableSubvolumes = "Enabled"
)

func (*EnableSubvolumes) UnmarshalJSON

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

type EncryptionKeySource

type EncryptionKeySource string
const (
	EncryptionKeySourceMicrosoftPointKeyVault EncryptionKeySource = "Microsoft.KeyVault"
	EncryptionKeySourceMicrosoftPointNetApp   EncryptionKeySource = "Microsoft.NetApp"
)

func (*EncryptionKeySource) UnmarshalJSON

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

type EndpointType

type EndpointType string
const (
	EndpointTypeDst EndpointType = "dst"
	EndpointTypeSrc EndpointType = "src"
)

func (*EndpointType) UnmarshalJSON

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

type ExportPolicyRule

type ExportPolicyRule struct {
	AllowedClients      *string    `json:"allowedClients,omitempty"`
	ChownMode           *ChownMode `json:"chownMode,omitempty"`
	Cifs                *bool      `json:"cifs,omitempty"`
	HasRootAccess       *bool      `json:"hasRootAccess,omitempty"`
	Kerberos5ReadOnly   *bool      `json:"kerberos5ReadOnly,omitempty"`
	Kerberos5ReadWrite  *bool      `json:"kerberos5ReadWrite,omitempty"`
	Kerberos5iReadOnly  *bool      `json:"kerberos5iReadOnly,omitempty"`
	Kerberos5iReadWrite *bool      `json:"kerberos5iReadWrite,omitempty"`
	Kerberos5pReadOnly  *bool      `json:"kerberos5pReadOnly,omitempty"`
	Kerberos5pReadWrite *bool      `json:"kerberos5pReadWrite,omitempty"`
	Nfsv3               *bool      `json:"nfsv3,omitempty"`
	Nfsv41              *bool      `json:"nfsv41,omitempty"`
	RuleIndex           *int64     `json:"ruleIndex,omitempty"`
	UnixReadOnly        *bool      `json:"unixReadOnly,omitempty"`
	UnixReadWrite       *bool      `json:"unixReadWrite,omitempty"`
}

type FileAccessLogs

type FileAccessLogs string
const (
	FileAccessLogsDisabled FileAccessLogs = "Disabled"
	FileAccessLogsEnabled  FileAccessLogs = "Enabled"
)

func (*FileAccessLogs) UnmarshalJSON

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

type MountTargetProperties

type MountTargetProperties struct {
	FileSystemId  string  `json:"fileSystemId"`
	IPAddress     *string `json:"ipAddress,omitempty"`
	MountTargetId *string `json:"mountTargetId,omitempty"`
	SmbServerFqdn *string `json:"smbServerFqdn,omitempty"`
}

type NetworkFeatures

type NetworkFeatures string
const (
	NetworkFeaturesBasic         NetworkFeatures = "Basic"
	NetworkFeaturesBasicStandard NetworkFeatures = "Basic_Standard"
	NetworkFeaturesStandard      NetworkFeatures = "Standard"
	NetworkFeaturesStandardBasic NetworkFeatures = "Standard_Basic"
)

func (*NetworkFeatures) UnmarshalJSON

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

type PlacementKeyValuePairs

type PlacementKeyValuePairs struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type ReplicationObject

type ReplicationObject struct {
	EndpointType           *EndpointType        `json:"endpointType,omitempty"`
	RemoteVolumeRegion     *string              `json:"remoteVolumeRegion,omitempty"`
	RemoteVolumeResourceId string               `json:"remoteVolumeResourceId"`
	ReplicationId          *string              `json:"replicationId,omitempty"`
	ReplicationSchedule    *ReplicationSchedule `json:"replicationSchedule,omitempty"`
}

type ReplicationSchedule

type ReplicationSchedule string
const (
	ReplicationScheduleDaily           ReplicationSchedule = "daily"
	ReplicationScheduleHourly          ReplicationSchedule = "hourly"
	ReplicationScheduleOneZerominutely ReplicationSchedule = "_10minutely"
)

func (*ReplicationSchedule) UnmarshalJSON

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

type SecurityStyle

type SecurityStyle string
const (
	SecurityStyleNtfs SecurityStyle = "ntfs"
	SecurityStyleUnix SecurityStyle = "unix"
)

func (*SecurityStyle) UnmarshalJSON

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

type ServiceLevel

type ServiceLevel string
const (
	ServiceLevelPremium     ServiceLevel = "Premium"
	ServiceLevelStandard    ServiceLevel = "Standard"
	ServiceLevelStandardZRS ServiceLevel = "StandardZRS"
	ServiceLevelUltra       ServiceLevel = "Ultra"
)

func (*ServiceLevel) UnmarshalJSON

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

type SmbAccessBasedEnumeration

type SmbAccessBasedEnumeration string
const (
	SmbAccessBasedEnumerationDisabled SmbAccessBasedEnumeration = "Disabled"
	SmbAccessBasedEnumerationEnabled  SmbAccessBasedEnumeration = "Enabled"
)

func (*SmbAccessBasedEnumeration) UnmarshalJSON

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

type SmbNonBrowsable

type SmbNonBrowsable string
const (
	SmbNonBrowsableDisabled SmbNonBrowsable = "Disabled"
	SmbNonBrowsableEnabled  SmbNonBrowsable = "Enabled"
)

func (*SmbNonBrowsable) UnmarshalJSON

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

type SnapshotPoliciesListVolumesOperationResponse

type SnapshotPoliciesListVolumesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SnapshotPolicyVolumeList
}

type SnapshotPolicyId

type SnapshotPolicyId struct {
	SubscriptionId     string
	ResourceGroupName  string
	NetAppAccountName  string
	SnapshotPolicyName string
}

SnapshotPolicyId is a struct representing the Resource ID for a Snapshot Policy

func NewSnapshotPolicyID

func NewSnapshotPolicyID(subscriptionId string, resourceGroupName string, netAppAccountName string, snapshotPolicyName string) SnapshotPolicyId

NewSnapshotPolicyID returns a new SnapshotPolicyId struct

func ParseSnapshotPolicyID

func ParseSnapshotPolicyID(input string) (*SnapshotPolicyId, error)

ParseSnapshotPolicyID parses 'input' into a SnapshotPolicyId

func ParseSnapshotPolicyIDInsensitively

func ParseSnapshotPolicyIDInsensitively(input string) (*SnapshotPolicyId, error)

ParseSnapshotPolicyIDInsensitively parses 'input' case-insensitively into a SnapshotPolicyId note: this method should only be used for API response data and not user input

func (*SnapshotPolicyId) FromParseResult

func (id *SnapshotPolicyId) FromParseResult(input resourceids.ParseResult) error

func (SnapshotPolicyId) ID

func (id SnapshotPolicyId) ID() string

ID returns the formatted Snapshot Policy ID

func (SnapshotPolicyId) Segments

func (id SnapshotPolicyId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Snapshot Policy ID

func (SnapshotPolicyId) String

func (id SnapshotPolicyId) String() string

String returns a human-readable description of this Snapshot Policy ID

type SnapshotPolicyListVolumesClient

type SnapshotPolicyListVolumesClient struct {
	Client *resourcemanager.Client
}

func NewSnapshotPolicyListVolumesClientWithBaseURI

func NewSnapshotPolicyListVolumesClientWithBaseURI(sdkApi sdkEnv.Api) (*SnapshotPolicyListVolumesClient, error)

func (SnapshotPolicyListVolumesClient) SnapshotPoliciesListVolumes

SnapshotPoliciesListVolumes ...

type SnapshotPolicyVolumeList

type SnapshotPolicyVolumeList struct {
	Value *[]Volume `json:"value,omitempty"`
}

type Volume

type Volume struct {
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Location   string                 `json:"location"`
	Name       *string                `json:"name,omitempty"`
	Properties VolumeProperties       `json:"properties"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
	Zones      *zones.Schema          `json:"zones,omitempty"`
}

type VolumeBackupProperties

type VolumeBackupProperties struct {
	BackupPolicyId *string `json:"backupPolicyId,omitempty"`
	BackupVaultId  *string `json:"backupVaultId,omitempty"`
	PolicyEnforced *bool   `json:"policyEnforced,omitempty"`
}

type VolumeProperties

type VolumeProperties struct {
	ActualThroughputMibps             *float64                         `json:"actualThroughputMibps,omitempty"`
	AvsDataStore                      *AvsDataStore                    `json:"avsDataStore,omitempty"`
	BackupId                          *string                          `json:"backupId,omitempty"`
	BaremetalTenantId                 *string                          `json:"baremetalTenantId,omitempty"`
	CapacityPoolResourceId            *string                          `json:"capacityPoolResourceId,omitempty"`
	CloneProgress                     *int64                           `json:"cloneProgress,omitempty"`
	CoolAccess                        *bool                            `json:"coolAccess,omitempty"`
	CoolAccessRetrievalPolicy         *CoolAccessRetrievalPolicy       `json:"coolAccessRetrievalPolicy,omitempty"`
	CoolnessPeriod                    *int64                           `json:"coolnessPeriod,omitempty"`
	CreationToken                     string                           `json:"creationToken"`
	DataProtection                    *VolumePropertiesDataProtection  `json:"dataProtection,omitempty"`
	DataStoreResourceId               *[]string                        `json:"dataStoreResourceId,omitempty"`
	DefaultGroupQuotaInKiBs           *int64                           `json:"defaultGroupQuotaInKiBs,omitempty"`
	DefaultUserQuotaInKiBs            *int64                           `json:"defaultUserQuotaInKiBs,omitempty"`
	DeleteBaseSnapshot                *bool                            `json:"deleteBaseSnapshot,omitempty"`
	EnableSubvolumes                  *EnableSubvolumes                `json:"enableSubvolumes,omitempty"`
	Encrypted                         *bool                            `json:"encrypted,omitempty"`
	EncryptionKeySource               *EncryptionKeySource             `json:"encryptionKeySource,omitempty"`
	ExportPolicy                      *VolumePropertiesExportPolicy    `json:"exportPolicy,omitempty"`
	FileAccessLogs                    *FileAccessLogs                  `json:"fileAccessLogs,omitempty"`
	FileSystemId                      *string                          `json:"fileSystemId,omitempty"`
	IsDefaultQuotaEnabled             *bool                            `json:"isDefaultQuotaEnabled,omitempty"`
	IsLargeVolume                     *bool                            `json:"isLargeVolume,omitempty"`
	IsRestoring                       *bool                            `json:"isRestoring,omitempty"`
	KerberosEnabled                   *bool                            `json:"kerberosEnabled,omitempty"`
	KeyVaultPrivateEndpointResourceId *string                          `json:"keyVaultPrivateEndpointResourceId,omitempty"`
	LdapEnabled                       *bool                            `json:"ldapEnabled,omitempty"`
	MaximumNumberOfFiles              *int64                           `json:"maximumNumberOfFiles,omitempty"`
	MountTargets                      *[]MountTargetProperties         `json:"mountTargets,omitempty"`
	NetworkFeatures                   *NetworkFeatures                 `json:"networkFeatures,omitempty"`
	NetworkSiblingSetId               *string                          `json:"networkSiblingSetId,omitempty"`
	OriginatingResourceId             *string                          `json:"originatingResourceId,omitempty"`
	PlacementRules                    *[]PlacementKeyValuePairs        `json:"placementRules,omitempty"`
	ProtocolTypes                     *[]string                        `json:"protocolTypes,omitempty"`
	ProvisionedAvailabilityZone       *string                          `json:"provisionedAvailabilityZone,omitempty"`
	ProvisioningState                 *string                          `json:"provisioningState,omitempty"`
	ProximityPlacementGroup           *string                          `json:"proximityPlacementGroup,omitempty"`
	SecurityStyle                     *SecurityStyle                   `json:"securityStyle,omitempty"`
	ServiceLevel                      *ServiceLevel                    `json:"serviceLevel,omitempty"`
	SmbAccessBasedEnumeration         *SmbAccessBasedEnumeration       `json:"smbAccessBasedEnumeration,omitempty"`
	SmbContinuouslyAvailable          *bool                            `json:"smbContinuouslyAvailable,omitempty"`
	SmbEncryption                     *bool                            `json:"smbEncryption,omitempty"`
	SmbNonBrowsable                   *SmbNonBrowsable                 `json:"smbNonBrowsable,omitempty"`
	SnapshotDirectoryVisible          *bool                            `json:"snapshotDirectoryVisible,omitempty"`
	SnapshotId                        *string                          `json:"snapshotId,omitempty"`
	StorageToNetworkProximity         *VolumeStorageToNetworkProximity `json:"storageToNetworkProximity,omitempty"`
	SubnetId                          string                           `json:"subnetId"`
	T2Network                         *string                          `json:"t2Network,omitempty"`
	ThroughputMibps                   *float64                         `json:"throughputMibps,omitempty"`
	UnixPermissions                   *string                          `json:"unixPermissions,omitempty"`
	UsageThreshold                    int64                            `json:"usageThreshold"`
	VolumeGroupName                   *string                          `json:"volumeGroupName,omitempty"`
	VolumeSpecName                    *string                          `json:"volumeSpecName,omitempty"`
	VolumeType                        *string                          `json:"volumeType,omitempty"`
}

type VolumePropertiesDataProtection

type VolumePropertiesDataProtection struct {
	Backup           *VolumeBackupProperties     `json:"backup,omitempty"`
	Replication      *ReplicationObject          `json:"replication,omitempty"`
	Snapshot         *VolumeSnapshotProperties   `json:"snapshot,omitempty"`
	VolumeRelocation *VolumeRelocationProperties `json:"volumeRelocation,omitempty"`
}

type VolumePropertiesExportPolicy

type VolumePropertiesExportPolicy struct {
	Rules *[]ExportPolicyRule `json:"rules,omitempty"`
}

type VolumeRelocationProperties

type VolumeRelocationProperties struct {
	ReadyToBeFinalized  *bool `json:"readyToBeFinalized,omitempty"`
	RelocationRequested *bool `json:"relocationRequested,omitempty"`
}

type VolumeSnapshotProperties

type VolumeSnapshotProperties struct {
	SnapshotPolicyId *string `json:"snapshotPolicyId,omitempty"`
}

type VolumeStorageToNetworkProximity

type VolumeStorageToNetworkProximity string
const (
	VolumeStorageToNetworkProximityAcrossTTwo VolumeStorageToNetworkProximity = "AcrossT2"
	VolumeStorageToNetworkProximityDefault    VolumeStorageToNetworkProximity = "Default"
	VolumeStorageToNetworkProximityTOne       VolumeStorageToNetworkProximity = "T1"
	VolumeStorageToNetworkProximityTTwo       VolumeStorageToNetworkProximity = "T2"
)

func (*VolumeStorageToNetworkProximity) UnmarshalJSON

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

Jump to

Keyboard shortcuts

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