We recommend using Azure Native.
azure.netapp.Volume
Explore with Pulumi AI
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
Create Volume Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);@overload
def Volume(resource_name: str,
           args: VolumeArgs,
           opts: Optional[ResourceOptions] = None)
@overload
def Volume(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           pool_name: Optional[str] = None,
           volume_path: Optional[str] = None,
           subnet_id: Optional[str] = None,
           storage_quota_in_gb: Optional[int] = None,
           service_level: Optional[str] = None,
           resource_group_name: Optional[str] = None,
           account_name: Optional[str] = None,
           export_policy_rules: Optional[Sequence[VolumeExportPolicyRuleArgs]] = None,
           data_protection_snapshot_policy: Optional[VolumeDataProtectionSnapshotPolicyArgs] = None,
           location: Optional[str] = None,
           name: Optional[str] = None,
           network_features: Optional[str] = None,
           kerberos_enabled: Optional[bool] = None,
           protocols: Optional[Sequence[str]] = None,
           encryption_key_source: Optional[str] = None,
           security_style: Optional[str] = None,
           key_vault_private_endpoint_id: Optional[str] = None,
           smb_access_based_enumeration_enabled: Optional[bool] = None,
           smb_continuous_availability_enabled: Optional[bool] = None,
           smb_non_browsable_enabled: Optional[bool] = None,
           snapshot_directory_visible: Optional[bool] = None,
           data_protection_replication: Optional[VolumeDataProtectionReplicationArgs] = None,
           create_from_snapshot_resource_id: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           throughput_in_mibps: Optional[float] = None,
           azure_vmware_data_store_enabled: Optional[bool] = None,
           zone: Optional[str] = None)func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)
public Volume(String name, VolumeArgs args)
public Volume(String name, VolumeArgs args, CustomResourceOptions options)
type: azure:netapp:Volume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args VolumeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args VolumeArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args VolumeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VolumeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VolumeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var azureVolumeResource = new Azure.NetApp.Volume("azureVolumeResource", new()
{
    PoolName = "string",
    VolumePath = "string",
    SubnetId = "string",
    StorageQuotaInGb = 0,
    ServiceLevel = "string",
    ResourceGroupName = "string",
    AccountName = "string",
    ExportPolicyRules = new[]
    {
        new Azure.NetApp.Inputs.VolumeExportPolicyRuleArgs
        {
            AllowedClients = new[]
            {
                "string",
            },
            RuleIndex = 0,
            Kerberos5ReadOnlyEnabled = false,
            Kerberos5ReadWriteEnabled = false,
            Kerberos5iReadOnlyEnabled = false,
            Kerberos5iReadWriteEnabled = false,
            Kerberos5pReadOnlyEnabled = false,
            Kerberos5pReadWriteEnabled = false,
            ProtocolsEnabled = "string",
            RootAccessEnabled = false,
            UnixReadOnly = false,
            UnixReadWrite = false,
        },
    },
    DataProtectionSnapshotPolicy = new Azure.NetApp.Inputs.VolumeDataProtectionSnapshotPolicyArgs
    {
        SnapshotPolicyId = "string",
    },
    Location = "string",
    Name = "string",
    NetworkFeatures = "string",
    KerberosEnabled = false,
    Protocols = new[]
    {
        "string",
    },
    EncryptionKeySource = "string",
    SecurityStyle = "string",
    KeyVaultPrivateEndpointId = "string",
    SmbAccessBasedEnumerationEnabled = false,
    SmbContinuousAvailabilityEnabled = false,
    SmbNonBrowsableEnabled = false,
    SnapshotDirectoryVisible = false,
    DataProtectionReplication = new Azure.NetApp.Inputs.VolumeDataProtectionReplicationArgs
    {
        RemoteVolumeLocation = "string",
        RemoteVolumeResourceId = "string",
        ReplicationFrequency = "string",
        EndpointType = "string",
    },
    CreateFromSnapshotResourceId = "string",
    Tags = 
    {
        { "string", "string" },
    },
    ThroughputInMibps = 0,
    AzureVmwareDataStoreEnabled = false,
    Zone = "string",
});
example, err := netapp.NewVolume(ctx, "azureVolumeResource", &netapp.VolumeArgs{
	PoolName:          pulumi.String("string"),
	VolumePath:        pulumi.String("string"),
	SubnetId:          pulumi.String("string"),
	StorageQuotaInGb:  pulumi.Int(0),
	ServiceLevel:      pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	AccountName:       pulumi.String("string"),
	ExportPolicyRules: netapp.VolumeExportPolicyRuleArray{
		&netapp.VolumeExportPolicyRuleArgs{
			AllowedClients: pulumi.StringArray{
				pulumi.String("string"),
			},
			RuleIndex:                  pulumi.Int(0),
			Kerberos5ReadOnlyEnabled:   pulumi.Bool(false),
			Kerberos5ReadWriteEnabled:  pulumi.Bool(false),
			Kerberos5iReadOnlyEnabled:  pulumi.Bool(false),
			Kerberos5iReadWriteEnabled: pulumi.Bool(false),
			Kerberos5pReadOnlyEnabled:  pulumi.Bool(false),
			Kerberos5pReadWriteEnabled: pulumi.Bool(false),
			ProtocolsEnabled:           pulumi.String("string"),
			RootAccessEnabled:          pulumi.Bool(false),
			UnixReadOnly:               pulumi.Bool(false),
			UnixReadWrite:              pulumi.Bool(false),
		},
	},
	DataProtectionSnapshotPolicy: &netapp.VolumeDataProtectionSnapshotPolicyArgs{
		SnapshotPolicyId: pulumi.String("string"),
	},
	Location:        pulumi.String("string"),
	Name:            pulumi.String("string"),
	NetworkFeatures: pulumi.String("string"),
	KerberosEnabled: pulumi.Bool(false),
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	EncryptionKeySource:              pulumi.String("string"),
	SecurityStyle:                    pulumi.String("string"),
	KeyVaultPrivateEndpointId:        pulumi.String("string"),
	SmbAccessBasedEnumerationEnabled: pulumi.Bool(false),
	SmbContinuousAvailabilityEnabled: pulumi.Bool(false),
	SmbNonBrowsableEnabled:           pulumi.Bool(false),
	SnapshotDirectoryVisible:         pulumi.Bool(false),
	DataProtectionReplication: &netapp.VolumeDataProtectionReplicationArgs{
		RemoteVolumeLocation:   pulumi.String("string"),
		RemoteVolumeResourceId: pulumi.String("string"),
		ReplicationFrequency:   pulumi.String("string"),
		EndpointType:           pulumi.String("string"),
	},
	CreateFromSnapshotResourceId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ThroughputInMibps:           pulumi.Float64(0),
	AzureVmwareDataStoreEnabled: pulumi.Bool(false),
	Zone:                        pulumi.String("string"),
})
var azureVolumeResource = new Volume("azureVolumeResource", VolumeArgs.builder()
    .poolName("string")
    .volumePath("string")
    .subnetId("string")
    .storageQuotaInGb(0)
    .serviceLevel("string")
    .resourceGroupName("string")
    .accountName("string")
    .exportPolicyRules(VolumeExportPolicyRuleArgs.builder()
        .allowedClients("string")
        .ruleIndex(0)
        .kerberos5ReadOnlyEnabled(false)
        .kerberos5ReadWriteEnabled(false)
        .kerberos5iReadOnlyEnabled(false)
        .kerberos5iReadWriteEnabled(false)
        .kerberos5pReadOnlyEnabled(false)
        .kerberos5pReadWriteEnabled(false)
        .protocolsEnabled("string")
        .rootAccessEnabled(false)
        .unixReadOnly(false)
        .unixReadWrite(false)
        .build())
    .dataProtectionSnapshotPolicy(VolumeDataProtectionSnapshotPolicyArgs.builder()
        .snapshotPolicyId("string")
        .build())
    .location("string")
    .name("string")
    .networkFeatures("string")
    .kerberosEnabled(false)
    .protocols("string")
    .encryptionKeySource("string")
    .securityStyle("string")
    .keyVaultPrivateEndpointId("string")
    .smbAccessBasedEnumerationEnabled(false)
    .smbContinuousAvailabilityEnabled(false)
    .smbNonBrowsableEnabled(false)
    .snapshotDirectoryVisible(false)
    .dataProtectionReplication(VolumeDataProtectionReplicationArgs.builder()
        .remoteVolumeLocation("string")
        .remoteVolumeResourceId("string")
        .replicationFrequency("string")
        .endpointType("string")
        .build())
    .createFromSnapshotResourceId("string")
    .tags(Map.of("string", "string"))
    .throughputInMibps(0)
    .azureVmwareDataStoreEnabled(false)
    .zone("string")
    .build());
