Volume Interface

public interface Volume

An immutable client-side representation of Volume.

Method Summary

Modifier and Type Method and Description
abstract Float actualThroughputMibps()

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

abstract void authorizeReplication(AuthorizeRequest body)

Authorize source volume replication Authorize the replication connection on the source volume.

abstract void authorizeReplication(AuthorizeRequest body, Context context)

Authorize source volume replication Authorize the replication connection on the source volume.

abstract AvsDataStore avsDataStore()

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

abstract String backupId()

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

abstract String baremetalTenantId()

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

abstract void breakFileLocks()

Break file locks Break all the file locks on a volume.

abstract void breakFileLocks(BreakFileLocksRequest body, Context context)

Break file locks Break all the file locks on a volume.

abstract void breakReplication()

Break volume replication Break the replication connection on the destination volume.

abstract void breakReplication(BreakReplicationRequest body, Context context)

Break volume replication Break the replication connection on the destination volume.

abstract String capacityPoolResourceId()

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

abstract Integer cloneProgress()

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

abstract Boolean coolAccess()

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

abstract CoolAccessRetrievalPolicy coolAccessRetrievalPolicy()

Gets 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.

abstract Integer coolnessPeriod()

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

abstract String creationToken()

Gets the creationToken property: Creation Token or File Path A unique file path for the volume.

abstract VolumePropertiesDataProtection dataProtection()

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

abstract List<String> dataStoreResourceId()

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

abstract Long defaultGroupQuotaInKiBs()

Gets the defaultGroupQuotaInKiBs property: Default group quota for volume in KiBs.

abstract Long defaultUserQuotaInKiBs()

Gets the defaultUserQuotaInKiBs property: Default user quota for volume in KiBs.

abstract Boolean deleteBaseSnapshot()

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

abstract void deleteReplication()

Delete volume replication Delete the replication connection on the destination volume, and send release to the source replication.

abstract void deleteReplication(Context context)

Delete volume replication Delete the replication connection on the destination volume, and send release to the source replication.

abstract EnableSubvolumes enableSubvolumes()

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

abstract Boolean encrypted()

Gets the encrypted property: Specifies if the volume is encrypted or not.

abstract EncryptionKeySource encryptionKeySource()

Gets the encryptionKeySource property: Source of key used to encrypt data in volume.

abstract String etag()

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

abstract VolumePropertiesExportPolicy exportPolicy()

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

abstract FileAccessLogs fileAccessLogs()

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

abstract String fileSystemId()

Gets the fileSystemId property: FileSystem ID Unique FileSystem Identifier.

abstract void finalizeRelocation()

Finalize volume relocation Finalizes the relocation of the volume and cleans up the old volume.

abstract void finalizeRelocation(Context context)

Finalize volume relocation Finalizes the relocation of the volume and cleans up the old volume.

abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

abstract Long inheritedSizeInBytes()

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

abstract VolumeInner innerModel()

Gets the inner com.azure.resourcemanager.netapp.fluent.models.VolumeInner object.

abstract Boolean isDefaultQuotaEnabled()

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

abstract Boolean isLargeVolume()

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

abstract Boolean isRestoring()

Gets the isRestoring property: Restoring.

abstract Boolean kerberosEnabled()

Gets the kerberosEnabled property: Describe if a volume is KerberosEnabled.

abstract String keyVaultPrivateEndpointResourceId()

Gets the keyVaultPrivateEndpointResourceId property: The resource ID of private endpoint for KeyVault.

abstract Boolean ldapEnabled()

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

abstract GetGroupIdListForLdapUserResponse listGetGroupIdListForLdapUser(GetGroupIdListForLdapUserRequest body)

Get Group Id List for LDAP User Returns the list of group Ids for a specific LDAP User.

abstract GetGroupIdListForLdapUserResponse listGetGroupIdListForLdapUser(GetGroupIdListForLdapUserRequest body, Context context)

Get Group Id List for LDAP User Returns the list of group Ids for a specific LDAP User.

abstract PagedIterable<Replication> listReplications()

List replications for volume List all replications for a specified volume.

abstract PagedIterable<Replication> listReplications(Context context)

List replications for volume List all replications for a specified volume.

abstract String location()

Gets the location property: The geo-location where the resource lives.

abstract Long maximumNumberOfFiles()

