Volume

class Volume : KotlinCustomResource

Manages a NetApp Volume. !>Note: This resource uses a feature to prevent deletion called prevent_volume_destruction, defaulting to true. It is intentionally set to true to prevent the possibility of accidental data loss. The example in this page shows all possible protection options you can apply, it is using same values as the defaults.

Import

NetApp Volumes can be imported using the resource id, e.g.

$ pulumi import azure:netapp/volume:Volume example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1

Properties

Link copied to clipboard
val accountName: Output<String>

The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.

Link copied to clipboard

Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.

Link copied to clipboard

Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name. Changing this forces a new resource to be created.

Link copied to clipboard

A data_protection_backup_policy block as defined below.

Link copied to clipboard

A data_protection_replication block as defined below. Changing this forces a new resource to be created.

Link copied to clipboard

A data_protection_snapshot_policy block as defined below.

Link copied to clipboard

The encryption key source, it can be Microsoft.NetApp for platform managed keys or Microsoft.KeyVault for customer-managed keys. This is required with key_vault_private_endpoint_id. Changing this forces a new resource to be created.

Link copied to clipboard

One or more export_policy_rule block defined below.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val kerberosEnabled: Output<Boolean>?

Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Account having a defined AD connection.

Link copied to clipboard

The Private Endpoint ID for Key Vault, which is required when using customer-managed keys. This is required with encryption_key_source. Changing this forces a new resource to be created.

Link copied to clipboard
val location: Output<String>

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Link copied to clipboard

A list of IPv4 Addresses which should be used to mount the volume.

Link copied to clipboard
val name: Output<String>

The name of the NetApp Volume. Changing this forces a new resource to be created.

Link copied to clipboard
val networkFeatures: Output<String>

Indicates which network feature to use, accepted values are Basic or Standard, it defaults to Basic if not defined. This is a feature in public preview and for more information about it and how to register, please refer to Configure network features for an Azure NetApp Files volume.

Link copied to clipboard
val poolName: Output<String>

The name of the NetApp pool in which the NetApp Volume should be created.

Link copied to clipboard
val protocols: Output<List<String>>

The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.

Link copied to clipboard
val securityStyle: Output<String>

Volume security style, accepted values are unix or ntfs. If not provided, single-protocol volume is created defaulting to unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to ntfs. In a dual-protocol volume, if not provided, its value will be ntfs. Changing this forces a new resource to be created.

Link copied to clipboard
val serviceLevel: Output<String>
Link copied to clipboard

Enable SMB encryption.

Link copied to clipboard

Limits enumeration of files and folders (that is, listing the contents) in SMB only to users with allowed access on the share. For instance, if a user doesn't have access to read a file or folder in a share with access-based enumeration enabled, then the file or folder doesn't show up in directory listings. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files

Link copied to clipboard

Enable SMB Continuous Availability.

Link copied to clipboard

Limits clients from browsing for an SMB share by hiding the share from view in Windows Explorer or when listing shares in "net view." Only end users that know the absolute paths to the share are able to find the share. Defaults to false. For more information, please refer to Understand NAS share permissions in Azure NetApp Files

Link copied to clipboard

Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.

Link copied to clipboard
val storageQuotaInGb: Output<Int>

The maximum Storage Quota allowed for a file system in Gigabytes.

Link copied to clipboard
val subnetId: Output<String>

The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.

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

A mapping of tags to assign to the resource.

Link copied to clipboard

Throughput of this volume in Mibps.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val volumePath: Output<String>

A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.

Link copied to clipboard
val zone: Output<String>?

Specifies the Availability Zone in which the Volume should be located. Possible values are 1, 2 and 3. Changing this forces a new resource to be created. This feature is currently in preview, for more information on how to enable it, please refer to Manage availability zone volume placement for Azure NetApp Files.