VolumeInner Class

  • Reference
Package:
com.azure.resourcemanager.netapp.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-netapp:1.1.0-beta.1

public final class VolumeInner
extends Resource

Volume resource.

Constructor Summary

Constructor Description
VolumeInner()

Creates an instance of VolumeInner class.

Method Summary

Modifier and Type Method and Description
Float actualThroughputMibps()

Get the actualThroughputMibps property: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel.
AvsDataStore avsDataStore()

Get the avsDataStore property: avsDataStore Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose.
String backupId()

Get the backupId property: Backup ID UUID v4 or resource identifier used to identify the Backup.
String baremetalTenantId()

Get the baremetalTenantId property: Baremetal Tenant ID Unique Baremetal Tenant Identifier.
String capacityPoolResourceId()

Get the capacityPoolResourceId property: Pool Resource Id used in case of creating a volume through volume group.
Integer cloneProgress()

Get the cloneProgress property: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process.
Boolean coolAccess()

Get the coolAccess property: Specifies whether Cool Access(tiering) is enabled for the volume.
CoolAccessRetrievalPolicy coolAccessRetrievalPolicy()

Get the coolAccessRetrievalPolicy property: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes.
Integer coolnessPeriod()

Get the coolnessPeriod property: Specifies the number of days after which data that is not accessed by clients will be tiered.
String creationToken()

Get the creationToken property: Creation Token or File Path A unique file path for the volume.
VolumePropertiesDataProtection dataProtection()

Get the dataProtection property: DataProtection DataProtection type volumes include an object containing details of the replication.
List<String> dataStoreResourceId()

Get the dataStoreResourceId property: dataStoreResourceId Data store resource unique identifier.
Long defaultGroupQuotaInKiBs()

Get the defaultGroupQuotaInKiBs property: Default group quota for volume in KiBs.
Long defaultUserQuotaInKiBs()

Get the defaultUserQuotaInKiBs property: Default user quota for volume in KiBs.
Boolean deleteBaseSnapshot()

Get the deleteBaseSnapshot property: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished.
EnableSubvolumes enableSubvolumes()

Get the enableSubvolumes property: Flag indicating whether subvolume operations are enabled on the volume.
Boolean encrypted()

Get the encrypted property: Specifies if the volume is encrypted or not.
EncryptionKeySource encryptionKeySource()

Get the encryptionKeySource property: Source of key used to encrypt data in volume.
String etag()

Get the etag property: A unique read-only string that changes whenever the resource is updated.
VolumePropertiesExportPolicy exportPolicy()

Get the exportPolicy property: exportPolicy Set of export policy rules.
FileAccessLogs fileAccessLogs()

Get the fileAccessLogs property: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.
String fileSystemId()

Get the fileSystemId property: FileSystem ID Unique FileSystem Identifier.
Long inheritedSizeInBytes()

Get the inheritedSizeInBytes property: inheritedSizeInBytes Space shared by short term clone volume with parent volume in bytes.
Boolean isDefaultQuotaEnabled()

Get the isDefaultQuotaEnabled property: Specifies if default quota is enabled for the volume.
Boolean isLargeVolume()

Get the isLargeVolume property: Is Large Volume Specifies whether volume is a Large Volume or Regular Volume.
Boolean isRestoring()

Get the isRestoring property: Restoring.
Boolean kerberosEnabled()

Get the kerberosEnabled property: Describe if a volume is KerberosEnabled.
String keyVaultPrivateEndpointResourceId()

Get the keyVaultPrivateEndpointResourceId property: The resource ID of private endpoint for KeyVault.
Boolean ldapEnabled()

Get the ldapEnabled property: Specifies whether LDAP is enabled or not for a given NFS volume.
Long maximumNumberOfFiles()

Get the maximumNumberOfFiles property: Maximum number of files allowed.
List<MountTargetProperties> mountTargets()

Get the mountTargets property: mountTargets List of mount targets.
NetworkFeatures networkFeatures()

Get the networkFeatures property: Network features Network features available to the volume, or current state of update.
String networkSiblingSetId()

Get the networkSiblingSetId property: Network Sibling Set ID Network Sibling Set ID for the the group of volumes sharing networking resources.
String originatingResourceId()

Get the originatingResourceId property: Originating Resource Id Id of the snapshot or backup that the volume is restored from.
List<PlacementKeyValuePairs> placementRules()

