Volume interface

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

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

avsDataStore?: string

Property Value

Resource identifier used to identify the Backup.

backupId?: string

Property Value

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

baremetalTenantId?: string

Property Value

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

capacityPoolResourceId?: string

Property Value

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

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

coolAccess?: boolean

Property Value

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

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

coolnessPeriod?: number

Property Value

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

creationToken: string

Property Value

DataProtection type volumes include an object containing details of the replication

dataProtection?: VolumePropertiesDataProtection

Property Value

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

dataStoreResourceId?: string[]

Property Value

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

defaultGroupQuotaInKiBs?: number

Property Value

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

defaultUserQuotaInKiBs?: number

Property Value

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

The effective value of the network features type available to the volume, or current effective state of update. NOTE: This property will not be serialized. It can only be populated by the server.

effectiveNetworkFeatures?: string

Property Value

Flag indicating whether subvolume operations are enabled on the volume

enableSubvolumes?: string

Property Value

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

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

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

Set of export policy rules

exportPolicy?: VolumePropertiesExportPolicy

Property Value

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

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

fileSystemId?: string

Property Value

Specifies if default quota is enabled for the volume.

isDefaultQuotaEnabled?: boolean

Property Value

Specifies whether volume is a Large Volume or Regular Volume.

isLargeVolume?: boolean

Property Value

Restoring

isRestoring?: boolean

Property Value

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

kerberosEnabled?: boolean

Property Value

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

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

ldapEnabled?: boolean

Property Value

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

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

mountTargets?: MountTargetProperties[]

Property Value

The original value of the network features type available to the volume at the time it was created.

networkFeatures?: string

Property Value

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

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

Application specific placement rules for the particular volume

placementRules?: PlacementKeyValuePairs[]

Property Value

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

protocolTypes?: string[]

Property Value

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

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

provisioningState?: string

Property Value

Proximity placement group associated with the volume

proximityPlacementGroup?: string

Property Value

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

securityStyle?: string

Property Value

The service level of the file system

serviceLevel?: string

Property Value

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

smbAccessBasedEnumeration?: string

Property Value

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

smbContinuouslyAvailable?: boolean

Property Value

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

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

smbNonBrowsable?: string

Property Value

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

Resource identifier used to identify the Snapshot.

snapshotId?: string

Property Value

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

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

subnetId: string

Property Value

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

t2Network?: string

Property Value

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

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

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.

usageThreshold: number

Property Value

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

volumeGroupName?: string

Property Value

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

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

volumeType?: string

Property Value

Availability Zone

zones?: string[]

Property Value

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

Inherited From TrackedResource.id

The geo-location where the resource lives

location: string

Property Value

Inherited From TrackedResource.location

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

name?: string

Property Value

Inherited From TrackedResource.name

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

Inherited From TrackedResource.systemData

Resource tags.

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

Property Value

Inherited From TrackedResource.tags

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

Inherited From TrackedResource.type