GetCapacityPoolVolumeResult

data class GetCapacityPoolVolumeResult(val actualThroughputMibps: Double, val avsDataStore: String? = null, val azureApiVersion: String, val backupId: String? = null, val baremetalTenantId: String, val capacityPoolResourceId: String? = null, val cloneProgress: Int, val coolAccess: Boolean? = null, val coolAccessRetrievalPolicy: String? = null, val coolAccessTieringPolicy: String? = null, val coolnessPeriod: Int? = null, val creationToken: String, val dataProtection: VolumePropertiesResponseDataProtection? = null, val dataStoreResourceId: List<String>, val defaultGroupQuotaInKiBs: Double? = null, val defaultUserQuotaInKiBs: Double? = null, val deleteBaseSnapshot: Boolean? = null, val effectiveNetworkFeatures: String, val enableSubvolumes: String? = null, val encrypted: Boolean, val encryptionKeySource: String? = null, val etag: String, val exportPolicy: VolumePropertiesResponseExportPolicy? = null, val fileAccessLogs: String, val fileSystemId: String, val id: String, val isDefaultQuotaEnabled: Boolean? = null, val isLargeVolume: Boolean? = null, val isRestoring: Boolean? = null, val kerberosEnabled: Boolean? = null, val keyVaultPrivateEndpointResourceId: String? = null, val ldapEnabled: Boolean? = null, val location: String, val maximumNumberOfFiles: Double, val mountTargets: List<MountTargetPropertiesResponse>, val name: String, val networkFeatures: String? = null, val networkSiblingSetId: String, val originatingResourceId: String, val placementRules: List<PlacementKeyValuePairsResponse>? = null, val protocolTypes: List<String>? = null, val provisionedAvailabilityZone: String, val provisioningState: String, val proximityPlacementGroup: String? = null, val securityStyle: String? = null, val serviceLevel: String? = null, val smbAccessBasedEnumeration: String? = null, val smbContinuouslyAvailable: Boolean? = null, val smbEncryption: Boolean? = null, val smbNonBrowsable: String? = null, val snapshotDirectoryVisible: Boolean? = null, val snapshotId: String? = null, val storageToNetworkProximity: String, val subnetId: String, val systemData: SystemDataResponse, val t2Network: String, val tags: Map<String, String>? = null, val throughputMibps: Double? = null, val type: String, val unixPermissions: String? = null, val usageThreshold: Double, val volumeGroupName: String, val volumeSpecName: String? = null, val volumeType: String? = null, val zones: List<String>? = null)

Volume resource

Constructors