Gets the maximumNumberOfFiles property: Maximum number of files allowed.

abstract List<MountTargetProperties> mountTargets()

Gets the mountTargets property: mountTargets List of mount targets.

abstract String name()

Gets the name property: The name of the resource.

abstract NetworkFeatures networkFeatures()

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

abstract String networkSiblingSetId()

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

abstract String originatingResourceId()

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

abstract List<PlacementKeyValuePairs> placementRules()

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

abstract void poolChange(PoolChangeRequest body)

Change pool for volume Moves volume to another pool.

abstract void poolChange(PoolChangeRequest body, Context context)

Change pool for volume Moves volume to another pool.

abstract Volume populateAvailabilityZone()

Populate Availability Zone This operation will populate availability zone information for a volume.

abstract Volume populateAvailabilityZone(Context context)

Populate Availability Zone This operation will populate availability zone information for a volume.

abstract List<String> protocolTypes()

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

abstract String provisionedAvailabilityZone()

Gets the provisionedAvailabilityZone property: Provisioned Availability Zone The availability zone where the volume is provisioned.

abstract String provisioningState()

Gets the provisioningState property: Azure lifecycle management.

abstract String proximityPlacementGroup()

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

abstract void reInitializeReplication()

ReInitialize volume replication Re-Initializes the replication connection on the destination volume.

abstract void reInitializeReplication(Context context)

ReInitialize volume replication Re-Initializes the replication connection on the destination volume.

abstract void reestablishReplication(ReestablishReplicationRequest body)

Re-establish volume replication Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots.

abstract void reestablishReplication(ReestablishReplicationRequest body, Context context)

Re-establish volume replication Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots.

abstract Volume refresh()

Refreshes the resource to sync with Azure.

abstract Volume refresh(Context context)

Refreshes the resource to sync with Azure.

abstract Region region()

Gets the region of the resource.

abstract String regionName()

Gets the name of the resource region.

abstract void relocate()

Relocate volume Relocates volume to a new stamp.

abstract void relocate(RelocateVolumeRequest body, Context context)

Relocate volume Relocates volume to a new stamp.

abstract void resetCifsPassword()

Reset cifs password Reset cifs password from volume.

abstract void resetCifsPassword(Context context)

Reset cifs password Reset cifs password from volume.

abstract String resourceGroupName()

Gets the name of the resource group.

abstract void resyncReplication()

Resync volume replication Resync the connection on the destination volume.

abstract void resyncReplication(Context context)

Resync volume replication Resync the connection on the destination volume.

abstract void revert(VolumeRevert body)

Revert a volume to one of its snapshots Revert a volume to the snapshot specified in the body.

abstract void revert(VolumeRevert body, Context context)

Revert a volume to one of its snapshots Revert a volume to the snapshot specified in the body.

abstract void revertRelocation()

Revert volume relocation Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.

abstract void revertRelocation(Context context)

Revert volume relocation Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.

abstract SecurityStyle securityStyle()

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

abstract ServiceLevel serviceLevel()

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

abstract SmbAccessBasedEnumeration smbAccessBasedEnumeration()

Gets the smbAccessBasedEnumeration property: smbAccessBasedEnumeration Enables access-based enumeration share property for SMB Shares.

abstract Boolean smbContinuouslyAvailable()

Gets the smbContinuouslyAvailable property: Enables continuously available share property for smb volume.

abstract Boolean smbEncryption()

Gets the smbEncryption property: Enables encryption for in-flight smb3 data.

abstract SmbNonBrowsable smbNonBrowsable()

Gets the smbNonBrowsable property: smbNonBrowsable Enables non-browsable property for SMB Shares.

abstract Boolean snapshotDirectoryVisible()

Gets 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).

abstract String snapshotId()

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

abstract void splitCloneFromParent()

Split clone from parent volume Split operation to convert clone volume to an independent volume.

abstract void splitCloneFromParent(Context context)

Split clone from parent volume Split operation to convert clone volume to an independent volume.

abstract VolumeStorageToNetworkProximity storageToNetworkProximity()

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

abstract String subnetId()

Gets the subnetId property: The Azure Resource URI for a delegated subnet.

abstract SystemData systemData()

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

abstract String t2Network()

Gets the t2Network property: T2 network information.

abstract Map<String,String> tags()

Gets the tags property: Resource tags.

abstract Float throughputMibps()