Get the placementRules property: Volume placement rules Application specific placement rules for the particular volume.
List<String> protocolTypes()

Get the protocolTypes property: protocolTypes Set of protocol types, default NFSv3, CIFS for SMB protocol.
String provisionedAvailabilityZone()

Get the provisionedAvailabilityZone property: Provisioned Availability Zone The availability zone where the volume is provisioned.
String provisioningState()

Get the provisioningState property: Azure lifecycle management.
String proximityPlacementGroup()

Get the proximityPlacementGroup property: Proximity placement group associated with the volume.
SecurityStyle securityStyle()

Get the securityStyle property: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol.
ServiceLevel serviceLevel()

Get the serviceLevel property: serviceLevel The service level of the file system.
SmbAccessBasedEnumeration smbAccessBasedEnumeration()

Get the smbAccessBasedEnumeration property: smbAccessBasedEnumeration Enables access-based enumeration share property for SMB Shares.
Boolean smbContinuouslyAvailable()

Get the smbContinuouslyAvailable property: Enables continuously available share property for smb volume.
Boolean smbEncryption()

Get the smbEncryption property: Enables encryption for in-flight smb3 data.
SmbNonBrowsable smbNonBrowsable()

Get the smbNonBrowsable property: smbNonBrowsable Enables non-browsable property for SMB Shares.
Boolean snapshotDirectoryVisible()

Get the snapshotDirectoryVisible property: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).
String snapshotId()

Get the snapshotId property: Snapshot ID UUID v4 or resource identifier used to identify the Snapshot.
VolumeStorageToNetworkProximity storageToNetworkProximity()

Get the storageToNetworkProximity property: Storage to Network Proximity Provides storage to network proximity information for the volume.
String subnetId()

Get the subnetId property: The Azure Resource URI for a delegated subnet.
SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
String t2Network()

Get the t2Network property: T2 network information.
Float throughputMibps()

Get the throughputMibps property: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume.
String unixPermissions()

Get the unixPermissions property: UNIX permissions for NFS volume accepted in octal 4 digit format.
long usageThreshold()

Get the usageThreshold property: usageThreshold Maximum storage quota allowed for a file system in bytes.
void validate()

Validates the instance.
String volumeGroupName()

Get the volumeGroupName property: Volume Group Name.
String volumeSpecName()

Get the volumeSpecName property: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g.
String volumeType()

Get the volumeType property: What type of volume is this.
VolumeInner withAvsDataStore(AvsDataStore avsDataStore)

Set the avsDataStore property: avsDataStore Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose.
VolumeInner withBackupId(String backupId)

Set the backupId property: Backup ID UUID v4 or resource identifier used to identify the Backup.
VolumeInner withCapacityPoolResourceId(String capacityPoolResourceId)

Set the capacityPoolResourceId property: Pool Resource Id used in case of creating a volume through volume group.
VolumeInner withCoolAccess(Boolean coolAccess)

Set the coolAccess property: Specifies whether Cool Access(tiering) is enabled for the volume.
VolumeInner withCoolAccessRetrievalPolicy(CoolAccessRetrievalPolicy coolAccessRetrievalPolicy)

Set the coolAccessRetrievalPolicy property: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes.
VolumeInner withCoolnessPeriod(Integer coolnessPeriod)

Set the coolnessPeriod property: Specifies the number of days after which data that is not accessed by clients will be tiered.
VolumeInner withCreationToken(String creationToken)

Set the creationToken property: Creation Token or File Path A unique file path for the volume.
VolumeInner withDataProtection(VolumePropertiesDataProtection dataProtection)

Set the dataProtection property: DataProtection DataProtection type volumes include an object containing details of the replication.
VolumeInner withDefaultGroupQuotaInKiBs(Long defaultGroupQuotaInKiBs)

Set the defaultGroupQuotaInKiBs property: Default group quota for volume in KiBs.
VolumeInner withDefaultUserQuotaInKiBs(Long defaultUserQuotaInKiBs)

Set the defaultUserQuotaInKiBs property: Default user quota for volume in KiBs.
VolumeInner withDeleteBaseSnapshot(Boolean deleteBaseSnapshot)

Set the deleteBaseSnapshot property: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished.
VolumeInner withEnableSubvolumes(EnableSubvolumes enableSubvolumes)

