NetAppVolumeData Class

Definition

A class representing the NetAppVolume data model. Volume resource

public class NetAppVolumeData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.NetApp.NetAppVolumeData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.NetApp.NetAppVolumeData>
type NetAppVolumeData = class
    inherit TrackedResourceData
    interface IJsonModel<NetAppVolumeData>
    interface IPersistableModel<NetAppVolumeData>
Public Class NetAppVolumeData
Inherits TrackedResourceData
Implements IJsonModel(Of NetAppVolumeData), IPersistableModel(Of NetAppVolumeData)
Inheritance
Implements

Constructors

NetAppVolumeData(AzureLocation, String, Int64, ResourceIdentifier)

Initializes a new instance of NetAppVolumeData.

Properties

ActualThroughputMibps

Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel.

AvsDataStore

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

BackupId

UUID v4 or resource identifier used to identify the Backup.

BaremetalTenantId

Unique Baremetal Tenant Identifier.

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.

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.

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.

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.

ExportRules

Export policy rule.

FileAccessLogs

Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.

FileSystemId

Unique FileSystem Identifier.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
InheritedSizeInBytes

Space shared by short term clone volume with parent volume in bytes.

IsCoolAccessEnabled

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

IsDefaultQuotaEnabled

Specifies if default quota is enabled for the volume.

IsEncrypted

Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.

IsKerberosEnabled

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

IsLargeVolume

Specifies whether volume is a Large Volume or Regular Volume.

IsLdapEnabled

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

IsRestoring

Restoring.

IsSmbContinuouslyAvailable

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

IsSmbEncryptionEnabled

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

IsSnapshotDirectoryVisible

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

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

Location

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
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.

MountTargets

List of mount targets.

Name

The name of the resource.

(Inherited from ResourceData)
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.

OriginatingResourceId

Id of the snapshot or backup that the volume is restored from.

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.

ProvisioningState

Azure lifecycle management.

ProximityPlacementGroupId

Proximity placement group associated with the volume.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
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.

SmbNonBrowsable

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

SnapshotId

UUID v4 or resource identifier used to identify the Snapshot.

StorageToNetworkProximity

Provides storage to network proximity information for the volume.

SubnetId

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

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
T2Network

T2 network information.

Tags

Resource tags.

(Inherited from TrackedResourceData)
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.

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.

Explicit Interface Implementations

IJsonModel<NetAppVolumeData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<NetAppVolumeData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<NetAppVolumeData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<NetAppVolumeData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<NetAppVolumeData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to