Package version:

Interface VolumeGroupVolumeProperties

Volume resource

interface VolumeGroupVolumeProperties {
    acceptGrowCapacityPoolForShortTermCloneSplit?: string;
    actualThroughputMibps?: number;
    avsDataStore?: string;
    backupId?: string;
    baremetalTenantId?: string;
    capacityPoolResourceId?: string;
    cloneProgress?: number;
    coolAccess?: boolean;
    coolAccessRetrievalPolicy?: string;
    coolnessPeriod?: number;
    creationToken: string;
    dataProtection?: VolumePropertiesDataProtection;
    dataStoreResourceId?: string[];
    defaultGroupQuotaInKiBs?: number;
    defaultUserQuotaInKiBs?: number;
    deleteBaseSnapshot?: boolean;
    effectiveNetworkFeatures?: string;
    enableSubvolumes?: string;
    encrypted?: boolean;
    encryptionKeySource?: string;
    exportPolicy?: VolumePropertiesExportPolicy;
    fileAccessLogs?: string;
    fileSystemId?: string;
    id?: string;
    inheritedSizeInBytes?: number;
    isDefaultQuotaEnabled?: boolean;
    isLargeVolume?: boolean;
    isRestoring?: boolean;
    kerberosEnabled?: boolean;
    keyVaultPrivateEndpointResourceId?: string;
    language?: string;
    ldapEnabled?: boolean;
    maximumNumberOfFiles?: number;
    mountTargets?: MountTargetProperties[];
    name?: string;
    networkFeatures?: string;
    networkSiblingSetId?: string;
    originatingResourceId?: string;
    placementRules?: PlacementKeyValuePairs[];
    protocolTypes?: string[];
    provisionedAvailabilityZone?: string;
    provisioningState?: string;
    proximityPlacementGroup?: string;
    securityStyle?: string;
    serviceLevel?: string;
    smbAccessBasedEnumeration?: string;
    smbContinuouslyAvailable?: boolean;
    smbEncryption?: boolean;
    smbNonBrowsable?: string;
    snapshotDirectoryVisible?: boolean;
    snapshotId?: string;
    storageToNetworkProximity?: string;
    subnetId: string;
    t2Network?: string;
    tags?: {
        [propertyName: string]: string;
    };
    throughputMibps?: number;
    type?: string;
    unixPermissions?: string;
    usageThreshold: number;
    volumeGroupName?: string;
    volumeSpecName?: string;
    volumeType?: string;
    zones?: string[];
}

Properties

acceptGrowCapacityPoolForShortTermCloneSplit? actualThroughputMibps? avsDataStore? backupId? baremetalTenantId? capacityPoolResourceId? cloneProgress? coolAccess? coolAccessRetrievalPolicy? coolnessPeriod? creationToken dataProtection? dataStoreResourceId? defaultGroupQuotaInKiBs? defaultUserQuotaInKiBs? deleteBaseSnapshot? effectiveNetworkFeatures? enableSubvolumes? encrypted? encryptionKeySource? exportPolicy? fileAccessLogs? fileSystemId? id? inheritedSizeInBytes? isDefaultQuotaEnabled? isLargeVolume? isRestoring? kerberosEnabled? keyVaultPrivateEndpointResourceId? language? ldapEnabled? maximumNumberOfFiles? mountTargets? name? networkFeatures? networkSiblingSetId? originatingResourceId? placementRules? protocolTypes? provisionedAvailabilityZone? provisioningState? proximityPlacementGroup? securityStyle? serviceLevel? smbAccessBasedEnumeration? smbContinuouslyAvailable? smbEncryption? smbNonBrowsable? snapshotDirectoryVisible? snapshotId? storageToNetworkProximity? subnetId t2Network? tags? throughputMibps? type? unixPermissions? usageThreshold volumeGroupName? volumeSpecName? volumeType? zones?

Properties

OptionalacceptGrowCapacityPoolForShortTermCloneSplit

acceptGrowCapacityPoolForShortTermCloneSplit?: string

While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted.

Optional ReadonlyactualThroughputMibps

actualThroughputMibps?: number

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.

OptionalavsDataStore

avsDataStore?: string

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

OptionalbackupId

backupId?: string

Resource identifier used to identify the Backup.

Optional ReadonlybaremetalTenantId

baremetalTenantId?: string

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

OptionalcapacityPoolResourceId

capacityPoolResourceId?: string

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

Optional ReadonlycloneProgress

cloneProgress?: number

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.

OptionalcoolAccess