Set the enableSubvolumes property: Flag indicating whether subvolume operations are enabled on the volume.
VolumeInner withEncryptionKeySource(EncryptionKeySource encryptionKeySource)

Set the encryptionKeySource property: Source of key used to encrypt data in volume.
VolumeInner withExportPolicy(VolumePropertiesExportPolicy exportPolicy)

Set the exportPolicy property: exportPolicy Set of export policy rules.
VolumeInner withIsDefaultQuotaEnabled(Boolean isDefaultQuotaEnabled)

Set the isDefaultQuotaEnabled property: Specifies if default quota is enabled for the volume.
VolumeInner withIsLargeVolume(Boolean isLargeVolume)

Set the isLargeVolume property: Is Large Volume Specifies whether volume is a Large Volume or Regular Volume.
VolumeInner withIsRestoring(Boolean isRestoring)

Set the isRestoring property: Restoring.
VolumeInner withKerberosEnabled(Boolean kerberosEnabled)

Set the kerberosEnabled property: Describe if a volume is KerberosEnabled.
VolumeInner withKeyVaultPrivateEndpointResourceId(String keyVaultPrivateEndpointResourceId)

Set the keyVaultPrivateEndpointResourceId property: The resource ID of private endpoint for KeyVault.
VolumeInner withLdapEnabled(Boolean ldapEnabled)

Set the ldapEnabled property: Specifies whether LDAP is enabled or not for a given NFS volume.
VolumeInner withLocation(String location)
VolumeInner withNetworkFeatures(NetworkFeatures networkFeatures)

Set the networkFeatures property: Network features Network features available to the volume, or current state of update.
VolumeInner withPlacementRules(List<PlacementKeyValuePairs> placementRules)

Set the placementRules property: Volume placement rules Application specific placement rules for the particular volume.
VolumeInner withProtocolTypes(List<String> protocolTypes)

Set the protocolTypes property: protocolTypes Set of protocol types, default NFSv3, CIFS for SMB protocol.
VolumeInner withProximityPlacementGroup(String proximityPlacementGroup)

Set the proximityPlacementGroup property: Proximity placement group associated with the volume.
VolumeInner withSecurityStyle(SecurityStyle securityStyle)

Set the securityStyle property: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol.
VolumeInner withServiceLevel(ServiceLevel serviceLevel)

Set the serviceLevel property: serviceLevel The service level of the file system.
VolumeInner withSmbAccessBasedEnumeration(SmbAccessBasedEnumeration smbAccessBasedEnumeration)

Set the smbAccessBasedEnumeration property: smbAccessBasedEnumeration Enables access-based enumeration share property for SMB Shares.
VolumeInner withSmbContinuouslyAvailable(Boolean smbContinuouslyAvailable)

Set the smbContinuouslyAvailable property: Enables continuously available share property for smb volume.
VolumeInner withSmbEncryption(Boolean smbEncryption)

Set the smbEncryption property: Enables encryption for in-flight smb3 data.
VolumeInner withSmbNonBrowsable(SmbNonBrowsable smbNonBrowsable)

Set the smbNonBrowsable property: smbNonBrowsable Enables non-browsable property for SMB Shares.
VolumeInner withSnapshotDirectoryVisible(Boolean snapshotDirectoryVisible)

Set the snapshotDirectoryVisible property: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).
VolumeInner withSnapshotId(String snapshotId)

Set the snapshotId property: Snapshot ID UUID v4 or resource identifier used to identify the Snapshot.
VolumeInner withSubnetId(String subnetId)

Set the subnetId property: The Azure Resource URI for a delegated subnet.
VolumeInner withTags(Map<String,String> tags)
VolumeInner withThroughputMibps(Float throughputMibps)

Set the throughputMibps property: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume.
VolumeInner withUnixPermissions(String unixPermissions)

Set the unixPermissions property: UNIX permissions for NFS volume accepted in octal 4 digit format.
VolumeInner withUsageThreshold(long usageThreshold)

Set the usageThreshold property: usageThreshold Maximum storage quota allowed for a file system in bytes.
VolumeInner withVolumeSpecName(String volumeSpecName)

Set the volumeSpecName property: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g.
VolumeInner withVolumeType(String volumeType)

Set the volumeType property: What type of volume is this.
VolumeInner withZones(List<String> zones)