Gets 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.

abstract String type()

Gets the type property: The type of the resource.

abstract String unixPermissions()

Gets the unixPermissions property: UNIX permissions for NFS volume accepted in octal 4 digit format.

abstract Update update()

Begins update for the Volume resource.

abstract long usageThreshold()

Gets the usageThreshold property: usageThreshold Maximum storage quota allowed for a file system in bytes.

abstract String volumeGroupName()

Gets the volumeGroupName property: Volume Group Name.

abstract String volumeSpecName()

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

abstract String volumeType()

Gets the volumeType property: What type of volume is this.

abstract List<String> zones()

Gets the zones property: Availability Zone.

Method Details

actualThroughputMibps

public abstract Float actualThroughputMibps()

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

Returns:

the actualThroughputMibps value.

authorizeReplication

public abstract void authorizeReplication(AuthorizeRequest body)

Authorize source volume replication Authorize the replication connection on the source volume.

Parameters:

body - Authorize request object supplied in the body of the operation.

authorizeReplication

public abstract void authorizeReplication(AuthorizeRequest body, Context context)

Authorize source volume replication Authorize the replication connection on the source volume.

Parameters:

body - Authorize request object supplied in the body of the operation.
context - The context to associate with this operation.

avsDataStore

public abstract AvsDataStore avsDataStore()

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

Returns:

the avsDataStore value.

backupId

public abstract String backupId()

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

Returns:

the backupId value.

baremetalTenantId

public abstract String baremetalTenantId()

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

Returns:

the baremetalTenantId value.

breakFileLocks

public abstract void breakFileLocks()

Break file locks Break all the file locks on a volume.

breakFileLocks

public abstract void breakFileLocks(BreakFileLocksRequest body, Context context)

Break file locks Break all the file locks on a volume.

Parameters:

body - Optional body to provide the ability to clear file locks with selected options.
context - The context to associate with this operation.

breakReplication

public abstract void breakReplication()

Break volume replication Break the replication connection on the destination volume.

breakReplication

public abstract void breakReplication(BreakReplicationRequest body, Context context)

Break volume replication Break the replication connection on the destination volume.

Parameters:

body - Optional body to force break the replication.
context - The context to associate with this operation.

capacityPoolResourceId

public abstract String capacityPoolResourceId()

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

Returns:

the capacityPoolResourceId value.

cloneProgress

public abstract Integer cloneProgress()

Gets 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 abstract Boolean coolAccess()

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

Returns:

the coolAccess value.

coolAccessRetrievalPolicy

public abstract CoolAccessRetrievalPolicy coolAccessRetrievalPolicy()

Gets 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 abstract Integer coolnessPeriod()

Gets 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 abstract String creationToken()

Gets 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 abstract VolumePropertiesDataProtection dataProtection()

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

Returns:

the dataProtection value.

dataStoreResourceId

public abstract List dataStoreResourceId()

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

Returns:

the dataStoreResourceId value.

defaultGroupQuotaInKiBs

public abstract Long defaultGroupQuotaInKiBs()

Gets 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 abstract Long defaultUserQuotaInKiBs()

Gets 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 abstract Boolean deleteBaseSnapshot()

Gets 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.

deleteReplication

public abstract void deleteReplication()

Delete volume replication Delete the replication connection on the destination volume, and send release to the source replication.

deleteReplication

public abstract void deleteReplication(Context context)

Delete volume replication Delete the replication connection on the destination volume, and send release to the source replication.

Parameters:

context - The context to associate with this operation.

enableSubvolumes

public abstract EnableSubvolumes enableSubvolumes()

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

Returns:

the enableSubvolumes value.

encrypted

public abstract Boolean encrypted()

Gets 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 abstract EncryptionKeySource encryptionKeySource()

Gets 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 abstract String etag()

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

Returns:

the etag value.

exportPolicy

public abstract VolumePropertiesExportPolicy exportPolicy()

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

Returns:

the exportPolicy value.

fileAccessLogs

public abstract FileAccessLogs fileAccessLogs()

Gets 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 abstract String fileSystemId()

Gets the fileSystemId property: FileSystem ID Unique FileSystem Identifier.

Returns:

the fileSystemId value.

finalizeRelocation

public abstract void finalizeRelocation()

Finalize volume relocation Finalizes the relocation of the volume and cleans up the old volume.

