Package com.azure.resourcemanager.netapp.models

Interface Volume

public interface Volume
An immutable client-side representation of Volume.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • etag

      String etag()
      Gets the etag property: A unique read-only string that changes whenever the resource is updated.
      Returns:
      the etag value.

    • zones

      List<String> zones()
      Gets the zones property: Availability Zone.
      Returns:
      the zones value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      Returns:
      the systemData value.

    • fileSystemId

      String fileSystemId()
      Gets the fileSystemId property: FileSystem ID

      Unique FileSystem Identifier.

      Returns:
      the fileSystemId value.

    • creationToken

      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.

    • serviceLevel

      ServiceLevel serviceLevel()
      Gets the serviceLevel property: serviceLevel

      The service level of the file system.

      Returns:
      the serviceLevel value.

    • usageThreshold

      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 500 GiB. Upper limit is 100TiB, 500Tib for LargeVolume. Specified in bytes.

      Returns:
      the usageThreshold value.

    • exportPolicy

      VolumePropertiesExportPolicy exportPolicy()
      Gets the exportPolicy property: exportPolicy

      Set of export policy rules.

      Returns:
      the exportPolicy value.

    • protocolTypes

      List<String> protocolTypes()
      Gets the protocolTypes property: protocolTypes

      Set of protocol types, default NFSv3, CIFS for SMB protocol.

      Returns:
      the protocolTypes value.

    • provisioningState

      String provisioningState()
      Gets the provisioningState property: Azure lifecycle management.
      Returns:
      the provisioningState value.

    • snapshotId

      String snapshotId()
      Gets the snapshotId property: Snapshot ID

      UUID v4 or resource identifier used to identify the Snapshot.

      Returns:
      the snapshotId value.

    • deleteBaseSnapshot

      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.

    • backupId

      String backupId()
      Gets the backupId property: Backup ID

      UUID v4 or resource identifier used to identify the Backup.

      Returns:
      the backupId value.

    • baremetalTenantId

      String baremetalTenantId()
      Gets the baremetalTenantId property: Baremetal Tenant ID

      Unique Baremetal Tenant Identifier.

      Returns:
      the baremetalTenantId value.

    • subnetId

      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.

    • networkFeatures

      NetworkFeatures networkFeatures()
      Gets the networkFeatures property: Network features

      Basic network, or Standard features available to the volume.

      Returns:
      the networkFeatures value.

    • networkSiblingSetId

      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.

    • storageToNetworkProximity

      VolumeStorageToNetworkProximity storageToNetworkProximity()
      Gets the storageToNetworkProximity property: Storage to Network Proximity

      Provides storage to network proximity information for the volume.

      Returns:
      the storageToNetworkProximity value.

    • mountTargets

      List<MountTargetProperties> mountTargets()
      Gets the mountTargets property: mountTargets

      List of mount targets.

      Returns:
      the mountTargets value.

    • volumeType

      String volumeType()
      Gets the volumeType property: What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection.
      Returns:
      the volumeType value.

    • dataProtection

      VolumePropertiesDataProtection dataProtection()
      Gets the dataProtection property: DataProtection

      DataProtection type volumes include an object containing details of the replication.

      Returns:
      the dataProtection value.

    • isRestoring

      Boolean isRestoring()
      Gets the isRestoring property: Restoring.
      Returns:
      the isRestoring value.

    • snapshotDirectoryVisible

      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 (default to true).
      Returns:
      the snapshotDirectoryVisible value.

    • kerberosEnabled

      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.

    • securityStyle

      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.

    • smbEncryption

      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.

    • smbAccessBasedEnumeration

      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.

    • smbNonBrowsable

      SmbNonBrowsable smbNonBrowsable()
      Gets the smbNonBrowsable property: smbNonBrowsable

      Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.

      Returns:
      the smbNonBrowsable value.

    • smbContinuouslyAvailable

      Boolean smbContinuouslyAvailable()
      Gets the smbContinuouslyAvailable property: Enables continuously available share property for smb volume. Only applicable for SMB volume.
      Returns:
      the smbContinuouslyAvailable value.

    • throughputMibps

      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.

    • encryptionKeySource

      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.

    • keyVaultPrivateEndpointResourceId

      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

      Boolean ldapEnabled()
      Gets the ldapEnabled property: Specifies whether LDAP is enabled or not for a given NFS volume.
      Returns:
      the ldapEnabled value.

    • coolAccess

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

    • coolnessPeriod

      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.

    • unixPermissions

      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.

    • cloneProgress

      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.

    • avsDataStore

      AvsDataStore avsDataStore()
      Gets the avsDataStore property: avsDataStore

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

      Returns:
      the avsDataStore value.

    • isDefaultQuotaEnabled

      Boolean isDefaultQuotaEnabled()
      Gets the isDefaultQuotaEnabled property: Specifies if default quota is enabled for the volume.
      Returns:
      the isDefaultQuotaEnabled value.

    • defaultUserQuotaInKiBs

      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.

    • defaultGroupQuotaInKiBs

      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.

    • maximumNumberOfFiles

      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.

    • volumeGroupName

      String volumeGroupName()
      Gets the volumeGroupName property: Volume Group Name.
      Returns:
      the volumeGroupName value.

    • capacityPoolResourceId

      String capacityPoolResourceId()
      Gets the capacityPoolResourceId property: Pool Resource Id used in case of creating a volume through volume group.
      Returns:
      the capacityPoolResourceId value.

    • proximityPlacementGroup

      String proximityPlacementGroup()
      Gets the proximityPlacementGroup property: Proximity placement group associated with the volume.
      Returns:
      the proximityPlacementGroup value.

    • t2Network

      String t2Network()
      Gets the t2Network property: T2 network information.
      Returns:
      the t2Network value.

    • volumeSpecName

      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.

    • encrypted

      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.

    • placementRules

      List<PlacementKeyValuePairs> placementRules()
      Gets the placementRules property: Volume placement rules

      Application specific placement rules for the particular volume.

      Returns:
      the placementRules value.

    • enableSubvolumes

      EnableSubvolumes enableSubvolumes()
      Gets the enableSubvolumes property: Flag indicating whether subvolume operations are enabled on the volume.
      Returns:
      the enableSubvolumes value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      VolumeInner innerModel()
      Gets the inner com.azure.resourcemanager.netapp.fluent.models.VolumeInner object.
      Returns:
      the inner object.

    • update

      Volume.Update update()
      Begins update for the Volume resource.
      Returns:
      the stage of resource update.

    • refresh

      Volume refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      Volume refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • revert

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • revert

      void revert(VolumeRevert body, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • resetCifsPassword

      void resetCifsPassword()
      Reset cifs password

      Reset cifs password from volume.

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • resetCifsPassword

      void resetCifsPassword(com.azure.core.util.Context context)
      Reset cifs password

      Reset cifs password from volume.

      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • breakReplication

      void breakReplication(BreakReplicationRequest body)
      Break volume replication

      Break the replication connection on the destination volume.

      Parameters:
      body - Optional body to force break the replication.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • breakReplication

      void breakReplication()
      Break volume replication

      Break the replication connection on the destination volume.

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • breakReplication

      void breakReplication(BreakReplicationRequest body, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • reestablishReplication

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • reestablishReplication

      void reestablishReplication(ReestablishReplicationRequest body, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listReplications

      com.azure.core.http.rest.PagedIterable<Replication> listReplications()
      List replications for volume

      List all replications for a specified volume.

      Returns:
      list Replications as paginated response with PagedIterable.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listReplications

      com.azure.core.http.rest.PagedIterable<Replication> listReplications(com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • resyncReplication

      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.

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • resyncReplication

      void resyncReplication(com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteReplication

      void deleteReplication()
      Delete volume replication

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

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteReplication

      void deleteReplication(com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • authorizeReplication

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • authorizeReplication

      void authorizeReplication(AuthorizeRequest body, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • reInitializeReplication

      void reInitializeReplication()
      ReInitialize volume replication

      Re-Initializes the replication connection on the destination volume.

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • reInitializeReplication

      void reInitializeReplication(com.azure.core.util.Context context)
      ReInitialize volume replication

      Re-Initializes the replication connection on the destination volume.

      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • poolChange

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • poolChange

      void poolChange(PoolChangeRequest body, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • relocate

      void relocate(RelocateVolumeRequest body)
      Relocate volume

      Relocates volume to a new stamp.

      Parameters:
      body - Relocate volume request.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • relocate

      void relocate()
      Relocate volume

      Relocates volume to a new stamp.

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • relocate

      void relocate(RelocateVolumeRequest body, com.azure.core.util.Context context)
      Relocate volume

      Relocates volume to a new stamp.

      Parameters:
      body - Relocate volume request.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • finalizeRelocation

      void finalizeRelocation()
      Finalize volume relocation

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

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • finalizeRelocation

      void finalizeRelocation(com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • revertRelocation

      void revertRelocation()
      Revert volume relocation

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

      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • revertRelocation

      void revertRelocation(com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.