Set the zones property: Availability Zone.
List<String> zones()

Get the zones property: Availability Zone.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

location tags withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VolumeInner

public VolumeInner()

Creates an instance of VolumeInner class.

Method Details

actualThroughputMibps

public Float actualThroughputMibps()

Get the actualThroughputMibps property: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel.

Returns:

the actualThroughputMibps value.

avsDataStore

public AvsDataStore avsDataStore()

Get the avsDataStore property: avsDataStore Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose.

Returns:

the avsDataStore value.

backupId

public String backupId()

Get the backupId property: Backup ID UUID v4 or resource identifier used to identify the Backup.

Returns:

the backupId value.

baremetalTenantId

public String baremetalTenantId()

Get the baremetalTenantId property: Baremetal Tenant ID Unique Baremetal Tenant Identifier.

Returns:

the baremetalTenantId value.

capacityPoolResourceId

public String capacityPoolResourceId()

Get the capacityPoolResourceId property: Pool Resource Id used in case of creating a volume through volume group.

Returns:

the capacityPoolResourceId value.

cloneProgress

public Integer cloneProgress()

Get the cloneProgress property: When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning.

Returns:

the cloneProgress value.

coolAccess

public Boolean coolAccess()

Get the coolAccess property: Specifies whether Cool Access(tiering) is enabled for the volume.

Returns:

the coolAccess value.

coolAccessRetrievalPolicy

public CoolAccessRetrievalPolicy coolAccessRetrievalPolicy()

Get the coolAccessRetrievalPolicy property: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage.

Returns:

the coolAccessRetrievalPolicy value.

coolnessPeriod

public Integer coolnessPeriod()

Get the coolnessPeriod property: Specifies the number of days after which data that is not accessed by clients will be tiered.

Returns:

the coolnessPeriod value.

creationToken

public String creationToken()

Get the creationToken property: Creation Token or File Path A unique file path for the volume. Used when creating mount targets.

Returns:

the creationToken value.

dataProtection

public VolumePropertiesDataProtection dataProtection()

Get the dataProtection property: DataProtection DataProtection type volumes include an object containing details of the replication.

Returns:

the dataProtection value.

dataStoreResourceId

public List dataStoreResourceId()

Get the dataStoreResourceId property: dataStoreResourceId Data store resource unique identifier.

Returns:

the dataStoreResourceId value.

defaultGroupQuotaInKiBs

public Long defaultGroupQuotaInKiBs()

Get the defaultGroupQuotaInKiBs property: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.

Returns:

the defaultGroupQuotaInKiBs value.

defaultUserQuotaInKiBs

public Long defaultUserQuotaInKiBs()

Get the defaultUserQuotaInKiBs property: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .

Returns:

the defaultUserQuotaInKiBs value.

deleteBaseSnapshot

public Boolean deleteBaseSnapshot()

Get the deleteBaseSnapshot property: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false.

Returns:

the deleteBaseSnapshot value.

enableSubvolumes

public EnableSubvolumes enableSubvolumes()

Get the enableSubvolumes property: Flag indicating whether subvolume operations are enabled on the volume.

Returns:

the enableSubvolumes value.

encrypted

public Boolean encrypted()

Get the encrypted property: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.

Returns:

the encrypted value.

encryptionKeySource

public EncryptionKeySource encryptionKeySource()

Get the encryptionKeySource property: Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'.

Returns:

the encryptionKeySource value.

etag

public String etag()

Get the etag property: A unique read-only string that changes whenever the resource is updated.

Returns:

the etag value.

exportPolicy

public VolumePropertiesExportPolicy exportPolicy()

Get the exportPolicy property: exportPolicy Set of export policy rules.

Returns:

the exportPolicy value.

fileAccessLogs

public FileAccessLogs fileAccessLogs()

Get the fileAccessLogs property: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.

Returns:

the fileAccessLogs value.

fileSystemId

public String fileSystemId()

Get the fileSystemId property: FileSystem ID Unique FileSystem Identifier.

Returns:

the fileSystemId value.

inheritedSizeInBytes

public Long inheritedSizeInBytes()

Get the inheritedSizeInBytes property: inheritedSizeInBytes Space shared by short term clone volume with parent volume in bytes.

Returns:

the inheritedSizeInBytes value.

isDefaultQuotaEnabled