finalizeRelocation

public abstract void finalizeRelocation(Context context)

Finalize volume relocation Finalizes the relocation of the volume and cleans up the old volume.

Parameters:

context - The context to associate with this operation.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

inheritedSizeInBytes

public abstract Long inheritedSizeInBytes()

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

Returns:

the inheritedSizeInBytes value.

innerModel

public abstract VolumeInner innerModel()

Gets the inner com.azure.resourcemanager.netapp.fluent.models.VolumeInner object.

Returns:

the inner object.

isDefaultQuotaEnabled

public abstract Boolean isDefaultQuotaEnabled()

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

Returns:

the isDefaultQuotaEnabled value.

isLargeVolume

public abstract Boolean isLargeVolume()

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

Returns:

the isLargeVolume value.

isRestoring

public abstract Boolean isRestoring()

Gets the isRestoring property: Restoring.

Returns:

the isRestoring value.

kerberosEnabled

public abstract Boolean kerberosEnabled()

Gets 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 abstract String keyVaultPrivateEndpointResourceId()

Gets 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 abstract Boolean ldapEnabled()

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

Returns:

the ldapEnabled value.

listGetGroupIdListForLdapUser

public abstract GetGroupIdListForLdapUserResponse listGetGroupIdListForLdapUser(GetGroupIdListForLdapUserRequest body)

Get Group Id List for LDAP User Returns the list of group Ids for a specific LDAP User.

Parameters:

body - Returns group Id list for a specific LDAP user.

Returns:

group Id list for Ldap user.

listGetGroupIdListForLdapUser

public abstract GetGroupIdListForLdapUserResponse listGetGroupIdListForLdapUser(GetGroupIdListForLdapUserRequest body, Context context)

Get Group Id List for LDAP User Returns the list of group Ids for a specific LDAP User.

Parameters:

body - Returns group Id list for a specific LDAP user.
context - The context to associate with this operation.

Returns:

group Id list for Ldap user.

listReplications

public abstract PagedIterable listReplications()

List replications for volume List all replications for a specified volume.

Returns:

list Replications as paginated response with PagedIterable<T>.

listReplications

public abstract PagedIterable listReplications(Context context)

List replications for volume List all replications for a specified volume.

Parameters:

context - The context to associate with this operation.

Returns:

list Replications as paginated response with PagedIterable<T>.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

maximumNumberOfFiles

public abstract Long maximumNumberOfFiles()

Gets 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 abstract List mountTargets()

Gets the mountTargets property: mountTargets List of mount targets.

Returns:

the mountTargets value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

networkFeatures

public abstract NetworkFeatures networkFeatures()

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

Returns:

the networkFeatures value.

networkSiblingSetId

public abstract String networkSiblingSetId()

Gets 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 abstract String originatingResourceId()

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

Returns:

the originatingResourceId value.

placementRules

public abstract List placementRules()

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

Returns:

the placementRules value.

poolChange

public abstract void poolChange(PoolChangeRequest body)

Change pool for volume Moves volume to another pool.

Parameters:

body - Move volume to the pool supplied in the body of the operation.

poolChange

public abstract void poolChange(PoolChangeRequest body, Context context)

Change pool for volume Moves volume to another pool.

Parameters:

body - Move volume to the pool supplied in the body of the operation.
context - The context to associate with this operation.

populateAvailabilityZone

public abstract Volume populateAvailabilityZone()

Populate Availability Zone This operation will populate availability zone information for a volume.

Returns:

volume resource.

populateAvailabilityZone

public abstract Volume populateAvailabilityZone(Context context)

Populate Availability Zone This operation will populate availability zone information for a volume.

Parameters:

context - The context to associate with this operation.

Returns:

volume resource.

protocolTypes

public abstract List protocolTypes()

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

Returns:

the protocolTypes value.

provisionedAvailabilityZone

public abstract String provisionedAvailabilityZone()

Gets 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 abstract String provisioningState()

Gets the provisioningState property: Azure lifecycle management.

Returns:

the provisioningState value.

proximityPlacementGroup

public abstract String proximityPlacementGroup()

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

Returns:

the proximityPlacementGroup value.

reInitializeReplication

public abstract void reInitializeReplication()

ReInitialize volume replication Re-Initializes the replication connection on the destination volume.

reInitializeReplication