azure_volume_resource = azure.netapp.Volume("azureVolumeResource",
    pool_name="string",
    volume_path="string",
    subnet_id="string",
    storage_quota_in_gb=0,
    service_level="string",
    resource_group_name="string",
    account_name="string",
    export_policy_rules=[azure.netapp.VolumeExportPolicyRuleArgs(
        allowed_clients=["string"],
        rule_index=0,
        kerberos5_read_only_enabled=False,
        kerberos5_read_write_enabled=False,
        kerberos5i_read_only_enabled=False,
        kerberos5i_read_write_enabled=False,
        kerberos5p_read_only_enabled=False,
        kerberos5p_read_write_enabled=False,
        protocols_enabled="string",
        root_access_enabled=False,
        unix_read_only=False,
        unix_read_write=False,
    )],
    data_protection_snapshot_policy=azure.netapp.VolumeDataProtectionSnapshotPolicyArgs(
        snapshot_policy_id="string",
    ),
    location="string",
    name="string",
    network_features="string",
    kerberos_enabled=False,
    protocols=["string"],
    encryption_key_source="string",
    security_style="string",
    key_vault_private_endpoint_id="string",
    smb_access_based_enumeration_enabled=False,
    smb_continuous_availability_enabled=False,
    smb_non_browsable_enabled=False,
    snapshot_directory_visible=False,
    data_protection_replication=azure.netapp.VolumeDataProtectionReplicationArgs(
        remote_volume_location="string",
        remote_volume_resource_id="string",
        replication_frequency="string",
        endpoint_type="string",
    ),
    create_from_snapshot_resource_id="string",
    tags={
        "string": "string",
    },
    throughput_in_mibps=0,
    azure_vmware_data_store_enabled=False,
    zone="string")
const azureVolumeResource = new azure.netapp.Volume("azureVolumeResource", {
    poolName: "string",
    volumePath: "string",
    subnetId: "string",
    storageQuotaInGb: 0,
    serviceLevel: "string",
    resourceGroupName: "string",
    accountName: "string",
    exportPolicyRules: [{
        allowedClients: ["string"],
        ruleIndex: 0,
        kerberos5ReadOnlyEnabled: false,
        kerberos5ReadWriteEnabled: false,
        kerberos5iReadOnlyEnabled: false,
        kerberos5iReadWriteEnabled: false,
        kerberos5pReadOnlyEnabled: false,
        kerberos5pReadWriteEnabled: false,
        protocolsEnabled: "string",
        rootAccessEnabled: false,
        unixReadOnly: false,
        unixReadWrite: false,
    }],
    dataProtectionSnapshotPolicy: {
        snapshotPolicyId: "string",
    },
    location: "string",
    name: "string",
    networkFeatures: "string",
    kerberosEnabled: false,
    protocols: ["string"],
    encryptionKeySource: "string",
    securityStyle: "string",
    keyVaultPrivateEndpointId: "string",
    smbAccessBasedEnumerationEnabled: false,
    smbContinuousAvailabilityEnabled: false,
    smbNonBrowsableEnabled: false,
    snapshotDirectoryVisible: false,
    dataProtectionReplication: {
        remoteVolumeLocation: "string",
        remoteVolumeResourceId: "string",
        replicationFrequency: "string",
        endpointType: "string",
    },
    createFromSnapshotResourceId: "string",
    tags: {
        string: "string",
    },
    throughputInMibps: 0,
    azureVmwareDataStoreEnabled: false,
    zone: "string",
});
type: azure:netapp:Volume
properties:
    accountName: string
    azureVmwareDataStoreEnabled: false
    createFromSnapshotResourceId: string
    dataProtectionReplication:
        endpointType: string
        remoteVolumeLocation: string
        remoteVolumeResourceId: string
        replicationFrequency: string
    dataProtectionSnapshotPolicy:
        snapshotPolicyId: string
    encryptionKeySource: string
    exportPolicyRules:
        - allowedClients:
            - string
          kerberos5ReadOnlyEnabled: false
          kerberos5ReadWriteEnabled: false
          kerberos5iReadOnlyEnabled: false
          kerberos5iReadWriteEnabled: false
          kerberos5pReadOnlyEnabled: false
          kerberos5pReadWriteEnabled: false
          protocolsEnabled: string
          rootAccessEnabled: false
          ruleIndex: 0
          unixReadOnly: false
          unixReadWrite: false
    kerberosEnabled: false
    keyVaultPrivateEndpointId: string
    location: string
    name: string
    networkFeatures: string
    poolName: string
    protocols:
        - string
    resourceGroupName: string
    securityStyle: string
    serviceLevel: string
    smbAccessBasedEnumerationEnabled: false
    smbContinuousAvailabilityEnabled: false
    smbNonBrowsableEnabled: false
    snapshotDirectoryVisible: false
    storageQuotaInGb: 0
    subnetId: string
    tags:
        string: string
    throughputInMibps: 0
    volumePath: string
    zone: string