public Boolean isDefaultQuotaEnabled()

Get the isDefaultQuotaEnabled property: Specifies if default quota is enabled for the volume.

Returns:

the isDefaultQuotaEnabled value.

isLargeVolume

public Boolean isLargeVolume()

Get the isLargeVolume property: Is Large Volume Specifies whether volume is a Large Volume or Regular Volume.

Returns:

the isLargeVolume value.

isRestoring

public Boolean isRestoring()

Get the isRestoring property: Restoring.

Returns:

the isRestoring value.

kerberosEnabled

public Boolean kerberosEnabled()

Get the kerberosEnabled property: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later.

Returns:

the kerberosEnabled value.

keyVaultPrivateEndpointResourceId

public String keyVaultPrivateEndpointResourceId()

Get the keyVaultPrivateEndpointResourceId property: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.

Returns:

the keyVaultPrivateEndpointResourceId value.

ldapEnabled

public Boolean ldapEnabled()

Get the ldapEnabled property: Specifies whether LDAP is enabled or not for a given NFS volume.

Returns:

the ldapEnabled value.

maximumNumberOfFiles

public Long maximumNumberOfFiles()

Get the maximumNumberOfFiles property: Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB.

Returns:

the maximumNumberOfFiles value.

mountTargets

public List mountTargets()

Get the mountTargets property: mountTargets List of mount targets.

Returns:

the mountTargets value.

networkFeatures

public NetworkFeatures networkFeatures()

Get the networkFeatures property: Network features Network features available to the volume, or current state of update.

Returns:

the networkFeatures value.

networkSiblingSetId

public String networkSiblingSetId()

Get the networkSiblingSetId property: Network Sibling Set ID Network Sibling Set ID for the the group of volumes sharing networking resources.

Returns:

the networkSiblingSetId value.

originatingResourceId

public String originatingResourceId()

Get the originatingResourceId property: Originating Resource Id Id of the snapshot or backup that the volume is restored from.

Returns:

the originatingResourceId value.

placementRules

public List placementRules()

Get the placementRules property: Volume placement rules Application specific placement rules for the particular volume.

Returns:

the placementRules value.

protocolTypes

public List protocolTypes()

Get the protocolTypes property: protocolTypes Set of protocol types, default NFSv3, CIFS for SMB protocol.

Returns:

the protocolTypes value.

provisionedAvailabilityZone

public String provisionedAvailabilityZone()

Get the provisionedAvailabilityZone property: Provisioned Availability Zone The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.

Returns:

the provisionedAvailabilityZone value.

provisioningState

public String provisioningState()

Get the provisioningState property: Azure lifecycle management.

Returns:

the provisioningState value.

proximityPlacementGroup

public String proximityPlacementGroup()

Get the proximityPlacementGroup property: Proximity placement group associated with the volume.

Returns:

the proximityPlacementGroup value.

securityStyle

public SecurityStyle securityStyle()

Get the securityStyle property: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol.

Returns:

the securityStyle value.

serviceLevel

public ServiceLevel serviceLevel()

Get the serviceLevel property: serviceLevel The service level of the file system.

Returns:

the serviceLevel value.

smbAccessBasedEnumeration

public SmbAccessBasedEnumeration smbAccessBasedEnumeration()

Get the smbAccessBasedEnumeration property: smbAccessBasedEnumeration Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Returns:

the smbAccessBasedEnumeration value.

smbContinuouslyAvailable

public Boolean smbContinuouslyAvailable()

Get the smbContinuouslyAvailable property: Enables continuously available share property for smb volume. Only applicable for SMB volume.

Returns:

the smbContinuouslyAvailable value.

smbEncryption

public Boolean smbEncryption()

Get the smbEncryption property: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later.

Returns:

the smbEncryption value.

smbNonBrowsable

public SmbNonBrowsable smbNonBrowsable()

Get the smbNonBrowsable property: smbNonBrowsable Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Returns:

the smbNonBrowsable value.

snapshotDirectoryVisible

public Boolean snapshotDirectoryVisible()

Get the snapshotDirectoryVisible property: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).

Returns:

the snapshotDirectoryVisible value.

snapshotId

public String snapshotId()

Get the snapshotId property: Snapshot ID UUID v4 or resource identifier used to identify the Snapshot.

Returns:

the snapshotId value.