public abstract void reInitializeReplication(Context context)

ReInitialize volume replication Re-Initializes the replication connection on the destination volume.

Parameters:

context - The context to associate with this operation.

reestablishReplication

public abstract void reestablishReplication(ReestablishReplicationRequest body)

Re-establish volume replication Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots.

Parameters:

body - body for the id of the source volume.

reestablishReplication

public abstract void reestablishReplication(ReestablishReplicationRequest body, Context context)

Re-establish volume replication Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots.

Parameters:

body - body for the id of the source volume.
context - The context to associate with this operation.

refresh

public abstract Volume refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Volume refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

relocate

public abstract void relocate()

Relocate volume Relocates volume to a new stamp.

relocate

public abstract void relocate(RelocateVolumeRequest body, Context context)

Relocate volume Relocates volume to a new stamp.

Parameters:

body - Relocate volume request.
context - The context to associate with this operation.

resetCifsPassword

public abstract void resetCifsPassword()

Reset cifs password Reset cifs password from volume.

resetCifsPassword

public abstract void resetCifsPassword(Context context)

Reset cifs password Reset cifs password from volume.

Parameters:

context - The context to associate with this operation.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

resyncReplication

public abstract void resyncReplication()

Resync volume replication Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.

resyncReplication

public abstract void resyncReplication(Context context)

Resync volume replication Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.

Parameters:

context - The context to associate with this operation.

revert

public abstract void revert(VolumeRevert body)

Revert a volume to one of its snapshots Revert a volume to the snapshot specified in the body.

Parameters:

body - Object for snapshot to revert supplied in the body of the operation.

revert

public abstract void revert(VolumeRevert body, Context context)

Revert a volume to one of its snapshots Revert a volume to the snapshot specified in the body.

Parameters:

body - Object for snapshot to revert supplied in the body of the operation.
context - The context to associate with this operation.

revertRelocation

public abstract void revertRelocation()

Revert volume relocation Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.

revertRelocation

public abstract void revertRelocation(Context context)

Revert volume relocation Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.

Parameters:

context - The context to associate with this operation.

securityStyle

public abstract SecurityStyle securityStyle()

Gets 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 abstract ServiceLevel serviceLevel()

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

Returns:

the serviceLevel value.

smbAccessBasedEnumeration

public abstract SmbAccessBasedEnumeration smbAccessBasedEnumeration()

Gets 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 abstract Boolean smbContinuouslyAvailable()

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

Returns:

the smbContinuouslyAvailable value.

smbEncryption

public abstract Boolean smbEncryption()

Gets 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 abstract SmbNonBrowsable smbNonBrowsable()

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

Returns:

the smbNonBrowsable value.

snapshotDirectoryVisible

public abstract Boolean snapshotDirectoryVisible()

Gets 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 abstract String snapshotId()

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

Returns:

the snapshotId value.

splitCloneFromParent

public abstract void splitCloneFromParent()

Split clone from parent volume Split operation to convert clone volume to an independent volume.

splitCloneFromParent

public abstract void splitCloneFromParent(Context context)

Split clone from parent volume Split operation to convert clone volume to an independent volume.

Parameters:

context - The context to associate with this operation.

storageToNetworkProximity

public abstract VolumeStorageToNetworkProximity storageToNetworkProximity()

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

Returns:

the storageToNetworkProximity value.

subnetId

public abstract String subnetId()

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

Returns:

the subnetId value.

systemData

public abstract SystemData systemData()

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

Returns:

the systemData value.

t2Network

public abstract String t2Network()

Gets the t2Network property: T2 network information.

Returns:

the t2Network value.

tags

public abstract Map tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

throughputMibps

public abstract Float throughputMibps()

Gets 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.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

unixPermissions

public abstract String unixPermissions()

Gets 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.

update

public abstract Volume.Update update()

Begins update for the Volume resource.

Returns:

the stage of resource update.

usageThreshold

public abstract long usageThreshold()

Gets 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.

volumeGroupName

public abstract String volumeGroupName()

Gets the volumeGroupName property: Volume Group Name.

Returns:

the volumeGroupName value.

volumeSpecName

public abstract String volumeSpecName()

Gets 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 abstract String volumeType()

Gets 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.

zones

public abstract List zones()

Gets the zones property: Availability Zone.

Returns:

the zones value.

Applies to