Volume Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Volume resource accepts the following input properties:
- AccountName string
- The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
- PoolName string
- The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
- ResourceGroup stringName 
- The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
- ServiceLevel string
- The target performance of the file system. Valid values include Premium,Standard, orUltra. Changing this forces a new resource to be created.
- StorageQuota intIn Gb 
- The maximum Storage Quota allowed for a file system in Gigabytes.
- SubnetId string
- The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumesdelegation. Changing this forces a new resource to be created.
- VolumePath string
- A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
- AzureVmware boolData Store Enabled 
- Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
- CreateFrom stringSnapshot Resource Id 
- 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_nameandpool_name. Changing this forces a new resource to be created.
- DataProtection VolumeReplication Data Protection Replication 
- A data_protection_replicationblock as defined below. Changing this forces a new resource to be created.
- DataProtection VolumeSnapshot Policy Data Protection Snapshot Policy 
- A data_protection_snapshot_policyblock as defined below.
- EncryptionKey stringSource 
- The encryption key source, it can be Microsoft.NetAppfor platform managed keys orMicrosoft.KeyVaultfor customer-managed keys. This is required withkey_vault_private_endpoint_id. Changing this forces a new resource to be created.
- ExportPolicy List<VolumeRules Export Policy Rule> 
- One or more export_policy_ruleblock defined below.
- KerberosEnabled bool
- Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Accounthaving a defined AD connection.
- KeyVault stringPrivate Endpoint Id 
- 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.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
- The name of the NetApp Volume. Changing this forces a new resource to be created.
- NetworkFeatures string
- Indicates which network feature to use, accepted values are BasicorStandard, it defaults toBasicif 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.
- Protocols List<string>
- The target volume protocol expressed as a list. Supported single value include CIFS,NFSv3, orNFSv4.1. If argument is not defined it will default toNFSv3. 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.
- SecurityStyle string
- Volume security style, accepted values are unixorntfs. If not provided, single-protocol volume is created defaulting tounixif it isNFSv3orNFSv4.1volume, ifCIFS, it will default tontfs. In a dual-protocol volume, if not provided, its value will bentfs. Changing this forces a new resource to be created.
- SmbAccess boolBased Enumeration Enabled 
- 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
- SmbContinuous boolAvailability Enabled 
- Enable SMB Continuous Availability.
- SmbNon boolBrowsable Enabled 
- 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
- SnapshotDirectory boolVisible 
- Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
- Dictionary<string, string>
- A mapping of tags to assign to the resource. - Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the - protocolsargument changes to a different protocol type.
- ThroughputIn doubleMibps 
- Throughput of this volume in Mibps.
- Zone string
- Specifies the Availability Zone in which the Volume should be located. Possible values are 1,2and3. 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.
- AccountName string
- The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
- PoolName string
- The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
- ResourceGroup stringName 
- The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
- ServiceLevel string
- The target performance of the file system. Valid values include Premium,Standard, orUltra. Changing this forces a new resource to be created.
- StorageQuota intIn Gb 
- The maximum Storage Quota allowed for a file system in Gigabytes.
- SubnetId string
- The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumesdelegation. Changing this forces a new resource to be created.
- VolumePath string
- A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
- AzureVmware boolData Store Enabled 
- Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
- CreateFrom stringSnapshot Resource Id 
- 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_nameandpool_name. Changing this forces a new resource to be created.
- DataProtection VolumeReplication Data Protection Replication Args 
- A data_protection_replicationblock as defined below. Changing this forces a new resource to be created.
- DataProtection VolumeSnapshot Policy Data Protection Snapshot Policy Args 
- A data_protection_snapshot_policyblock as defined below.
- EncryptionKey stringSource 
- The encryption key source, it can be Microsoft.NetAppfor platform managed keys orMicrosoft.KeyVaultfor customer-managed keys. This is required withkey_vault_private_endpoint_id. Changing this forces a new resource to be created.
- ExportPolicy []VolumeRules Export Policy Rule Args 
- One or more export_policy_ruleblock defined below.
- KerberosEnabled bool
- Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Accounthaving a defined AD connection.
- KeyVault stringPrivate Endpoint Id 
- 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.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
- The name of the NetApp Volume. Changing this forces a new resource to be created.
- NetworkFeatures string
- Indicates which network feature to use, accepted values are BasicorStandard, it defaults toBasicif 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.
- Protocols []string
- The target volume protocol expressed as a list. Supported single value include CIFS,NFSv3, orNFSv4.1. If argument is not defined it will default toNFSv3. 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.
- SecurityStyle string
- Volume security style, accepted values are unixorntfs. If not provided, single-protocol volume is created defaulting tounixif it isNFSv3orNFSv4.1volume, ifCIFS, it will default tontfs. In a dual-protocol volume, if not provided, its value will bentfs. Changing this forces a new resource to be created.
- SmbAccess boolBased Enumeration Enabled 
- 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
- SmbContinuous boolAvailability Enabled 
- Enable SMB Continuous Availability.
- SmbNon boolBrowsable Enabled 
- 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
- SnapshotDirectory boolVisible 
- Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
- map[string]string
- A mapping of tags to assign to the resource. - Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the - protocolsargument changes to a different protocol type.
- ThroughputIn float64Mibps 
- Throughput of this volume in Mibps.
- Zone string
- Specifies the Availability Zone in which the Volume should be located. Possible values are 1,2and3. 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.
- accountName String
- The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
- poolName String
- The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
- resourceGroup StringName 
- The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
- serviceLevel String
- The target performance of the file system. Valid values include Premium,Standard, orUltra. Changing this forces a new resource to be created.
- storageQuota IntegerIn Gb 
- The maximum Storage Quota allowed for a file system in Gigabytes.
- subnetId String
- The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumesdelegation. Changing this forces a new resource to be created.
- volumePath String
- A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
- azureVmware BooleanData Store Enabled 
- Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
- createFrom StringSnapshot Resource Id 
- 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_nameandpool_name. Changing this forces a new resource to be created.
- dataProtection VolumeReplication Data Protection Replication 
- A data_protection_replicationblock as defined below. Changing this forces a new resource to be created.
- dataProtection VolumeSnapshot Policy Data Protection Snapshot Policy 
- A data_protection_snapshot_policyblock as defined below.
- encryptionKey StringSource 
- The encryption key source, it can be Microsoft.NetAppfor platform managed keys orMicrosoft.KeyVaultfor customer-managed keys. This is required withkey_vault_private_endpoint_id. Changing this forces a new resource to be created.
- exportPolicy List<VolumeRules Export Policy Rule> 
- One or more export_policy_ruleblock defined below.
- kerberosEnabled Boolean
- Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Accounthaving a defined AD connection.
- keyVault StringPrivate Endpoint Id 
- 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.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
- The name of the NetApp Volume. Changing this forces a new resource to be created.
- networkFeatures String
- Indicates which network feature to use, accepted values are BasicorStandard, it defaults toBasicif 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.
- protocols List<String>
- The target volume protocol expressed as a list. Supported single value include CIFS,NFSv3, orNFSv4.1. If argument is not defined it will default toNFSv3. 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.
- securityStyle String
- Volume security style, accepted values are unixorntfs. If not provided, single-protocol volume is created defaulting tounixif it isNFSv3orNFSv4.1volume, ifCIFS, it will default tontfs. In a dual-protocol volume, if not provided, its value will bentfs. Changing this forces a new resource to be created.
- smbAccess BooleanBased Enumeration Enabled 
- 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
- smbContinuous BooleanAvailability Enabled 
- Enable SMB Continuous Availability.
- smbNon BooleanBrowsable Enabled 
- 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
- snapshotDirectory BooleanVisible 
- Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
- Map<String,String>
- A mapping of tags to assign to the resource. - Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the - protocolsargument changes to a different protocol type.
- throughputIn DoubleMibps 
- Throughput of this volume in Mibps.
- zone String
- Specifies the Availability Zone in which the Volume should be located. Possible values are 1,2and3. 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.
- accountName string
- The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
- poolName string
- The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
- resourceGroup stringName 
- The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
- serviceLevel string
- The target performance of the file system. Valid values include Premium,Standard, orUltra. Changing this forces a new resource to be created.
- storageQuota numberIn Gb 
- The maximum Storage Quota allowed for a file system in Gigabytes.
- subnetId string
- The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumesdelegation. Changing this forces a new resource to be created.
- volumePath string
- A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
- azureVmware booleanData Store Enabled 
- Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
- createFrom stringSnapshot Resource Id 
- 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_nameandpool_name. Changing this forces a new resource to be created.
- dataProtection VolumeReplication Data Protection Replication 
- A data_protection_replicationblock as defined below. Changing this forces a new resource to be created.
- dataProtection VolumeSnapshot Policy Data Protection Snapshot Policy 
- A data_protection_snapshot_policyblock as defined below.
- encryptionKey stringSource 
- The encryption key source, it can be Microsoft.NetAppfor platform managed keys orMicrosoft.KeyVaultfor customer-managed keys. This is required withkey_vault_private_endpoint_id. Changing this forces a new resource to be created.
- exportPolicy VolumeRules Export Policy Rule[] 
- One or more export_policy_ruleblock defined below.
- kerberosEnabled boolean
- Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Accounthaving a defined AD connection.
- keyVault stringPrivate Endpoint Id 
- 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.
- location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name string
- The name of the NetApp Volume. Changing this forces a new resource to be created.
- networkFeatures string
- Indicates which network feature to use, accepted values are BasicorStandard, it defaults toBasicif 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.
- protocols string[]
- The target volume protocol expressed as a list. Supported single value include CIFS,NFSv3, orNFSv4.1. If argument is not defined it will default toNFSv3. 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.
- securityStyle string
- Volume security style, accepted values are unixorntfs. If not provided, single-protocol volume is created defaulting tounixif it isNFSv3orNFSv4.1volume, ifCIFS, it will default tontfs. In a dual-protocol volume, if not provided, its value will bentfs. Changing this forces a new resource to be created.
- smbAccess booleanBased Enumeration Enabled 
- 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
- smbContinuous booleanAvailability Enabled 
- Enable SMB Continuous Availability.
- smbNon booleanBrowsable Enabled 
- 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
- snapshotDirectory booleanVisible 
- Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
- {[key: string]: string}
- A mapping of tags to assign to the resource. - Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the - protocolsargument changes to a different protocol type.
- throughputIn numberMibps 
- Throughput of this volume in Mibps.
- zone string
- Specifies the Availability Zone in which the Volume should be located. Possible values are 1,2and3. 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.
- account_name str
- The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
- pool_name str
- The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
- resource_group_ strname 
- The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
- service_level str
- The target performance of the file system. Valid values include Premium,Standard, orUltra. Changing this forces a new resource to be created.
- storage_quota_ intin_ gb 
- The maximum Storage Quota allowed for a file system in Gigabytes.
- subnet_id str
- The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumesdelegation. Changing this forces a new resource to be created.
- volume_path str
- A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
- azure_vmware_ booldata_ store_ enabled 
- Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
- create_from_ strsnapshot_ resource_ id 
- 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_nameandpool_name. Changing this forces a new resource to be created.
- data_protection_ Volumereplication Data Protection Replication Args 
- A data_protection_replicationblock as defined below. Changing this forces a new resource to be created.
- data_protection_ Volumesnapshot_ policy Data Protection Snapshot Policy Args 
- A data_protection_snapshot_policyblock as defined below.
- encryption_key_ strsource 
- The encryption key source, it can be Microsoft.NetAppfor platform managed keys orMicrosoft.KeyVaultfor customer-managed keys. This is required withkey_vault_private_endpoint_id. Changing this forces a new resource to be created.
- export_policy_ Sequence[Volumerules Export Policy Rule Args] 
- One or more export_policy_ruleblock defined below.
- kerberos_enabled bool
- Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Accounthaving a defined AD connection.
- key_vault_ strprivate_ endpoint_ id 
- 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.
- location str
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name str
- The name of the NetApp Volume. Changing this forces a new resource to be created.
- network_features str
- Indicates which network feature to use, accepted values are BasicorStandard, it defaults toBasicif 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.
- protocols Sequence[str]
- The target volume protocol expressed as a list. Supported single value include CIFS,NFSv3, orNFSv4.1. If argument is not defined it will default toNFSv3. 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.
- security_style str
- Volume security style, accepted values are unixorntfs. If not provided, single-protocol volume is created defaulting tounixif it isNFSv3orNFSv4.1volume, ifCIFS, it will default tontfs. In a dual-protocol volume, if not provided, its value will bentfs. Changing this forces a new resource to be created.
- smb_access_ boolbased_ enumeration_ enabled 
- 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
- smb_continuous_ boolavailability_ enabled 
- Enable SMB Continuous Availability.
- smb_non_ boolbrowsable_ enabled 
- 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
- snapshot_directory_ boolvisible 
- Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
- Mapping[str, str]
- A mapping of tags to assign to the resource. - Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the - protocolsargument changes to a different protocol type.
- throughput_in_ floatmibps 
- Throughput of this volume in Mibps.
- zone str
- Specifies the Availability Zone in which the Volume should be located. Possible values are 1,2and3. 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.
- accountName String
- The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
- poolName String
- The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
- resourceGroup StringName 
- The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
- serviceLevel String
- The target performance of the file system. Valid values include Premium,Standard, orUltra. Changing this forces a new resource to be created.
- storageQuota NumberIn Gb 
- The maximum Storage Quota allowed for a file system in Gigabytes.
- subnetId String
- The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumesdelegation. Changing this forces a new resource to be created.
- volumePath String
- A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
- azureVmware BooleanData Store Enabled 
- Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
- createFrom StringSnapshot Resource Id 
- 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_nameandpool_name. Changing this forces a new resource to be created.
- dataProtection Property MapReplication 
- A data_protection_replicationblock as defined below. Changing this forces a new resource to be created.
- dataProtection Property MapSnapshot Policy 
- A data_protection_snapshot_policyblock as defined below.
- encryptionKey StringSource 
- The encryption key source, it can be Microsoft.NetAppfor platform managed keys orMicrosoft.KeyVaultfor customer-managed keys. This is required withkey_vault_private_endpoint_id. Changing this forces a new resource to be created.
- exportPolicy List<Property Map>Rules 
- One or more export_policy_ruleblock defined below.
- kerberosEnabled Boolean
- Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Accounthaving a defined AD connection.
- keyVault StringPrivate Endpoint Id 
- 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.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
- The name of the NetApp Volume. Changing this forces a new resource to be created.
- networkFeatures String
- Indicates which network feature to use, accepted values are BasicorStandard, it defaults toBasicif 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.
- protocols List<String>
- The target volume protocol expressed as a list. Supported single value include CIFS,NFSv3, orNFSv4.1. If argument is not defined it will default toNFSv3. 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.
- securityStyle String
- Volume security style, accepted values are unixorntfs. If not provided, single-protocol volume is created defaulting tounixif it isNFSv3orNFSv4.1volume, ifCIFS, it will default tontfs. In a dual-protocol volume, if not provided, its value will bentfs. Changing this forces a new resource to be created.
- smbAccess BooleanBased Enumeration Enabled 
- 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
- smbContinuous BooleanAvailability Enabled 
- Enable SMB Continuous Availability.
- smbNon BooleanBrowsable Enabled 
- 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
- snapshotDirectory BooleanVisible 
- Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
- Map<String>
- A mapping of tags to assign to the resource. - Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the - protocolsargument changes to a different protocol type.
- throughputIn NumberMibps 
- Throughput of this volume in Mibps.
- zone String
- Specifies the Availability Zone in which the Volume should be located. Possible values are 1,2and3. 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the Volume resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- MountIp List<string>Addresses 
- A list of IPv4 Addresses which should be used to mount the volume.
- Id string
- The provider-assigned unique ID for this managed resource.
- MountIp []stringAddresses 
- A list of IPv4 Addresses which should be used to mount the volume.
- id String
- The provider-assigned unique ID for this managed resource.
- mountIp List<String>Addresses 
- A list of IPv4 Addresses which should be used to mount the volume.
- id string
- The provider-assigned unique ID for this managed resource.
- mountIp string[]Addresses 
- A list of IPv4 Addresses which should be used to mount the volume.
- id str
- The provider-assigned unique ID for this managed resource.
- mount_ip_ Sequence[str]addresses 
- A list of IPv4 Addresses which should be used to mount the volume.
- id String
- The provider-assigned unique ID for this managed resource.
- mountIp List<String>Addresses 
- A list of IPv4 Addresses which should be used to mount the volume.
Look up Existing Volume Resource
Get an existing Volume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: VolumeState, opts?: CustomResourceOptions): Volume@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        azure_vmware_data_store_enabled: Optional[bool] = None,
        create_from_snapshot_resource_id: Optional[str] = None,
        data_protection_replication: Optional[VolumeDataProtectionReplicationArgs] = None,
        data_protection_snapshot_policy: Optional[VolumeDataProtectionSnapshotPolicyArgs] = None,
        encryption_key_source: Optional[str] = None,
        export_policy_rules: Optional[Sequence[VolumeExportPolicyRuleArgs]] = None,
        kerberos_enabled: Optional[bool] = None,
        key_vault_private_endpoint_id: Optional[str] = None,
        location: Optional[str] = None,
        mount_ip_addresses: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        network_features: Optional[str] = None,
        pool_name: Optional[str] = None,
        protocols: Optional[Sequence[str]] = None,
        resource_group_name: Optional[str] = None,
        security_style: Optional[str] = None,
        service_level: Optional[str] = None,
        smb_access_based_enumeration_enabled: Optional[bool] = None,
        smb_continuous_availability_enabled: Optional[bool] = None,
        smb_non_browsable_enabled: Optional[bool] = None,
        snapshot_directory_visible: Optional[bool] = None,
        storage_quota_in_gb: Optional[int] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        throughput_in_mibps: Optional[float] = None,
        volume_path: Optional[str] = None,
        zone: Optional[str] = None) -> Volumefunc GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)public static Volume Get(string name, Input<string> id, VolumeState? state, CustomResourceOptions? opts = null)public static Volume get(String name, Output<String> id, VolumeState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- AccountName string
- The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
- AzureVmware boolData Store Enabled 
- Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
- CreateFrom stringSnapshot Resource Id 
- 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_nameandpool_name. Changing this forces a new resource to be created.
- DataProtection VolumeReplication Data Protection Replication 
- A data_protection_replicationblock as defined below. Changing this forces a new resource to be created.
- DataProtection VolumeSnapshot Policy Data Protection Snapshot Policy 
- A data_protection_snapshot_policyblock as defined below.
- EncryptionKey stringSource 
- The encryption key source, it can be Microsoft.NetAppfor platform managed keys orMicrosoft.KeyVaultfor customer-managed keys. This is required withkey_vault_private_endpoint_id. Changing this forces a new resource to be created.
- ExportPolicy List<VolumeRules Export Policy Rule> 
- One or more export_policy_ruleblock defined below.
- KerberosEnabled bool
- Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Accounthaving a defined AD connection.
- KeyVault stringPrivate Endpoint Id 
- 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.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- MountIp List<string>Addresses 
- A list of IPv4 Addresses which should be used to mount the volume.
- Name string
- The name of the NetApp Volume. Changing this forces a new resource to be created.
- NetworkFeatures string
- Indicates which network feature to use, accepted values are BasicorStandard, it defaults toBasicif 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.
- PoolName string
- The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
- Protocols List<string>
- The target volume protocol expressed as a list. Supported single value include CIFS,NFSv3, orNFSv4.1. If argument is not defined it will default toNFSv3. 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.
- ResourceGroup stringName 
- The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
- SecurityStyle string
- Volume security style, accepted values are unixorntfs. If not provided, single-protocol volume is created defaulting tounixif it isNFSv3orNFSv4.1volume, ifCIFS, it will default tontfs. In a dual-protocol volume, if not provided, its value will bentfs. Changing this forces a new resource to be created.
- ServiceLevel string
- The target performance of the file system. Valid values include Premium,Standard, orUltra. Changing this forces a new resource to be created.
- SmbAccess boolBased Enumeration Enabled 
- 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
- SmbContinuous boolAvailability Enabled 
- Enable SMB Continuous Availability.
- SmbNon boolBrowsable Enabled 
- 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
- SnapshotDirectory boolVisible 
- Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
- StorageQuota intIn Gb 
- The maximum Storage Quota allowed for a file system in Gigabytes.
- SubnetId string
- The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumesdelegation. Changing this forces a new resource to be created.
- Dictionary<string, string>
- A mapping of tags to assign to the resource. - Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the - protocolsargument changes to a different protocol type.
- ThroughputIn doubleMibps 
- Throughput of this volume in Mibps.
- VolumePath string
- A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
- Zone string
- Specifies the Availability Zone in which the Volume should be located. Possible values are 1,2and3. 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.
- AccountName string
- The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
- AzureVmware boolData Store Enabled 
- Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
- CreateFrom stringSnapshot Resource Id 
- 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_nameandpool_name. Changing this forces a new resource to be created.
- DataProtection VolumeReplication Data Protection Replication Args 
- A data_protection_replicationblock as defined below. Changing this forces a new resource to be created.
- DataProtection VolumeSnapshot Policy Data Protection Snapshot Policy Args 
- A data_protection_snapshot_policyblock as defined below.
- EncryptionKey stringSource 
- The encryption key source, it can be Microsoft.NetAppfor platform managed keys orMicrosoft.KeyVaultfor customer-managed keys. This is required withkey_vault_private_endpoint_id. Changing this forces a new resource to be created.
- ExportPolicy []VolumeRules Export Policy Rule Args 
- One or more export_policy_ruleblock defined below.
- KerberosEnabled bool
- Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Accounthaving a defined AD connection.
- KeyVault stringPrivate Endpoint Id 
- 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.
- Location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- MountIp []stringAddresses 
- A list of IPv4 Addresses which should be used to mount the volume.
- Name string
- The name of the NetApp Volume. Changing this forces a new resource to be created.
- NetworkFeatures string
- Indicates which network feature to use, accepted values are BasicorStandard, it defaults toBasicif 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.
- PoolName string
- The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
- Protocols []string
- The target volume protocol expressed as a list. Supported single value include CIFS,NFSv3, orNFSv4.1. If argument is not defined it will default toNFSv3. 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.
- ResourceGroup stringName 
- The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
- SecurityStyle string
- Volume security style, accepted values are unixorntfs. If not provided, single-protocol volume is created defaulting tounixif it isNFSv3orNFSv4.1volume, ifCIFS, it will default tontfs. In a dual-protocol volume, if not provided, its value will bentfs. Changing this forces a new resource to be created.
- ServiceLevel string
- The target performance of the file system. Valid values include Premium,Standard, orUltra. Changing this forces a new resource to be created.
- SmbAccess boolBased Enumeration Enabled 
- 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
- SmbContinuous boolAvailability Enabled 
- Enable SMB Continuous Availability.
- SmbNon boolBrowsable Enabled 
- 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
- SnapshotDirectory boolVisible 
- Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
- StorageQuota intIn Gb 
- The maximum Storage Quota allowed for a file system in Gigabytes.
- SubnetId string
- The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumesdelegation. Changing this forces a new resource to be created.
- map[string]string
- A mapping of tags to assign to the resource. - Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the - protocolsargument changes to a different protocol type.
- ThroughputIn float64Mibps 
- Throughput of this volume in Mibps.
- VolumePath string
- A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
- Zone string
- Specifies the Availability Zone in which the Volume should be located. Possible values are 1,2and3. 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.
- accountName String
- The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
- azureVmware BooleanData Store Enabled 
- Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
- createFrom StringSnapshot Resource Id 
- 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_nameandpool_name. Changing this forces a new resource to be created.
- dataProtection VolumeReplication Data Protection Replication 
- A data_protection_replicationblock as defined below. Changing this forces a new resource to be created.
- dataProtection VolumeSnapshot Policy Data Protection Snapshot Policy 
- A data_protection_snapshot_policyblock as defined below.
- encryptionKey StringSource 
- The encryption key source, it can be Microsoft.NetAppfor platform managed keys orMicrosoft.KeyVaultfor customer-managed keys. This is required withkey_vault_private_endpoint_id. Changing this forces a new resource to be created.
- exportPolicy List<VolumeRules Export Policy Rule> 
- One or more export_policy_ruleblock defined below.
- kerberosEnabled Boolean
- Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Accounthaving a defined AD connection.
- keyVault StringPrivate Endpoint Id 
- 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.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- mountIp List<String>Addresses 
- A list of IPv4 Addresses which should be used to mount the volume.
- name String
- The name of the NetApp Volume. Changing this forces a new resource to be created.
- networkFeatures String
- Indicates which network feature to use, accepted values are BasicorStandard, it defaults toBasicif 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.
- poolName String
- The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
- protocols List<String>
- The target volume protocol expressed as a list. Supported single value include CIFS,NFSv3, orNFSv4.1. If argument is not defined it will default toNFSv3. 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.
- resourceGroup StringName 
- The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
- securityStyle String
- Volume security style, accepted values are unixorntfs. If not provided, single-protocol volume is created defaulting tounixif it isNFSv3orNFSv4.1volume, ifCIFS, it will default tontfs. In a dual-protocol volume, if not provided, its value will bentfs. Changing this forces a new resource to be created.
- serviceLevel String
- The target performance of the file system. Valid values include Premium,Standard, orUltra. Changing this forces a new resource to be created.
- smbAccess BooleanBased Enumeration Enabled 
- 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
- smbContinuous BooleanAvailability Enabled 
- Enable SMB Continuous Availability.
- smbNon BooleanBrowsable Enabled 
- 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
- snapshotDirectory BooleanVisible 
- Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
- storageQuota IntegerIn Gb 
- The maximum Storage Quota allowed for a file system in Gigabytes.
- subnetId String
- The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumesdelegation. Changing this forces a new resource to be created.
- Map<String,String>
- A mapping of tags to assign to the resource. - Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the - protocolsargument changes to a different protocol type.
- throughputIn DoubleMibps 
- Throughput of this volume in Mibps.
- volumePath String
- A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
- zone String
- Specifies the Availability Zone in which the Volume should be located. Possible values are 1,2and3. 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.
- accountName string
- The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
- azureVmware booleanData Store Enabled 
- Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
- createFrom stringSnapshot Resource Id 
- 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_nameandpool_name. Changing this forces a new resource to be created.
- dataProtection VolumeReplication Data Protection Replication 
- A data_protection_replicationblock as defined below. Changing this forces a new resource to be created.
- dataProtection VolumeSnapshot Policy Data Protection Snapshot Policy 
- A data_protection_snapshot_policyblock as defined below.
- encryptionKey stringSource 
- The encryption key source, it can be Microsoft.NetAppfor platform managed keys orMicrosoft.KeyVaultfor customer-managed keys. This is required withkey_vault_private_endpoint_id. Changing this forces a new resource to be created.
- exportPolicy VolumeRules Export Policy Rule[] 
- One or more export_policy_ruleblock defined below.
- kerberosEnabled boolean
- Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Accounthaving a defined AD connection.
- keyVault stringPrivate Endpoint Id 
- 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.
- location string
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- mountIp string[]Addresses 
- A list of IPv4 Addresses which should be used to mount the volume.
- name string
- The name of the NetApp Volume. Changing this forces a new resource to be created.
- networkFeatures string
- Indicates which network feature to use, accepted values are BasicorStandard, it defaults toBasicif 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.
- poolName string
- The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
- protocols string[]
- The target volume protocol expressed as a list. Supported single value include CIFS,NFSv3, orNFSv4.1. If argument is not defined it will default toNFSv3. 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.
- resourceGroup stringName 
- The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
- securityStyle string
- Volume security style, accepted values are unixorntfs. If not provided, single-protocol volume is created defaulting tounixif it isNFSv3orNFSv4.1volume, ifCIFS, it will default tontfs. In a dual-protocol volume, if not provided, its value will bentfs. Changing this forces a new resource to be created.
- serviceLevel string
- The target performance of the file system. Valid values include Premium,Standard, orUltra. Changing this forces a new resource to be created.
- smbAccess booleanBased Enumeration Enabled 
- 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
- smbContinuous booleanAvailability Enabled 
- Enable SMB Continuous Availability.
- smbNon booleanBrowsable Enabled 
- 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
- snapshotDirectory booleanVisible 
- Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
- storageQuota numberIn Gb 
- The maximum Storage Quota allowed for a file system in Gigabytes.
- subnetId string
- The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumesdelegation. Changing this forces a new resource to be created.
- {[key: string]: string}
- A mapping of tags to assign to the resource. - Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the - protocolsargument changes to a different protocol type.
- throughputIn numberMibps 
- Throughput of this volume in Mibps.
- volumePath string
- A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
- zone string
- Specifies the Availability Zone in which the Volume should be located. Possible values are 1,2and3. 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.
- account_name str
- The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
- azure_vmware_ booldata_ store_ enabled 
- Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
- create_from_ strsnapshot_ resource_ id 
- 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_nameandpool_name. Changing this forces a new resource to be created.
- data_protection_ Volumereplication Data Protection Replication Args 
- A data_protection_replicationblock as defined below. Changing this forces a new resource to be created.
- data_protection_ Volumesnapshot_ policy Data Protection Snapshot Policy Args 
- A data_protection_snapshot_policyblock as defined below.
- encryption_key_ strsource 
- The encryption key source, it can be Microsoft.NetAppfor platform managed keys orMicrosoft.KeyVaultfor customer-managed keys. This is required withkey_vault_private_endpoint_id. Changing this forces a new resource to be created.
- export_policy_ Sequence[Volumerules Export Policy Rule Args] 
- One or more export_policy_ruleblock defined below.
- kerberos_enabled bool
- Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Accounthaving a defined AD connection.
- key_vault_ strprivate_ endpoint_ id 
- 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.
- location str
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- mount_ip_ Sequence[str]addresses 
- A list of IPv4 Addresses which should be used to mount the volume.
- name str
- The name of the NetApp Volume. Changing this forces a new resource to be created.
- network_features str
- Indicates which network feature to use, accepted values are BasicorStandard, it defaults toBasicif 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.
- pool_name str
- The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
- protocols Sequence[str]
- The target volume protocol expressed as a list. Supported single value include CIFS,NFSv3, orNFSv4.1. If argument is not defined it will default toNFSv3. 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.
- resource_group_ strname 
- The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
- security_style str
- Volume security style, accepted values are unixorntfs. If not provided, single-protocol volume is created defaulting tounixif it isNFSv3orNFSv4.1volume, ifCIFS, it will default tontfs. In a dual-protocol volume, if not provided, its value will bentfs. Changing this forces a new resource to be created.
- service_level str
- The target performance of the file system. Valid values include Premium,Standard, orUltra. Changing this forces a new resource to be created.
- smb_access_ boolbased_ enumeration_ enabled 
- 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
- smb_continuous_ boolavailability_ enabled 
- Enable SMB Continuous Availability.
- smb_non_ boolbrowsable_ enabled 
- 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
- snapshot_directory_ boolvisible 
- Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
- storage_quota_ intin_ gb 
- The maximum Storage Quota allowed for a file system in Gigabytes.
- subnet_id str
- The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumesdelegation. Changing this forces a new resource to be created.
- Mapping[str, str]
- A mapping of tags to assign to the resource. - Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the - protocolsargument changes to a different protocol type.
- throughput_in_ floatmibps 
- Throughput of this volume in Mibps.
- volume_path str
- A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
- zone str
- Specifies the Availability Zone in which the Volume should be located. Possible values are 1,2and3. 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.
- accountName String
- The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
- azureVmware BooleanData Store Enabled 
- Is the NetApp Volume enabled for Azure VMware Solution (AVS) datastore purpose. Defaults to false. Changing this forces a new resource to be created.
- createFrom StringSnapshot Resource Id 
- 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_nameandpool_name. Changing this forces a new resource to be created.
- dataProtection Property MapReplication 
- A data_protection_replicationblock as defined below. Changing this forces a new resource to be created.
- dataProtection Property MapSnapshot Policy 
- A data_protection_snapshot_policyblock as defined below.
- encryptionKey StringSource 
- The encryption key source, it can be Microsoft.NetAppfor platform managed keys orMicrosoft.KeyVaultfor customer-managed keys. This is required withkey_vault_private_endpoint_id. Changing this forces a new resource to be created.
- exportPolicy List<Property Map>Rules 
- One or more export_policy_ruleblock defined below.
- kerberosEnabled Boolean
- Enable to allow Kerberos secured volumes. Requires appropriate export rules as well as the parent azure.netapp.Accounthaving a defined AD connection.
- keyVault StringPrivate Endpoint Id 
- 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.
- location String
- Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
- mountIp List<String>Addresses 
- A list of IPv4 Addresses which should be used to mount the volume.
- name String
- The name of the NetApp Volume. Changing this forces a new resource to be created.
- networkFeatures String
- Indicates which network feature to use, accepted values are BasicorStandard, it defaults toBasicif 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.
- poolName String
- The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
- protocols List<String>
- The target volume protocol expressed as a list. Supported single value include CIFS,NFSv3, orNFSv4.1. If argument is not defined it will default toNFSv3. 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.
- resourceGroup StringName 
- The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
- securityStyle String
- Volume security style, accepted values are unixorntfs. If not provided, single-protocol volume is created defaulting tounixif it isNFSv3orNFSv4.1volume, ifCIFS, it will default tontfs. In a dual-protocol volume, if not provided, its value will bentfs. Changing this forces a new resource to be created.
- serviceLevel String
- The target performance of the file system. Valid values include Premium,Standard, orUltra. Changing this forces a new resource to be created.
- smbAccess BooleanBased Enumeration Enabled 
- 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
- smbContinuous BooleanAvailability Enabled 
- Enable SMB Continuous Availability.
- smbNon BooleanBrowsable Enabled 
- 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
- snapshotDirectory BooleanVisible 
- Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
- storageQuota NumberIn Gb 
- The maximum Storage Quota allowed for a file system in Gigabytes.
- subnetId String
- The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumesdelegation. Changing this forces a new resource to be created.
- Map<String>
- A mapping of tags to assign to the resource. - Note: It is highly recommended to use the lifecycle property as noted in the example since it will prevent an accidental deletion of the volume if the - protocolsargument changes to a different protocol type.
- throughputIn NumberMibps 
- Throughput of this volume in Mibps.
- volumePath String
- A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
- zone String
- Specifies the Availability Zone in which the Volume should be located. Possible values are 1,2and3. 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.
Supporting Types
VolumeDataProtectionReplication, VolumeDataProtectionReplicationArgs        
- RemoteVolume stringLocation 
- Location of the primary volume. Changing this forces a new resource to be created.
- RemoteVolume stringResource Id 
- Resource ID of the primary volume.
- ReplicationFrequency string
- Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive. - A full example of the - data_protection_replicationattribute can be found in the- ./examples/netapp/volume_crrdirectory within the GitHub Repository- NOTE: - data_protection_replicationcan be defined only once per secondary volume, adding a second instance of it is not supported.
- EndpointType string
- The endpoint type, default value is dstfor destination.
- RemoteVolume stringLocation 
- Location of the primary volume. Changing this forces a new resource to be created.
- RemoteVolume stringResource Id 
- Resource ID of the primary volume.
- ReplicationFrequency string
- Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive. - A full example of the - data_protection_replicationattribute can be found in the- ./examples/netapp/volume_crrdirectory within the GitHub Repository- NOTE: - data_protection_replicationcan be defined only once per secondary volume, adding a second instance of it is not supported.
- EndpointType string
- The endpoint type, default value is dstfor destination.
- remoteVolume StringLocation 
- Location of the primary volume. Changing this forces a new resource to be created.
- remoteVolume StringResource Id 
- Resource ID of the primary volume.
- replicationFrequency String
- Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive. - A full example of the - data_protection_replicationattribute can be found in the- ./examples/netapp/volume_crrdirectory within the GitHub Repository- NOTE: - data_protection_replicationcan be defined only once per secondary volume, adding a second instance of it is not supported.
- endpointType String
- The endpoint type, default value is dstfor destination.
- remoteVolume stringLocation 
- Location of the primary volume. Changing this forces a new resource to be created.
- remoteVolume stringResource Id 
- Resource ID of the primary volume.
- replicationFrequency string
- Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive. - A full example of the - data_protection_replicationattribute can be found in the- ./examples/netapp/volume_crrdirectory within the GitHub Repository- NOTE: - data_protection_replicationcan be defined only once per secondary volume, adding a second instance of it is not supported.
- endpointType string
- The endpoint type, default value is dstfor destination.
- remote_volume_ strlocation 
- Location of the primary volume. Changing this forces a new resource to be created.
- remote_volume_ strresource_ id 
- Resource ID of the primary volume.
- replication_frequency str
- Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive. - A full example of the - data_protection_replicationattribute can be found in the- ./examples/netapp/volume_crrdirectory within the GitHub Repository- NOTE: - data_protection_replicationcan be defined only once per secondary volume, adding a second instance of it is not supported.
- endpoint_type str
- The endpoint type, default value is dstfor destination.
- remoteVolume StringLocation 
- Location of the primary volume. Changing this forces a new resource to be created.
- remoteVolume StringResource Id 
- Resource ID of the primary volume.
- replicationFrequency String
- Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive. - A full example of the - data_protection_replicationattribute can be found in the- ./examples/netapp/volume_crrdirectory within the GitHub Repository- NOTE: - data_protection_replicationcan be defined only once per secondary volume, adding a second instance of it is not supported.
- endpointType String
- The endpoint type, default value is dstfor destination.
VolumeDataProtectionSnapshotPolicy, VolumeDataProtectionSnapshotPolicyArgs          
- SnapshotPolicy stringId 
- Resource ID of the snapshot policy to apply to the volume. - A full example of the - data_protection_snapshot_policyattribute usage can be found in the- ./examples/netapp/nfsv3_volume_with_snapshot_policydirectory within the GitHub Repository- NOTE: - data_protection_snapshot_policyblock can be used alone or with data_protection_replication in the primary volume only, if enabling it in the secondary, an error will be thrown.
- SnapshotPolicy stringId 
- Resource ID of the snapshot policy to apply to the volume. - A full example of the - data_protection_snapshot_policyattribute usage can be found in the- ./examples/netapp/nfsv3_volume_with_snapshot_policydirectory within the GitHub Repository- NOTE: - data_protection_snapshot_policyblock can be used alone or with data_protection_replication in the primary volume only, if enabling it in the secondary, an error will be thrown.
- snapshotPolicy StringId 
- Resource ID of the snapshot policy to apply to the volume. - A full example of the - data_protection_snapshot_policyattribute usage can be found in the- ./examples/netapp/nfsv3_volume_with_snapshot_policydirectory within the GitHub Repository- NOTE: - data_protection_snapshot_policyblock can be used alone or with data_protection_replication in the primary volume only, if enabling it in the secondary, an error will be thrown.
- snapshotPolicy stringId 
- Resource ID of the snapshot policy to apply to the volume. - A full example of the - data_protection_snapshot_policyattribute usage can be found in the- ./examples/netapp/nfsv3_volume_with_snapshot_policydirectory within the GitHub Repository- NOTE: - data_protection_snapshot_policyblock can be used alone or with data_protection_replication in the primary volume only, if enabling it in the secondary, an error will be thrown.
- snapshot_policy_ strid 
- Resource ID of the snapshot policy to apply to the volume. - A full example of the - data_protection_snapshot_policyattribute usage can be found in the- ./examples/netapp/nfsv3_volume_with_snapshot_policydirectory within the GitHub Repository- NOTE: - data_protection_snapshot_policyblock can be used alone or with data_protection_replication in the primary volume only, if enabling it in the secondary, an error will be thrown.
- snapshotPolicy StringId 
- Resource ID of the snapshot policy to apply to the volume. - A full example of the - data_protection_snapshot_policyattribute usage can be found in the- ./examples/netapp/nfsv3_volume_with_snapshot_policydirectory within the GitHub Repository- NOTE: - data_protection_snapshot_policyblock can be used alone or with data_protection_replication in the primary volume only, if enabling it in the secondary, an error will be thrown.
VolumeExportPolicyRule, VolumeExportPolicyRuleArgs        
- AllowedClients List<string>
- A list of allowed clients IPv4 addresses.
- RuleIndex int
- The index number of the rule.
- Kerberos5ReadOnly boolEnabled 
- Is Kerberos 5 read-only access permitted to this volume?
- Kerberos5ReadWrite boolEnabled 
- Is Kerberos 5 read/write permitted to this volume?
- Kerberos5iRead boolOnly Enabled 
- Is Kerberos 5i read-only permitted to this volume?
- Kerberos5iRead boolWrite Enabled 
- Is Kerberos 5i read/write permitted to this volume?
- Kerberos5pRead boolOnly Enabled 
- Is Kerberos 5p read-only permitted to this volume?
- Kerberos5pRead boolWrite Enabled 
- Is Kerberos 5p read/write permitted to this volume?
- ProtocolsEnabled string
- A list of allowed protocols. Valid values include CIFS,NFSv3, orNFSv4.1. Only one value is supported at this time. This replaces the previous arguments:cifs_enabled,nfsv3_enabledandnfsv4_enabled.
- RootAccess boolEnabled 
- Is root access permitted to this volume?
- UnixRead boolOnly 
- Is the file system on unix read only?
- UnixRead boolWrite 
- Is the file system on unix read and write?
- AllowedClients []string
- A list of allowed clients IPv4 addresses.
- RuleIndex int
- The index number of the rule.
- Kerberos5ReadOnly boolEnabled 
- Is Kerberos 5 read-only access permitted to this volume?
- Kerberos5ReadWrite boolEnabled 
- Is Kerberos 5 read/write permitted to this volume?
- Kerberos5iRead boolOnly Enabled 
- Is Kerberos 5i read-only permitted to this volume?
- Kerberos5iRead boolWrite Enabled 
- Is Kerberos 5i read/write permitted to this volume?
- Kerberos5pRead boolOnly Enabled 
- Is Kerberos 5p read-only permitted to this volume?
- Kerberos5pRead boolWrite Enabled 
- Is Kerberos 5p read/write permitted to this volume?
- ProtocolsEnabled string
- A list of allowed protocols. Valid values include CIFS,NFSv3, orNFSv4.1. Only one value is supported at this time. This replaces the previous arguments:cifs_enabled,nfsv3_enabledandnfsv4_enabled.
- RootAccess boolEnabled 
- Is root access permitted to this volume?
- UnixRead boolOnly 
- Is the file system on unix read only?
- UnixRead boolWrite 
- Is the file system on unix read and write?
- allowedClients List<String>
- A list of allowed clients IPv4 addresses.
- ruleIndex Integer
- The index number of the rule.
- kerberos5ReadOnly BooleanEnabled 
- Is Kerberos 5 read-only access permitted to this volume?
- kerberos5ReadWrite BooleanEnabled 
- Is Kerberos 5 read/write permitted to this volume?
- kerberos5iRead BooleanOnly Enabled 
- Is Kerberos 5i read-only permitted to this volume?
- kerberos5iRead BooleanWrite Enabled 
- Is Kerberos 5i read/write permitted to this volume?
- kerberos5pRead BooleanOnly Enabled 
- Is Kerberos 5p read-only permitted to this volume?
- kerberos5pRead BooleanWrite Enabled 
- Is Kerberos 5p read/write permitted to this volume?
- protocolsEnabled String
- A list of allowed protocols. Valid values include CIFS,NFSv3, orNFSv4.1. Only one value is supported at this time. This replaces the previous arguments:cifs_enabled,nfsv3_enabledandnfsv4_enabled.
- rootAccess BooleanEnabled 
- Is root access permitted to this volume?
- unixRead BooleanOnly 
- Is the file system on unix read only?
- unixRead BooleanWrite 
- Is the file system on unix read and write?
- allowedClients string[]
- A list of allowed clients IPv4 addresses.
- ruleIndex number
- The index number of the rule.
- kerberos5ReadOnly booleanEnabled 
- Is Kerberos 5 read-only access permitted to this volume?
- kerberos5ReadWrite booleanEnabled 
- Is Kerberos 5 read/write permitted to this volume?
- kerberos5iRead booleanOnly Enabled 
- Is Kerberos 5i read-only permitted to this volume?
- kerberos5iRead booleanWrite Enabled 
- Is Kerberos 5i read/write permitted to this volume?
- kerberos5pRead booleanOnly Enabled 
- Is Kerberos 5p read-only permitted to this volume?
- kerberos5pRead booleanWrite Enabled 
- Is Kerberos 5p read/write permitted to this volume?
- protocolsEnabled string
- A list of allowed protocols. Valid values include CIFS,NFSv3, orNFSv4.1. Only one value is supported at this time. This replaces the previous arguments:cifs_enabled,nfsv3_enabledandnfsv4_enabled.
- rootAccess booleanEnabled 
- Is root access permitted to this volume?
- unixRead booleanOnly 
- Is the file system on unix read only?
- unixRead booleanWrite 
- Is the file system on unix read and write?
- allowed_clients Sequence[str]
- A list of allowed clients IPv4 addresses.
- rule_index int
- The index number of the rule.
- kerberos5_read_ boolonly_ enabled 
- Is Kerberos 5 read-only access permitted to this volume?
- kerberos5_read_ boolwrite_ enabled 
- Is Kerberos 5 read/write permitted to this volume?
- kerberos5i_read_ boolonly_ enabled 
- Is Kerberos 5i read-only permitted to this volume?
- kerberos5i_read_ boolwrite_ enabled 
- Is Kerberos 5i read/write permitted to this volume?
- kerberos5p_read_ boolonly_ enabled 
- Is Kerberos 5p read-only permitted to this volume?
- kerberos5p_read_ boolwrite_ enabled 
- Is Kerberos 5p read/write permitted to this volume?
- protocols_enabled str
- A list of allowed protocols. Valid values include CIFS,NFSv3, orNFSv4.1. Only one value is supported at this time. This replaces the previous arguments:cifs_enabled,nfsv3_enabledandnfsv4_enabled.
- root_access_ boolenabled 
- Is root access permitted to this volume?
- unix_read_ boolonly 
- Is the file system on unix read only?
- unix_read_ boolwrite 
- Is the file system on unix read and write?
- allowedClients List<String>
- A list of allowed clients IPv4 addresses.
- ruleIndex Number
- The index number of the rule.
- kerberos5ReadOnly BooleanEnabled 
- Is Kerberos 5 read-only access permitted to this volume?
- kerberos5ReadWrite BooleanEnabled 
- Is Kerberos 5 read/write permitted to this volume?
- kerberos5iRead BooleanOnly Enabled 
- Is Kerberos 5i read-only permitted to this volume?
- kerberos5iRead BooleanWrite Enabled 
- Is Kerberos 5i read/write permitted to this volume?
- kerberos5pRead BooleanOnly Enabled 
- Is Kerberos 5p read-only permitted to this volume?
- kerberos5pRead BooleanWrite Enabled 
- Is Kerberos 5p read/write permitted to this volume?
- protocolsEnabled String
- A list of allowed protocols. Valid values include CIFS,NFSv3, orNFSv4.1. Only one value is supported at this time. This replaces the previous arguments:cifs_enabled,nfsv3_enabledandnfsv4_enabled.
- rootAccess BooleanEnabled 
- Is root access permitted to this volume?
- unixRead BooleanOnly 
- Is the file system on unix read only?
- unixRead BooleanWrite 
- Is the file system on unix read and write?
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the azurermTerraform Provider.