coolAccess?: boolean

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

OptionalcoolAccessRetrievalPolicy

coolAccessRetrievalPolicy?: string

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.

OptionalcoolnessPeriod

coolnessPeriod?: number

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

creationToken

creationToken: string

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

OptionaldataProtection

dataProtection?: VolumePropertiesDataProtection

DataProtection type volumes include an object containing details of the replication

Optional ReadonlydataStoreResourceId

dataStoreResourceId?: string[]

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

OptionaldefaultGroupQuotaInKiBs

defaultGroupQuotaInKiBs?: number

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

OptionaldefaultUserQuotaInKiBs

defaultUserQuotaInKiBs?: number

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

OptionaldeleteBaseSnapshot

deleteBaseSnapshot?: boolean

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

Optional ReadonlyeffectiveNetworkFeatures

effectiveNetworkFeatures?: string

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.

OptionalenableSubvolumes

enableSubvolumes?: string

Flag indicating whether subvolume operations are enabled on the volume

Optional Readonlyencrypted

encrypted?: boolean

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.

OptionalencryptionKeySource

encryptionKeySource?: string

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'

OptionalexportPolicy

exportPolicy?: VolumePropertiesExportPolicy

Set of export policy rules

Optional ReadonlyfileAccessLogs

fileAccessLogs?: string

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.

Optional ReadonlyfileSystemId

fileSystemId?: string

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

Optional Readonlyid

id?: string

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlyinheritedSizeInBytes

inheritedSizeInBytes?: number

Space shared by short term clone volume with parent volume in bytes. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalisDefaultQuotaEnabled

isDefaultQuotaEnabled?: boolean

Specifies if default quota is enabled for the volume.

OptionalisLargeVolume

isLargeVolume?: boolean

Specifies whether volume is a Large Volume or Regular Volume.

OptionalisRestoring

isRestoring?: boolean

Restoring

OptionalkerberosEnabled

kerberosEnabled?: boolean

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

OptionalkeyVaultPrivateEndpointResourceId

keyVaultPrivateEndpointResourceId?: string

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

Optionallanguage

language?: string

Language supported for volume.

OptionalldapEnabled

ldapEnabled?: boolean

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

Optional ReadonlymaximumNumberOfFiles

maximumNumberOfFiles?: number

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.

Optional ReadonlymountTargets

mountTargets?: MountTargetProperties[]

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

Optionalname

name?: string

Resource name

OptionalnetworkFeatures

networkFeatures?: string

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

Optional ReadonlynetworkSiblingSetId

networkSiblingSetId?: string

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.

Optional ReadonlyoriginatingResourceId

originatingResourceId?: string

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.

OptionalplacementRules

placementRules?: PlacementKeyValuePairs[]

Application specific placement rules for the particular volume

OptionalprotocolTypes

protocolTypes?: string[]

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

Optional ReadonlyprovisionedAvailabilityZone

provisionedAvailabilityZone?: string

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.

Optional ReadonlyprovisioningState

provisioningState?: string

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

OptionalproximityPlacementGroup

proximityPlacementGroup?: string

Proximity placement group associated with the volume

OptionalsecurityStyle

securityStyle?: string

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

OptionalserviceLevel

serviceLevel?: string

The service level of the file system

OptionalsmbAccessBasedEnumeration

smbAccessBasedEnumeration?: string

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

OptionalsmbContinuouslyAvailable

smbContinuouslyAvailable?: boolean

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

OptionalsmbEncryption

smbEncryption?: boolean

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

OptionalsmbNonBrowsable

smbNonBrowsable?: string

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

OptionalsnapshotDirectoryVisible

snapshotDirectoryVisible?: boolean

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

OptionalsnapshotId

snapshotId?: string

Resource identifier used to identify the Snapshot.

Optional ReadonlystorageToNetworkProximity

storageToNetworkProximity?: string

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

subnetId: string

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

Optional Readonlyt2Network

t2Network?: string

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

Optionaltags

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

Resource tags

OptionalthroughputMibps

throughputMibps?: number

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

Optional Readonlytype

type?: string

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

OptionalunixPermissions

unixPermissions?: string

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. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only.

usageThreshold

usageThreshold: number

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 1PiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.

Optional ReadonlyvolumeGroupName

volumeGroupName?: string

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

OptionalvolumeSpecName

volumeSpecName?: string

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

OptionalvolumeType

volumeType?: string

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

Optionalzones

zones?: string[]

Availability Zone

Settings

Member Visibility