Link copied to clipboard
constructor(actualThroughputMibps: Double, avsDataStore: String? = null, azureApiVersion: String, backupId: String? = null, baremetalTenantId: String, capacityPoolResourceId: String? = null, cloneProgress: Int, coolAccess: Boolean? = null, coolAccessRetrievalPolicy: String? = null, coolAccessTieringPolicy: String? = null, coolnessPeriod: Int? = null, creationToken: String, dataProtection: VolumePropertiesResponseDataProtection? = null, dataStoreResourceId: List<String>, defaultGroupQuotaInKiBs: Double? = null, defaultUserQuotaInKiBs: Double? = null, deleteBaseSnapshot: Boolean? = null, effectiveNetworkFeatures: String, enableSubvolumes: String? = null, encrypted: Boolean, encryptionKeySource: String? = null, etag: String, exportPolicy: VolumePropertiesResponseExportPolicy? = null, fileAccessLogs: String, fileSystemId: String, id: String, isDefaultQuotaEnabled: Boolean? = null, isLargeVolume: Boolean? = null, isRestoring: Boolean? = null, kerberosEnabled: Boolean? = null, keyVaultPrivateEndpointResourceId: String? = null, ldapEnabled: Boolean? = null, location: String, maximumNumberOfFiles: Double, mountTargets: List<MountTargetPropertiesResponse>, name: String, networkFeatures: String? = null, networkSiblingSetId: String, originatingResourceId: String, placementRules: List<PlacementKeyValuePairsResponse>? = null, protocolTypes: List<String>? = null, provisionedAvailabilityZone: String, provisioningState: String, proximityPlacementGroup: String? = null, securityStyle: String? = null, serviceLevel: String? = null, smbAccessBasedEnumeration: String? = null, smbContinuouslyAvailable: Boolean? = null, smbEncryption: Boolean? = null, smbNonBrowsable: String? = null, snapshotDirectoryVisible: Boolean? = null, snapshotId: String? = null, storageToNetworkProximity: String, subnetId: String, systemData: SystemDataResponse, t2Network: String, tags: Map<String, String>? = null, throughputMibps: Double? = null, type: String, unixPermissions: String? = null, usageThreshold: Double, volumeGroupName: String, volumeSpecName: String? = null, volumeType: String? = null, zones: List<String>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard
val avsDataStore: String? = null

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

Link copied to clipboard

The Azure API version of the resource.

Link copied to clipboard
val backupId: String? = null

Resource identifier used to identify the Backup.

Link copied to clipboard

Unique Baremetal Tenant Identifier.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
val coolAccess: Boolean? = null

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

Link copied to clipboard

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.

Link copied to clipboard

coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier.

Link copied to clipboard
val coolnessPeriod: Int? = null

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

Link copied to clipboard

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

Link copied to clipboard

DataProtection type volumes include an object containing details of the replication

Link copied to clipboard

Data store resource unique identifier

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The effective value of the network features type available to the volume, or current effective state of update.

Link copied to clipboard

Flag indicating whether subvolume operations are enabled on the volume

Link copied to clipboard

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

Link copied to clipboard

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'

Link copied to clipboard

A unique read-only string that changes whenever the resource is updated.

Link copied to clipboard

Set of export policy rules

Link copied to clipboard

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

Link copied to clipboard

Unique FileSystem Identifier.

Link copied to clipboard
val id: String

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

Link copied to clipboard

Specifies if default quota is enabled for the volume.

Link copied to clipboard
val isLargeVolume: Boolean? = null

Specifies whether volume is a Large Volume or Regular Volume.

Link copied to clipboard
val isRestoring: Boolean? = null

Restoring

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val ldapEnabled: Boolean? = null

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

Link copied to clipboard

The geo-location where the resource lives

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

The name of the resource

Link copied to clipboard
val networkFeatures: String? = null

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

Link copied to clipboard

Network Sibling Set ID for the the group of volumes sharing networking resources.

Link copied to clipboard

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

Link copied to clipboard

Application specific placement rules for the particular volume

Link copied to clipboard
val protocolTypes: List<String>? = null

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

Link copied to clipboard

The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.

Link copied to clipboard

Azure lifecycle management

Link copied to clipboard

Proximity placement group associated with the volume

Link copied to clipboard
val securityStyle: String? = null

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

Link copied to clipboard
val serviceLevel: String? = null

The service level of the file system

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val smbEncryption: Boolean? = null

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

Link copied to clipboard
val smbNonBrowsable: String? = null

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

Link copied to clipboard

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

Link copied to clipboard
val snapshotId: String? = null

Resource identifier used to identify the Snapshot.

Link copied to clipboard

Provides storage to network proximity information for the volume.

Link copied to clipboard

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

Link copied to clipboard

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Link copied to clipboard

T2 network information

Link copied to clipboard
val tags: Map<String, String>? = null

Resource tags.

Link copied to clipboard
val throughputMibps: Double? = null
Link copied to clipboard

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

Link copied to clipboard
val unixPermissions: String? = null

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.

Link copied to clipboard

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.

Link copied to clipboard

Volume Group Name

Link copied to clipboard
val volumeSpecName: String? = null

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

Link copied to clipboard
val volumeType: String? = null

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

Link copied to clipboard
val zones: List<String>? = null

Availability Zone