Volume interface

Package:

@azure/arm-netapp

Volume resource

Extends

TrackedResource

Properties

actualThroughputMibps	Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel NOTE: This property will not be serialized. It can only be populated by the server.
avsDataStore	Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose
backupId	Resource identifier used to identify the Backup.
baremetalTenantId	Unique Baremetal Tenant Identifier. NOTE: This property will not be serialized. It can only be populated by the server.
capacityPoolResourceId	Pool Resource Id used in case of creating a volume through volume group
cloneProgress	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. NOTE: This property will not be serialized. It can only be populated by the server.
coolAccess	Specifies whether Cool Access(tiering) is enabled for the volume.
coolAccessRetrievalPolicy	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.
coolnessPeriod	Specifies the number of days after which data that is not accessed by clients will be tiered.
creationToken	A unique file path for the volume. Used when creating mount targets
dataProtection	DataProtection type volumes include an object containing details of the replication
dataStoreResourceId	Data store resource unique identifier NOTE: This property will not be serialized. It can only be populated by the server.
defaultGroupQuotaInKiBs	Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
defaultUserQuotaInKiBs	Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
deleteBaseSnapshot	If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false
enableSubvolumes	Flag indicating whether subvolume operations are enabled on the volume
encrypted	Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. NOTE: This property will not be serialized. It can only be populated by the server.
encryptionKeySource	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'
etag	A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
exportPolicy	Set of export policy rules
fileAccessLogs	Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. NOTE: This property will not be serialized. It can only be populated by the server.
fileSystemId	Unique FileSystem Identifier. NOTE: This property will not be serialized. It can only be populated by the server.
isDefaultQuotaEnabled	Specifies if default quota is enabled for the volume.
isLargeVolume	Specifies whether volume is a Large Volume or Regular Volume.
isRestoring	Restoring
kerberosEnabled	Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later
keyVaultPrivateEndpointResourceId	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	Specifies whether LDAP is enabled or not for a given NFS volume.
maximumNumberOfFiles	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. NOTE: This property will not be serialized. It can only be populated by the server.
mountTargets	List of mount targets NOTE: This property will not be serialized. It can only be populated by the server.
networkFeatures	Network features available to the volume, or current state of update.
networkSiblingSetId	Network Sibling Set ID for the the group of volumes sharing networking resources. NOTE: This property will not be serialized. It can only be populated by the server.
originatingResourceId	Id of the snapshot or backup that the volume is restored from. NOTE: This property will not be serialized. It can only be populated by the server.
placementRules	Application specific placement rules for the particular volume
protocolTypes	Set of protocol types, default NFSv3, CIFS for SMB protocol
provisionedAvailabilityZone	The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	Azure lifecycle management NOTE: This property will not be serialized. It can only be populated by the server.
proximityPlacementGroup	Proximity placement group associated with the volume
securityStyle	The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol
serviceLevel	The service level of the file system
smbAccessBasedEnumeration	Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
smbContinuouslyAvailable	Enables continuously available share property for smb volume. Only applicable for SMB volume
smbEncryption	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	Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
snapshotDirectoryVisible	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	Resource identifier used to identify the Snapshot.
storageToNetworkProximity	Provides storage to network proximity information for the volume. NOTE: This property will not be serialized. It can only be populated by the server.
subnetId	The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
t2Network	T2 network information NOTE: This property will not be serialized. It can only be populated by the server.
throughputMibps	Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume
unixPermissions	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.
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.
volumeGroupName	Volume Group Name NOTE: This property will not be serialized. It can only be populated by the server.
volumeSpecName	Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log
volumeType	What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection
zones	Availability Zone

Inherited Properties

id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

actualThroughputMibps

Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel NOTE: This property will not be serialized. It can only be populated by the server.

actualThroughputMibps?: number

Property Value

number

avsDataStore

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

avsDataStore?: string

Property Value

string

backupId

Resource identifier used to identify the Backup.

backupId?: string

Property Value

string

baremetalTenantId

Unique Baremetal Tenant Identifier. NOTE: This property will not be serialized. It can only be populated by the server.

baremetalTenantId?: string

Property Value

string

capacityPoolResourceId

Pool Resource Id used in case of creating a volume through volume group

capacityPoolResourceId?: string

Property Value

string

cloneProgress

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. NOTE: This property will not be serialized. It can only be populated by the server.

cloneProgress?: number

Property Value

number

coolAccess

Specifies whether Cool Access(tiering) is enabled for the volume.

coolAccess?: boolean

Property Value

boolean

coolAccessRetrievalPolicy

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.

coolAccessRetrievalPolicy?: string

Property Value

string

coolnessPeriod

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

coolnessPeriod?: number

Property Value

number

creationToken

A unique file path for the volume. Used when creating mount targets

creationToken: string

Property Value

string

dataProtection

DataProtection type volumes include an object containing details of the replication

dataProtection?: VolumePropertiesDataProtection

Property Value

VolumePropertiesDataProtection

dataStoreResourceId