storageToNetworkProximity

public VolumeStorageToNetworkProximity storageToNetworkProximity()

Get the storageToNetworkProximity property: Storage to Network Proximity Provides storage to network proximity information for the volume.

Returns:

the storageToNetworkProximity value.

subnetId

public String subnetId()

Get the subnetId property: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes.

Returns:

the subnetId value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

t2Network

public String t2Network()

Get the t2Network property: T2 network information.

Returns:

the t2Network value.

throughputMibps

public Float throughputMibps()

Get the throughputMibps property: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume.

Returns:

the throughputMibps value.

unixPermissions

public String unixPermissions()

Get the unixPermissions property: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.

Returns:

the unixPermissions value.

usageThreshold

public long usageThreshold()

Get the usageThreshold property: usageThreshold Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes.

Returns:

the usageThreshold value.

validate

public void validate()

Validates the instance.

volumeGroupName

public String volumeGroupName()

Get the volumeGroupName property: Volume Group Name.

Returns:

the volumeGroupName value.

volumeSpecName

public String volumeSpecName()

Get the volumeSpecName property: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log.

Returns:

the volumeSpecName value.

volumeType

public String volumeType()

Get the volumeType property: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone.

Returns:

the volumeType value.

withAvsDataStore

public VolumeInner withAvsDataStore(AvsDataStore avsDataStore)

Set the avsDataStore property: avsDataStore Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose.

Parameters:

avsDataStore - the avsDataStore value to set.

Returns:

the VolumeInner object itself.

withBackupId

public VolumeInner withBackupId(String backupId)

Set the backupId property: Backup ID UUID v4 or resource identifier used to identify the Backup.

Parameters:

backupId - the backupId value to set.

Returns:

the VolumeInner object itself.

withCapacityPoolResourceId

public VolumeInner withCapacityPoolResourceId(String capacityPoolResourceId)

Set the capacityPoolResourceId property: Pool Resource Id used in case of creating a volume through volume group.

Parameters:

capacityPoolResourceId - the capacityPoolResourceId value to set.

Returns:

the VolumeInner object itself.

withCoolAccess

public VolumeInner withCoolAccess(Boolean coolAccess)

Set the coolAccess property: Specifies whether Cool Access(tiering) is enabled for the volume.

Parameters:

coolAccess - the coolAccess value to set.

Returns:

the VolumeInner object itself.

withCoolAccessRetrievalPolicy

public VolumeInner withCoolAccessRetrievalPolicy(CoolAccessRetrievalPolicy coolAccessRetrievalPolicy)

Set the coolAccessRetrievalPolicy property: coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage.

Parameters:

coolAccessRetrievalPolicy - the coolAccessRetrievalPolicy value to set.

Returns:

the VolumeInner object itself.

withCoolnessPeriod

public VolumeInner withCoolnessPeriod(Integer coolnessPeriod)

Set the coolnessPeriod property: Specifies the number of days after which data that is not accessed by clients will be tiered.

Parameters:

coolnessPeriod - the coolnessPeriod value to set.

Returns:

the VolumeInner object itself.

withCreationToken

public VolumeInner withCreationToken(String creationToken)

Set the creationToken property: Creation Token or File Path A unique file path for the volume. Used when creating mount targets.

Parameters:

creationToken - the creationToken value to set.

Returns:

the VolumeInner object itself.

withDataProtection

public VolumeInner withDataProtection(VolumePropertiesDataProtection dataProtection)

Set the dataProtection property: DataProtection DataProtection type volumes include an object containing details of the replication.

Parameters:

dataProtection - the dataProtection value to set.

Returns:

the VolumeInner object itself.

withDefaultGroupQuotaInKiBs

public VolumeInner withDefaultGroupQuotaInKiBs(Long defaultGroupQuotaInKiBs)

Set the defaultGroupQuotaInKiBs property: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.

Parameters:

defaultGroupQuotaInKiBs - the defaultGroupQuotaInKiBs value to set.

Returns:

the VolumeInner object itself.

withDefaultUserQuotaInKiBs

public VolumeInner withDefaultUserQuotaInKiBs(Long defaultUserQuotaInKiBs)

Set the defaultUserQuotaInKiBs property: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .

Parameters:

defaultUserQuotaInKiBs - the defaultUserQuotaInKiBs value to set.

Returns:

the VolumeInner object itself.

withDeleteBaseSnapshot

public VolumeInner withDeleteBaseSnapshot(Boolean deleteBaseSnapshot)

Set the deleteBaseSnapshot property: If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false.

Parameters:

deleteBaseSnapshot - the deleteBaseSnapshot value to set.

Returns:

the VolumeInner object itself.

withEnableSubvolumes

public VolumeInner withEnableSubvolumes(EnableSubvolumes enableSubvolumes)

Set the enableSubvolumes property: Flag indicating whether subvolume operations are enabled on the volume.

Parameters:

enableSubvolumes - the enableSubvolumes value to set.

Returns:

the VolumeInner object itself.

withEncryptionKeySource

public VolumeInner withEncryptionKeySource(EncryptionKeySource encryptionKeySource)

Set the encryptionKeySource property: Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'.

Parameters:

encryptionKeySource - the encryptionKeySource value to set.

Returns:

the VolumeInner object itself.

withExportPolicy

public VolumeInner withExportPolicy(VolumePropertiesExportPolicy exportPolicy)

Set the exportPolicy property: exportPolicy Set of export policy rules.

Parameters:

exportPolicy - the exportPolicy value to set.

Returns:

the VolumeInner object itself.

withIsDefaultQuotaEnabled

public VolumeInner withIsDefaultQuotaEnabled(Boolean isDefaultQuotaEnabled)

Set the isDefaultQuotaEnabled property: Specifies if default quota is enabled for the volume.

Parameters:

isDefaultQuotaEnabled - the isDefaultQuotaEnabled value to set.

Returns:

the VolumeInner object itself.

withIsLargeVolume

public VolumeInner withIsLargeVolume(Boolean isLargeVolume)

Set the isLargeVolume property: Is Large Volume Specifies whether volume is a Large Volume or Regular Volume.

Parameters:

isLargeVolume - the isLargeVolume value to set.

Returns:

the VolumeInner object itself.

withIsRestoring

public VolumeInner withIsRestoring(Boolean isRestoring)

Set the isRestoring property: Restoring.

Parameters:

isRestoring - the isRestoring value to set.

Returns:

the VolumeInner object itself.

withKerberosEnabled

public VolumeInner withKerberosEnabled(Boolean kerberosEnabled)

Set the kerberosEnabled property: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later.

Parameters:

kerberosEnabled - the kerberosEnabled value to set.

Returns:

the VolumeInner object itself.

withKeyVaultPrivateEndpointResourceId

public VolumeInner withKeyVaultPrivateEndpointResourceId(String keyVaultPrivateEndpointResourceId)

Set the keyVaultPrivateEndpointResourceId property: The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.

Parameters:

keyVaultPrivateEndpointResourceId - the keyVaultPrivateEndpointResourceId value to set.

Returns:

the VolumeInner object itself.

withLdapEnabled

public VolumeInner withLdapEnabled(Boolean ldapEnabled)

Set the ldapEnabled property: Specifies whether LDAP is enabled or not for a given NFS volume.

Parameters:

ldapEnabled - the ldapEnabled value to set.

Returns:

the VolumeInner object itself.

withLocation

public VolumeInner withLocation(String location)

Overrides:

VolumeInner.withLocation(String location)

Parameters:

location

withNetworkFeatures

public VolumeInner withNetworkFeatures(NetworkFeatures networkFeatures)

Set the networkFeatures property: Network features Network features available to the volume, or current state of update.

Parameters:

networkFeatures - the networkFeatures value to set.

Returns:

the VolumeInner object itself.

withPlacementRules

public VolumeInner withPlacementRules(List placementRules)

Set the placementRules property: Volume placement rules Application specific placement rules for the particular volume.

Parameters:

placementRules - the placementRules value to set.

Returns:

the VolumeInner object itself.

withProtocolTypes

public VolumeInner withProtocolTypes(List protocolTypes)

Set the protocolTypes property: protocolTypes Set of protocol types, default NFSv3, CIFS for SMB protocol.

Parameters:

protocolTypes - the protocolTypes value to set.

Returns:

the VolumeInner object itself.

withProximityPlacementGroup

public VolumeInner withProximityPlacementGroup(String proximityPlacementGroup)

Set the proximityPlacementGroup property: Proximity placement group associated with the volume.

Parameters:

proximityPlacementGroup - the proximityPlacementGroup value to set.

Returns:

the VolumeInner object itself.

withSecurityStyle

public VolumeInner withSecurityStyle(SecurityStyle securityStyle)

Set the securityStyle property: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol.

Parameters:

securityStyle - the securityStyle value to set.

Returns:

the VolumeInner object itself.

withServiceLevel

public VolumeInner withServiceLevel(ServiceLevel serviceLevel)

Set the serviceLevel property: serviceLevel The service level of the file system.

Parameters:

serviceLevel - the serviceLevel value to set.

Returns:

the VolumeInner object itself.

withSmbAccessBasedEnumeration

public VolumeInner withSmbAccessBasedEnumeration(SmbAccessBasedEnumeration smbAccessBasedEnumeration)

Set the smbAccessBasedEnumeration property: smbAccessBasedEnumeration Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Parameters:

smbAccessBasedEnumeration - the smbAccessBasedEnumeration value to set.

Returns:

the VolumeInner object itself.

withSmbContinuouslyAvailable

public VolumeInner withSmbContinuouslyAvailable(Boolean smbContinuouslyAvailable)

Set the smbContinuouslyAvailable property: Enables continuously available share property for smb volume. Only applicable for SMB volume.

Parameters:

smbContinuouslyAvailable - the smbContinuouslyAvailable value to set.

Returns:

the VolumeInner object itself.

withSmbEncryption

public VolumeInner withSmbEncryption(Boolean smbEncryption)

Set the smbEncryption property: Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later.

Parameters:

smbEncryption - the smbEncryption value to set.

Returns:

the VolumeInner object itself.

withSmbNonBrowsable

public VolumeInner withSmbNonBrowsable(SmbNonBrowsable smbNonBrowsable)

Set the smbNonBrowsable property: smbNonBrowsable Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Parameters:

smbNonBrowsable - the smbNonBrowsable value to set.

Returns:

the VolumeInner object itself.

withSnapshotDirectoryVisible

public VolumeInner withSnapshotDirectoryVisible(Boolean snapshotDirectoryVisible)

Set the snapshotDirectoryVisible property: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).

Parameters:

snapshotDirectoryVisible - the snapshotDirectoryVisible value to set.

Returns:

the VolumeInner object itself.

withSnapshotId

public VolumeInner withSnapshotId(String snapshotId)

Set the snapshotId property: Snapshot ID UUID v4 or resource identifier used to identify the Snapshot.

Parameters:

snapshotId - the snapshotId value to set.

Returns:

the VolumeInner object itself.

withSubnetId

public VolumeInner withSubnetId(String subnetId)

Set the subnetId property: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes.

Parameters:

subnetId - the subnetId value to set.

Returns:

the VolumeInner object itself.

withTags

public VolumeInner withTags(Map tags)

Overrides:

VolumeInner.withTags(Map<String,String> tags)

Parameters:

tags

withThroughputMibps

public VolumeInner withThroughputMibps(Float throughputMibps)

Set the throughputMibps property: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume.

Parameters:

throughputMibps - the throughputMibps value to set.

Returns:

the VolumeInner object itself.

withUnixPermissions

public VolumeInner withUnixPermissions(String unixPermissions)

Set the unixPermissions property: UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.

Parameters:

unixPermissions - the unixPermissions value to set.

Returns:

the VolumeInner object itself.

withUsageThreshold

public VolumeInner withUsageThreshold(long usageThreshold)

Set the usageThreshold property: usageThreshold Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes.

Parameters:

usageThreshold - the usageThreshold value to set.

Returns:

the VolumeInner object itself.

withVolumeSpecName

public VolumeInner withVolumeSpecName(String volumeSpecName)

Set the volumeSpecName property: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log.

Parameters:

volumeSpecName - the volumeSpecName value to set.

Returns:

the VolumeInner object itself.

withVolumeType

public VolumeInner withVolumeType(String volumeType)

Set the volumeType property: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone.

Parameters:

volumeType - the volumeType value to set.

Returns:

the VolumeInner object itself.

withZones

public VolumeInner withZones(List zones)

Set the zones property: Availability Zone.

Parameters:

zones - the zones value to set.

Returns:

the VolumeInner object itself.

zones

public List zones()

Get the zones property: Availability Zone.

Returns:

the zones value.

Applies to