Volume Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Volume resource
[Microsoft.Rest.Serialization.JsonTransformation]
public class Volume : Microsoft.Azure.Management.NetApp.Models.TrackedResource[<Microsoft.Rest.Serialization.JsonTransformation>]
type Volume = class
inherit TrackedResourcePublic Class Volume
Inherits TrackedResource- Inheritance
- Attributes
Constructors
Properties
| ActualThroughputMibps |
Gets actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel |
| AvsDataStore |
Gets or sets specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose Possible values include: 'Enabled', 'Disabled' |
| BackupId |
Gets or sets resource identifier used to identify the Backup. |
| BaremetalTenantId |
Gets unique Baremetal Tenant Identifier. |
| CapacityPoolResourceId |
Gets or sets pool Resource Id used in case of creating a volume through volume group |
| CloneProgress |
Gets 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. |
| CoolAccess |
Gets or sets specifies whether Cool Access(tiering) is enabled for the volume. |
| CoolAccessRetrievalPolicy |
Gets or sets 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. Possible values include: 'Default', 'OnRead', 'Never' |
| CoolnessPeriod |
Gets or sets specifies the number of days after which data that is not accessed by clients will be tiered. |
| CreationToken |
Gets or sets a unique file path for the volume. Used when creating mount targets |
| DataProtection |
Gets or sets dataProtection type volumes include an object containing details of the replication |
| DataStoreResourceId |
Gets data store resource unique identifier |
| DefaultGroupQuotaInKiBs |
Gets or sets default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. |
| DefaultUserQuotaInKiBs |
Gets or sets default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . |
| DeleteBaseSnapshot |
Gets or sets if enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false |
| EffectiveNetworkFeatures |
Gets the effective value of the network features type available to the volume, or current effective state of update. Possible values include: 'Basic', 'Standard', 'Basic_Standard', 'Standard_Basic' |
| EnableSubvolumes |
Gets or sets flag indicating whether subvolume operations are enabled on the volume Possible values include: 'Enabled', 'Disabled' |
| Encrypted |
Gets specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. |
| EncryptionKeySource |
Gets or sets 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' Possible values include: 'Microsoft.NetApp', 'Microsoft.KeyVault' |
| Etag |
Gets a unique read-only string that changes whenever the resource is updated. |
| ExportPolicy |
Gets or sets set of export policy rules |
| FileAccessLogs |
Gets flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. Possible values include: 'Enabled', 'Disabled' |
| FileSystemId |
Gets unique FileSystem Identifier. |
| Id |
Gets fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" (Inherited from Resource) |
| IsDefaultQuotaEnabled |
Gets or sets specifies if default quota is enabled for the volume. |
| IsLargeVolume |
Gets or sets specifies whether volume is a Large Volume or Regular Volume. |
| IsRestoring |
Gets or sets restoring |
| KerberosEnabled |
Gets or sets describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later |
| KeyVaultPrivateEndpointResourceId |
Gets or sets the resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. |
| LdapEnabled |
Gets or sets specifies whether LDAP is enabled or not for a given NFS volume. |
| Location |
Gets or sets the geo-location where the resource lives (Inherited from TrackedResource) |
| MaximumNumberOfFiles |
Gets 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. |
| MountTargets |
Gets list of mount targets |
| Name |
Gets the name of the resource (Inherited from Resource) |
| NetworkFeatures |
Gets or sets the original value of the network features type available to the volume at the time it was created. Possible values include: 'Basic', 'Standard', 'Basic_Standard', 'Standard_Basic' |
| NetworkSiblingSetId |
Gets network Sibling Set ID for the the group of volumes sharing networking resources. |
| OriginatingResourceId |
Gets id of the snapshot or backup that the volume is restored from. |
| PlacementRules |
Gets or sets application specific placement rules for the particular volume |
| ProtocolTypes |
Gets or sets set of protocol types, default NFSv3, CIFS for SMB protocol |
| ProvisionedAvailabilityZone |
Gets the availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. |
| ProvisioningState |
Gets azure lifecycle management |
| ProximityPlacementGroup |
Gets or sets proximity placement group associated with the volume |
| SecurityStyle |
Gets or sets the security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol Possible values include: 'ntfs', 'unix' |
| ServiceLevel |
Gets or sets the service level of the file system Possible values include: 'Standard', 'Premium', 'Ultra', 'StandardZRS' |
| SmbAccessBasedEnumeration |
Gets or sets enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume Possible values include: 'Disabled', 'Enabled' |
| SmbContinuouslyAvailable |
Gets or sets enables continuously available share property for smb volume. Only applicable for SMB volume |
| SmbEncryption |
Gets or sets enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later |
| SmbNonBrowsable |
Gets or sets enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume Possible values include: 'Disabled', 'Enabled' |
| SnapshotDirectoryVisible |
Gets or sets 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). |
| SnapshotId |
Gets or sets resource identifier used to identify the Snapshot. |
| StorageToNetworkProximity |
Gets provides storage to network proximity information for the volume. Possible values include: 'Default', 'T1', 'T2', 'AcrossT2' |
| SubnetId |
Gets or sets the Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes |
| SystemData |
Gets azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from Resource) |
| T2Network |
Gets t2 network information |
| Tags |
Gets or sets resource tags. (Inherited from TrackedResource) |
| ThroughputMibps |
Gets or sets maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume |
| Type |
Gets the type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" (Inherited from Resource) |
| UnixPermissions |
Gets or sets 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
|
| UsageThreshold |
Gets or sets maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. |
| VolumeGroupName |
Gets volume Group Name |
| VolumeSpecName |
Gets or sets volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log |
| VolumeType |
Gets or sets what type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection |
| Zones |
Gets or sets availability Zone |
Methods
| Validate() |
Validate the object. |
Extension Methods
| ToPsNetAppFilesVolume(Volume) |