Data store resource unique identifier NOTE: This property will not be serialized. It can only be populated by the server.

dataStoreResourceId?: string[]

Property Value

string[]

defaultGroupQuotaInKiBs

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

defaultGroupQuotaInKiBs?: number

Property Value

number

defaultUserQuotaInKiBs

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

defaultUserQuotaInKiBs?: number

Property Value

number

deleteBaseSnapshot

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

deleteBaseSnapshot?: boolean

Property Value

boolean

enableSubvolumes

Flag indicating whether subvolume operations are enabled on the volume

enableSubvolumes?: string

Property Value

string

encrypted

Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. NOTE: This property will not be serialized. It can only be populated by the server.

encrypted?: boolean

Property Value

boolean

encryptionKeySource

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'

encryptionKeySource?: string

Property Value

string

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

exportPolicy

Set of export policy rules

exportPolicy?: VolumePropertiesExportPolicy

Property Value

VolumePropertiesExportPolicy

fileAccessLogs

Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. NOTE: This property will not be serialized. It can only be populated by the server.

fileAccessLogs?: string

Property Value

string

fileSystemId

Unique FileSystem Identifier. NOTE: This property will not be serialized. It can only be populated by the server.

fileSystemId?: string

Property Value

string

isDefaultQuotaEnabled

Specifies if default quota is enabled for the volume.

isDefaultQuotaEnabled?: boolean

Property Value

boolean

isLargeVolume

Specifies whether volume is a Large Volume or Regular Volume.

isLargeVolume?: boolean

Property Value

boolean

isRestoring

Restoring

isRestoring?: boolean

Property Value

boolean

kerberosEnabled

Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later

kerberosEnabled?: boolean

Property Value

boolean

keyVaultPrivateEndpointResourceId

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

keyVaultPrivateEndpointResourceId?: string

Property Value

string

ldapEnabled

Specifies whether LDAP is enabled or not for a given NFS volume.

ldapEnabled?: boolean

Property Value

boolean

maximumNumberOfFiles

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. NOTE: This property will not be serialized. It can only be populated by the server.

maximumNumberOfFiles?: number

Property Value

number

mountTargets

List of mount targets NOTE: This property will not be serialized. It can only be populated by the server.

mountTargets?: MountTargetProperties[]

Property Value

MountTargetProperties[]

networkFeatures

Network features available to the volume, or current state of update.

networkFeatures?: string

Property Value

string

networkSiblingSetId

Network Sibling Set ID for the the group of volumes sharing networking resources. NOTE: This property will not be serialized. It can only be populated by the server.

networkSiblingSetId?: string

Property Value

string

originatingResourceId

Id of the snapshot or backup that the volume is restored from. NOTE: This property will not be serialized. It can only be populated by the server.

originatingResourceId?: string

Property Value

string

placementRules

Application specific placement rules for the particular volume

placementRules?: PlacementKeyValuePairs[]

Property Value

PlacementKeyValuePairs[]

protocolTypes

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

protocolTypes?: string[]

Property Value

string[]

provisionedAvailabilityZone

The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. NOTE: This property will not be serialized. It can only be populated by the server.

provisionedAvailabilityZone?: string

Property Value

string

provisioningState

Azure lifecycle management NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

proximityPlacementGroup

Proximity placement group associated with the volume

proximityPlacementGroup?: string

Property Value

string

securityStyle

The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol

securityStyle?: string

Property Value

string

serviceLevel

The service level of the file system

serviceLevel?: string

Property Value

string

smbAccessBasedEnumeration

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

smbAccessBasedEnumeration?: string

Property Value

string

smbContinuouslyAvailable

Enables continuously available share property for smb volume. Only applicable for SMB volume

smbContinuouslyAvailable?: boolean

Property Value

boolean

smbEncryption

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

smbEncryption?: boolean

Property Value

boolean

smbNonBrowsable

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

smbNonBrowsable?: string

Property Value

string

snapshotDirectoryVisible

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

snapshotDirectoryVisible?: boolean

Property Value

boolean

snapshotId

Resource identifier used to identify the Snapshot.

snapshotId?: string

Property Value

string

storageToNetworkProximity

Provides storage to network proximity information for the volume. NOTE: This property will not be serialized. It can only be populated by the server.

storageToNetworkProximity?: string

Property Value

string

subnetId

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

subnetId: string

Property Value

string

t2Network

T2 network information NOTE: This property will not be serialized. It can only be populated by the server.

t2Network?: string

Property Value

string

throughputMibps

Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume

throughputMibps?: number

Property Value

number

unixPermissions

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.

unixPermissions?: string

Property Value

string

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.

usageThreshold: number

Property Value

number

volumeGroupName

Volume Group Name NOTE: This property will not be serialized. It can only be populated by the server.

volumeGroupName?: string

Property Value

string

volumeSpecName

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

volumeSpecName?: string

Property Value

string

volumeType

What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection

volumeType?: string

Property Value

string

zones

Availability Zone

zones?: string[]

Property Value

string[]

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type