1. Packages
  2. Azure Classic
  3. API Docs
  4. netapp
  5. Volume

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Manages a NetApp Volume.

    NetApp Volume Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
        addressSpaces: ["10.0.0.0/16"],
    });
    const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
        resourceGroupName: exampleResourceGroup.name,
        virtualNetworkName: exampleVirtualNetwork.name,
        addressPrefixes: ["10.0.2.0/24"],
        delegations: [{
            name: "netapp",
            serviceDelegation: {
                name: "Microsoft.Netapp/volumes",
                actions: [
                    "Microsoft.Network/networkinterfaces/*",
                    "Microsoft.Network/virtualNetworks/subnets/join/action",
                ],
            },
        }],
    });
    const exampleAccount = new azure.netapp.Account("exampleAccount", {
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
    });
    const examplePool = new azure.netapp.Pool("examplePool", {
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
        accountName: exampleAccount.name,
        serviceLevel: "Premium",
        sizeInTb: 4,
    });
    const exampleVolume = new azure.netapp.Volume("exampleVolume", {
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
        accountName: exampleAccount.name,
        poolName: examplePool.name,
        volumePath: "my-unique-file-path",
        serviceLevel: "Premium",
        subnetId: exampleSubnet.id,
        protocols: ["NFSv4.1"],
        securityStyle: "Unix",
        storageQuotaInGb: 100,
        snapshotDirectoryVisible: false,
        createFromSnapshotResourceId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1",
        dataProtectionReplication: {
            endpointType: "dst",
            remoteVolumeLocation: azurerm_resource_group.example_primary.location,
            remoteVolumeResourceId: azurerm_netapp_volume.example_primary.id,
            replicationFrequency: "10minutes",
        },
        dataProtectionSnapshotPolicy: {
            snapshotPolicyId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotpolicy1",
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name,
        address_spaces=["10.0.0.0/16"])
    example_subnet = azure.network.Subnet("exampleSubnet",
        resource_group_name=example_resource_group.name,
        virtual_network_name=example_virtual_network.name,
        address_prefixes=["10.0.2.0/24"],
        delegations=[azure.network.SubnetDelegationArgs(
            name="netapp",
            service_delegation=azure.network.SubnetDelegationServiceDelegationArgs(
                name="Microsoft.Netapp/volumes",
                actions=[
                    "Microsoft.Network/networkinterfaces/*",
                    "Microsoft.Network/virtualNetworks/subnets/join/action",
                ],
            ),
        )])
    example_account = azure.netapp.Account("exampleAccount",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name)
    example_pool = azure.netapp.Pool("examplePool",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name,
        account_name=example_account.name,
        service_level="Premium",
        size_in_tb=4)
    example_volume = azure.netapp.Volume("exampleVolume",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name,
        account_name=example_account.name,
        pool_name=example_pool.name,
        volume_path="my-unique-file-path",
        service_level="Premium",
        subnet_id=example_subnet.id,
        protocols=["NFSv4.1"],
        security_style="Unix",
        storage_quota_in_gb=100,
        snapshot_directory_visible=False,
        create_from_snapshot_resource_id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1",
        data_protection_replication=azure.netapp.VolumeDataProtectionReplicationArgs(
            endpoint_type="dst",
            remote_volume_location=azurerm_resource_group["example_primary"]["location"],
            remote_volume_resource_id=azurerm_netapp_volume["example_primary"]["id"],
            replication_frequency="10minutes",
        ),
        data_protection_snapshot_policy=azure.netapp.VolumeDataProtectionSnapshotPolicyArgs(
            snapshot_policy_id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotpolicy1",
        ))
    
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
            {
                Location = "West Europe",
            });
            var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new Azure.Network.VirtualNetworkArgs
            {
                Location = exampleResourceGroup.Location,
                ResourceGroupName = exampleResourceGroup.Name,
                AddressSpaces = 
                {
                    "10.0.0.0/16",
                },
            });
            var exampleSubnet = new Azure.Network.Subnet("exampleSubnet", new Azure.Network.SubnetArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                VirtualNetworkName = exampleVirtualNetwork.Name,
                AddressPrefixes = 
                {
                    "10.0.2.0/24",
                },
                Delegations = 
                {
                    new Azure.Network.Inputs.SubnetDelegationArgs
                    {
                        Name = "netapp",
                        ServiceDelegation = new Azure.Network.Inputs.SubnetDelegationServiceDelegationArgs
                        {
                            Name = "Microsoft.Netapp/volumes",
                            Actions = 
                            {
                                "Microsoft.Network/networkinterfaces/*",
                                "Microsoft.Network/virtualNetworks/subnets/join/action",
                            },
                        },
                    },
                },
            });
            var exampleAccount = new Azure.NetApp.Account("exampleAccount", new Azure.NetApp.AccountArgs
            {
                Location = exampleResourceGroup.Location,
                ResourceGroupName = exampleResourceGroup.Name,
            });
            var examplePool = new Azure.NetApp.Pool("examplePool", new Azure.NetApp.PoolArgs
            {
                Location = exampleResourceGroup.Location,
                ResourceGroupName = exampleResourceGroup.Name,
                AccountName = exampleAccount.Name,
                ServiceLevel = "Premium",
                SizeInTb = 4,
            });
            var exampleVolume = new Azure.NetApp.Volume("exampleVolume", new Azure.NetApp.VolumeArgs
            {
                Location = exampleResourceGroup.Location,
                ResourceGroupName = exampleResourceGroup.Name,
                AccountName = exampleAccount.Name,
                PoolName = examplePool.Name,
                VolumePath = "my-unique-file-path",
                ServiceLevel = "Premium",
                SubnetId = exampleSubnet.Id,
                Protocols = 
                {
                    "NFSv4.1",
                },
                SecurityStyle = "Unix",
                StorageQuotaInGb = 100,
                SnapshotDirectoryVisible = false,
                CreateFromSnapshotResourceId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1",
                DataProtectionReplication = new Azure.NetApp.Inputs.VolumeDataProtectionReplicationArgs
                {
                    EndpointType = "dst",
                    RemoteVolumeLocation = azurerm_resource_group.Example_primary.Location,
                    RemoteVolumeResourceId = azurerm_netapp_volume.Example_primary.Id,
                    ReplicationFrequency = "10minutes",
                },
                DataProtectionSnapshotPolicy = new Azure.NetApp.Inputs.VolumeDataProtectionSnapshotPolicyArgs
                {
                    SnapshotPolicyId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotpolicy1",
                },
            });
        }
    
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/netapp"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/network"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    			AddressSpaces: pulumi.StringArray{
    				pulumi.String("10.0.0.0/16"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleSubnet, err := network.NewSubnet(ctx, "exampleSubnet", &network.SubnetArgs{
    			ResourceGroupName:  exampleResourceGroup.Name,
    			VirtualNetworkName: exampleVirtualNetwork.Name,
    			AddressPrefixes: pulumi.StringArray{
    				pulumi.String("10.0.2.0/24"),
    			},
    			Delegations: network.SubnetDelegationArray{
    				&network.SubnetDelegationArgs{
    					Name: pulumi.String("netapp"),
    					ServiceDelegation: &network.SubnetDelegationServiceDelegationArgs{
    						Name: pulumi.String("Microsoft.Netapp/volumes"),
    						Actions: pulumi.StringArray{
    							pulumi.String("Microsoft.Network/networkinterfaces/*"),
    							pulumi.String("Microsoft.Network/virtualNetworks/subnets/join/action"),
    						},
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := netapp.NewAccount(ctx, "exampleAccount", &netapp.AccountArgs{
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    		})
    		if err != nil {
    			return err
    		}
    		examplePool, err := netapp.NewPool(ctx, "examplePool", &netapp.PoolArgs{
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    			AccountName:       exampleAccount.Name,
    			ServiceLevel:      pulumi.String("Premium"),
    			SizeInTb:          pulumi.Int(4),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = netapp.NewVolume(ctx, "exampleVolume", &netapp.VolumeArgs{
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    			AccountName:       exampleAccount.Name,
    			PoolName:          examplePool.Name,
    			VolumePath:        pulumi.String("my-unique-file-path"),
    			ServiceLevel:      pulumi.String("Premium"),
    			SubnetId:          exampleSubnet.ID(),
    			Protocols: pulumi.StringArray{
    				pulumi.String("NFSv4.1"),
    			},
    			SecurityStyle:                pulumi.String("Unix"),
    			StorageQuotaInGb:             pulumi.Int(100),
    			SnapshotDirectoryVisible:     pulumi.Bool(false),
    			CreateFromSnapshotResourceId: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1"),
    			DataProtectionReplication: &netapp.VolumeDataProtectionReplicationArgs{
    				EndpointType:           pulumi.String("dst"),
    				RemoteVolumeLocation:   pulumi.Any(azurerm_resource_group.Example_primary.Location),
    				RemoteVolumeResourceId: pulumi.Any(azurerm_netapp_volume.Example_primary.Id),
    				ReplicationFrequency:   pulumi.String("10minutes"),
    			},
    			DataProtectionSnapshotPolicy: &netapp.VolumeDataProtectionSnapshotPolicyArgs{
    				SnapshotPolicyId: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotpolicy1"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    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,
               protocols: Optional[Sequence[str]] = None,
               name: Optional[str] = None,
               location: Optional[str] = None,
               security_style: Optional[str] = None,
               export_policy_rules: Optional[Sequence[VolumeExportPolicyRuleArgs]] = None,
               snapshot_directory_visible: Optional[bool] = None,
               data_protection_snapshot_policy: Optional[VolumeDataProtectionSnapshotPolicyArgs] = None,
               data_protection_replication: Optional[VolumeDataProtectionReplicationArgs] = None,
               tags: Optional[Mapping[str, str]] = None,
               throughput_in_mibps: Optional[float] = None,
               create_from_snapshot_resource_id: 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 volumeResource = new Azure.NetApp.Volume("volumeResource", new()
    {
        PoolName = "string",
        VolumePath = "string",
        SubnetId = "string",
        StorageQuotaInGb = 0,
        ServiceLevel = "string",
        ResourceGroupName = "string",
        AccountName = "string",
        Protocols = new[]
        {
            "string",
        },
        Name = "string",
        Location = "string",
        SecurityStyle = "string",
        ExportPolicyRules = new[]
        {
            new Azure.NetApp.Inputs.VolumeExportPolicyRuleArgs
            {
                AllowedClients = new[]
                {
                    "string",
                },
                RuleIndex = 0,
                ProtocolsEnabled = "string",
                RootAccessEnabled = false,
                UnixReadOnly = false,
                UnixReadWrite = false,
            },
        },
        SnapshotDirectoryVisible = false,
        DataProtectionSnapshotPolicy = new Azure.NetApp.Inputs.VolumeDataProtectionSnapshotPolicyArgs
        {
            SnapshotPolicyId = "string",
        },
        DataProtectionReplication = new Azure.NetApp.Inputs.VolumeDataProtectionReplicationArgs
        {
            RemoteVolumeLocation = "string",
            RemoteVolumeResourceId = "string",
            ReplicationFrequency = "string",
            EndpointType = "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
        ThroughputInMibps = 0,
        CreateFromSnapshotResourceId = "string",
    });
    
    example, err := netapp.NewVolume(ctx, "volumeResource", &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"),
    	Protocols: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name:          pulumi.String("string"),
    	Location:      pulumi.String("string"),
    	SecurityStyle: pulumi.String("string"),
    	ExportPolicyRules: netapp.VolumeExportPolicyRuleArray{
    		&netapp.VolumeExportPolicyRuleArgs{
    			AllowedClients: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			RuleIndex:         pulumi.Int(0),
    			ProtocolsEnabled:  pulumi.String("string"),
    			RootAccessEnabled: pulumi.Bool(false),
    			UnixReadOnly:      pulumi.Bool(false),
    			UnixReadWrite:     pulumi.Bool(false),
    		},
    	},
    	SnapshotDirectoryVisible: pulumi.Bool(false),
    	DataProtectionSnapshotPolicy: &netapp.VolumeDataProtectionSnapshotPolicyArgs{
    		SnapshotPolicyId: pulumi.String("string"),
    	},
    	DataProtectionReplication: &netapp.VolumeDataProtectionReplicationArgs{
    		RemoteVolumeLocation:   pulumi.String("string"),
    		RemoteVolumeResourceId: pulumi.String("string"),
    		ReplicationFrequency:   pulumi.String("string"),
    		EndpointType:           pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	ThroughputInMibps:            pulumi.Float64(0),
    	CreateFromSnapshotResourceId: pulumi.String("string"),
    })
    
    var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
        .poolName("string")
        .volumePath("string")
        .subnetId("string")
        .storageQuotaInGb(0)
        .serviceLevel("string")
        .resourceGroupName("string")
        .accountName("string")
        .protocols("string")
        .name("string")
        .location("string")
        .securityStyle("string")
        .exportPolicyRules(VolumeExportPolicyRuleArgs.builder()
            .allowedClients("string")
            .ruleIndex(0)
            .protocolsEnabled("string")
            .rootAccessEnabled(false)
            .unixReadOnly(false)
            .unixReadWrite(false)
            .build())
        .snapshotDirectoryVisible(false)
        .dataProtectionSnapshotPolicy(VolumeDataProtectionSnapshotPolicyArgs.builder()
            .snapshotPolicyId("string")
            .build())
        .dataProtectionReplication(VolumeDataProtectionReplicationArgs.builder()
            .remoteVolumeLocation("string")
            .remoteVolumeResourceId("string")
            .replicationFrequency("string")
            .endpointType("string")
            .build())
        .tags(Map.of("string", "string"))
        .throughputInMibps(0.0)
        .createFromSnapshotResourceId("string")
        .build());
    
    volume_resource = azure.netapp.Volume("volumeResource",
        pool_name="string",
        volume_path="string",
        subnet_id="string",
        storage_quota_in_gb=0,
        service_level="string",
        resource_group_name="string",
        account_name="string",
        protocols=["string"],
        name="string",
        location="string",
        security_style="string",
        export_policy_rules=[{
            "allowed_clients": ["string"],
            "rule_index": 0,
            "protocols_enabled": "string",
            "root_access_enabled": False,
            "unix_read_only": False,
            "unix_read_write": False,
        }],
        snapshot_directory_visible=False,
        data_protection_snapshot_policy={
            "snapshot_policy_id": "string",
        },
        data_protection_replication={
            "remote_volume_location": "string",
            "remote_volume_resource_id": "string",
            "replication_frequency": "string",
            "endpoint_type": "string",
        },
        tags={
            "string": "string",
        },
        throughput_in_mibps=0,
        create_from_snapshot_resource_id="string")
    
    const volumeResource = new azure.netapp.Volume("volumeResource", {
        poolName: "string",
        volumePath: "string",
        subnetId: "string",
        storageQuotaInGb: 0,
        serviceLevel: "string",
        resourceGroupName: "string",
        accountName: "string",
        protocols: ["string"],
        name: "string",
        location: "string",
        securityStyle: "string",
        exportPolicyRules: [{
            allowedClients: ["string"],
            ruleIndex: 0,
            protocolsEnabled: "string",
            rootAccessEnabled: false,
            unixReadOnly: false,
            unixReadWrite: false,
        }],
        snapshotDirectoryVisible: false,
        dataProtectionSnapshotPolicy: {
            snapshotPolicyId: "string",
        },
        dataProtectionReplication: {
            remoteVolumeLocation: "string",
            remoteVolumeResourceId: "string",
            replicationFrequency: "string",
            endpointType: "string",
        },
        tags: {
            string: "string",
        },
        throughputInMibps: 0,
        createFromSnapshotResourceId: "string",
    });
    
    type: azure:netapp:Volume
    properties:
        accountName: string
        createFromSnapshotResourceId: string
        dataProtectionReplication:
            endpointType: string
            remoteVolumeLocation: string
            remoteVolumeResourceId: string
            replicationFrequency: string
        dataProtectionSnapshotPolicy:
            snapshotPolicyId: string
        exportPolicyRules:
            - allowedClients:
                - string
              protocolsEnabled: string
              rootAccessEnabled: false
              ruleIndex: 0
              unixReadOnly: false
              unixReadWrite: false
        location: string
        name: string
        poolName: string
        protocols:
            - string
        resourceGroupName: string
        securityStyle: string
        serviceLevel: string
        snapshotDirectoryVisible: false
        storageQuotaInGb: 0
        subnetId: string
        tags:
            string: string
        throughputInMibps: 0
        volumePath: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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.
    ResourceGroupName string
    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, or Ultra.
    StorageQuotaInGb int
    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/volumes delegation. 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.
    CreateFromSnapshotResourceId string
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name.
    DataProtectionReplication VolumeDataProtectionReplication
    A data_protection_replication block as defined below.
    DataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicy
    A data_protection_snapshot_policy block as defined below.
    ExportPolicyRules List<VolumeExportPolicyRule>
    One or more export_policy_rule block defined below.
    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.
    Protocols List<string>
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    SecurityStyle string
    Volume security style, accepted values are Unix or Ntfs. If not provided, single-protocol volume is created defaulting to Unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to Ntfs. In a dual-protocol volume, if not provided, its value will be Ntfs.
    SnapshotDirectoryVisible bool
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    ThroughputInMibps double
    Throughput of this volume in Mibps.
    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.
    ResourceGroupName string
    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, or Ultra.
    StorageQuotaInGb int
    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/volumes delegation. 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.
    CreateFromSnapshotResourceId string
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name.
    DataProtectionReplication VolumeDataProtectionReplicationArgs
    A data_protection_replication block as defined below.
    DataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicyArgs
    A data_protection_snapshot_policy block as defined below.
    ExportPolicyRules []VolumeExportPolicyRuleArgs
    One or more export_policy_rule block defined below.
    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.
    Protocols []string
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    SecurityStyle string
    Volume security style, accepted values are Unix or Ntfs. If not provided, single-protocol volume is created defaulting to Unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to Ntfs. In a dual-protocol volume, if not provided, its value will be Ntfs.
    SnapshotDirectoryVisible bool
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    ThroughputInMibps float64
    Throughput of this volume in Mibps.
    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.
    resourceGroupName String
    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, or Ultra.
    storageQuotaInGb Integer
    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/volumes delegation. 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.
    createFromSnapshotResourceId String
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name.
    dataProtectionReplication VolumeDataProtectionReplication
    A data_protection_replication block as defined below.
    dataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicy
    A data_protection_snapshot_policy block as defined below.
    exportPolicyRules List<VolumeExportPolicyRule>
    One or more export_policy_rule block defined below.
    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.
    protocols List<String>
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    securityStyle String
    Volume security style, accepted values are Unix or Ntfs. If not provided, single-protocol volume is created defaulting to Unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to Ntfs. In a dual-protocol volume, if not provided, its value will be Ntfs.
    snapshotDirectoryVisible Boolean
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    throughputInMibps Double
    Throughput of this volume in Mibps.
    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.
    resourceGroupName string
    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, or Ultra.
    storageQuotaInGb number
    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/volumes delegation. 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.
    createFromSnapshotResourceId string
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name.
    dataProtectionReplication VolumeDataProtectionReplication
    A data_protection_replication block as defined below.
    dataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicy
    A data_protection_snapshot_policy block as defined below.
    exportPolicyRules VolumeExportPolicyRule[]
    One or more export_policy_rule block defined below.
    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.
    protocols string[]
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    securityStyle string
    Volume security style, accepted values are Unix or Ntfs. If not provided, single-protocol volume is created defaulting to Unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to Ntfs. In a dual-protocol volume, if not provided, its value will be Ntfs.
    snapshotDirectoryVisible boolean
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    throughputInMibps number
    Throughput of this volume in Mibps.
    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_name str
    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, or Ultra.
    storage_quota_in_gb int
    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/volumes delegation. 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.
    create_from_snapshot_resource_id str
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name.
    data_protection_replication VolumeDataProtectionReplicationArgs
    A data_protection_replication block as defined below.
    data_protection_snapshot_policy VolumeDataProtectionSnapshotPolicyArgs
    A data_protection_snapshot_policy block as defined below.
    export_policy_rules Sequence[VolumeExportPolicyRuleArgs]
    One or more export_policy_rule block defined below.
    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.
    protocols Sequence[str]
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    security_style str
    Volume security style, accepted values are Unix or Ntfs. If not provided, single-protocol volume is created defaulting to Unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to Ntfs. In a dual-protocol volume, if not provided, its value will be Ntfs.
    snapshot_directory_visible bool
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    throughput_in_mibps float
    Throughput of this volume in Mibps.
    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.
    resourceGroupName String
    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, or Ultra.
    storageQuotaInGb Number
    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/volumes delegation. 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.
    createFromSnapshotResourceId String
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name.
    dataProtectionReplication Property Map
    A data_protection_replication block as defined below.
    dataProtectionSnapshotPolicy Property Map
    A data_protection_snapshot_policy block as defined below.
    exportPolicyRules List<Property Map>
    One or more export_policy_rule block defined below.
    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.
    protocols List<String>
    The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    securityStyle String
    Volume security style, accepted values are Unix or Ntfs. If not provided, single-protocol volume is created defaulting to Unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to Ntfs. In a dual-protocol volume, if not provided, its value will be Ntfs.
    snapshotDirectoryVisible Boolean
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    tags Map<String>
    A mapping of tags to assign to the resource.
    throughputInMibps Number
    Throughput of this volume in Mibps.

    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.
    MountIpAddresses List<string>
    A list of IPv4 Addresses which should be used to mount the volume.
    Id string
    The provider-assigned unique ID for this managed resource.
    MountIpAddresses []string
    A list of IPv4 Addresses which should be used to mount the volume.
    id String
    The provider-assigned unique ID for this managed resource.
    mountIpAddresses List<String>
    A list of IPv4 Addresses which should be used to mount the volume.
    id string
    The provider-assigned unique ID for this managed resource.
    mountIpAddresses string[]
    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_addresses Sequence[str]
    A list of IPv4 Addresses which should be used to mount the volume.
    id String
    The provider-assigned unique ID for this managed resource.
    mountIpAddresses List<String>
    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,
            create_from_snapshot_resource_id: Optional[str] = None,
            data_protection_replication: Optional[VolumeDataProtectionReplicationArgs] = None,
            data_protection_snapshot_policy: Optional[VolumeDataProtectionSnapshotPolicyArgs] = None,
            export_policy_rules: Optional[Sequence[VolumeExportPolicyRuleArgs]] = None,
            location: Optional[str] = None,
            mount_ip_addresses: Optional[Sequence[str]] = None,
            name: 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,
            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) -> Volume
    func 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)
    resources:  _:    type: azure:netapp:Volume    get:      id: ${id}
    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.
    The following state arguments are supported:
    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.
    CreateFromSnapshotResourceId string
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name.
    DataProtectionReplication VolumeDataProtectionReplication
    A data_protection_replication block as defined below.
    DataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicy
    A data_protection_snapshot_policy block as defined below.
    ExportPolicyRules List<VolumeExportPolicyRule>
    One or more export_policy_rule block defined below.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MountIpAddresses List<string>
    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.
    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, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    ResourceGroupName string
    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 Unix or Ntfs. If not provided, single-protocol volume is created defaulting to Unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to Ntfs. In a dual-protocol volume, if not provided, its value will be Ntfs.
    ServiceLevel string
    The target performance of the file system. Valid values include Premium, Standard, or Ultra.
    SnapshotDirectoryVisible bool
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    StorageQuotaInGb int
    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/volumes delegation. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    ThroughputInMibps double
    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.
    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.
    CreateFromSnapshotResourceId string
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name.
    DataProtectionReplication VolumeDataProtectionReplicationArgs
    A data_protection_replication block as defined below.
    DataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicyArgs
    A data_protection_snapshot_policy block as defined below.
    ExportPolicyRules []VolumeExportPolicyRuleArgs
    One or more export_policy_rule block defined below.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MountIpAddresses []string
    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.
    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, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    ResourceGroupName string
    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 Unix or Ntfs. If not provided, single-protocol volume is created defaulting to Unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to Ntfs. In a dual-protocol volume, if not provided, its value will be Ntfs.
    ServiceLevel string
    The target performance of the file system. Valid values include Premium, Standard, or Ultra.
    SnapshotDirectoryVisible bool
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    StorageQuotaInGb int
    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/volumes delegation. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    ThroughputInMibps float64
    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.
    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.
    createFromSnapshotResourceId String
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name.
    dataProtectionReplication VolumeDataProtectionReplication
    A data_protection_replication block as defined below.
    dataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicy
    A data_protection_snapshot_policy block as defined below.
    exportPolicyRules List<VolumeExportPolicyRule>
    One or more export_policy_rule block defined below.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mountIpAddresses List<String>
    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.
    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, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    resourceGroupName String
    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 Unix or Ntfs. If not provided, single-protocol volume is created defaulting to Unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to Ntfs. In a dual-protocol volume, if not provided, its value will be Ntfs.
    serviceLevel String
    The target performance of the file system. Valid values include Premium, Standard, or Ultra.
    snapshotDirectoryVisible Boolean
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    storageQuotaInGb Integer
    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/volumes delegation. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    throughputInMibps Double
    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.
    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.
    createFromSnapshotResourceId string
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name.
    dataProtectionReplication VolumeDataProtectionReplication
    A data_protection_replication block as defined below.
    dataProtectionSnapshotPolicy VolumeDataProtectionSnapshotPolicy
    A data_protection_snapshot_policy block as defined below.
    exportPolicyRules VolumeExportPolicyRule[]
    One or more export_policy_rule block defined below.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mountIpAddresses string[]
    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.
    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, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    resourceGroupName string
    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 Unix or Ntfs. If not provided, single-protocol volume is created defaulting to Unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to Ntfs. In a dual-protocol volume, if not provided, its value will be Ntfs.
    serviceLevel string
    The target performance of the file system. Valid values include Premium, Standard, or Ultra.
    snapshotDirectoryVisible boolean
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    storageQuotaInGb number
    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/volumes delegation. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    throughputInMibps number
    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.
    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.
    create_from_snapshot_resource_id str
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name.
    data_protection_replication VolumeDataProtectionReplicationArgs
    A data_protection_replication block as defined below.
    data_protection_snapshot_policy VolumeDataProtectionSnapshotPolicyArgs
    A data_protection_snapshot_policy block as defined below.
    export_policy_rules Sequence[VolumeExportPolicyRuleArgs]
    One or more export_policy_rule block defined below.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mount_ip_addresses Sequence[str]
    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.
    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, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    resource_group_name str
    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 Unix or Ntfs. If not provided, single-protocol volume is created defaulting to Unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to Ntfs. In a dual-protocol volume, if not provided, its value will be Ntfs.
    service_level str
    The target performance of the file system. Valid values include Premium, Standard, or Ultra.
    snapshot_directory_visible bool
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    storage_quota_in_gb int
    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/volumes delegation. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    throughput_in_mibps float
    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.
    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.
    createFromSnapshotResourceId String
    Creates volume from snapshot. Following properties must be the same as the original volume where the snapshot was taken from: protocols, subnet_id, location, service_level, resource_group_name, account_name and pool_name.
    dataProtectionReplication Property Map
    A data_protection_replication block as defined below.
    dataProtectionSnapshotPolicy Property Map
    A data_protection_snapshot_policy block as defined below.
    exportPolicyRules List<Property Map>
    One or more export_policy_rule block defined below.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    mountIpAddresses List<String>
    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.
    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, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost. Dual protocol scenario is supported for CIFS and NFSv3, for more information, please refer to Create a dual-protocol volume for Azure NetApp Files document.
    resourceGroupName String
    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 Unix or Ntfs. If not provided, single-protocol volume is created defaulting to Unix if it is NFSv3 or NFSv4.1 volume, if CIFS, it will default to Ntfs. In a dual-protocol volume, if not provided, its value will be Ntfs.
    serviceLevel String
    The target performance of the file system. Valid values include Premium, Standard, or Ultra.
    snapshotDirectoryVisible Boolean
    Specifies whether the .snapshot (NFS clients) or ~snapshot (SMB clients) path of a volume is visible, default value is true.
    storageQuotaInGb Number
    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/volumes delegation. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.
    throughputInMibps Number
    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.

    Supporting Types

    VolumeDataProtectionReplication, VolumeDataProtectionReplicationArgs

    RemoteVolumeLocation string
    Location of the primary volume.
    RemoteVolumeResourceId string
    Resource ID of the primary volume.
    ReplicationFrequency string
    Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive.
    EndpointType string
    The endpoint type, default value is dst for destination.
    RemoteVolumeLocation string
    Location of the primary volume.
    RemoteVolumeResourceId string
    Resource ID of the primary volume.
    ReplicationFrequency string
    Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive.
    EndpointType string
    The endpoint type, default value is dst for destination.
    remoteVolumeLocation String
    Location of the primary volume.
    remoteVolumeResourceId String
    Resource ID of the primary volume.
    replicationFrequency String
    Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive.
    endpointType String
    The endpoint type, default value is dst for destination.
    remoteVolumeLocation string
    Location of the primary volume.
    remoteVolumeResourceId string
    Resource ID of the primary volume.
    replicationFrequency string
    Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive.
    endpointType string
    The endpoint type, default value is dst for destination.
    remote_volume_location str
    Location of the primary volume.
    remote_volume_resource_id str
    Resource ID of the primary volume.
    replication_frequency str
    Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive.
    endpoint_type str
    The endpoint type, default value is dst for destination.
    remoteVolumeLocation String
    Location of the primary volume.
    remoteVolumeResourceId String
    Resource ID of the primary volume.
    replicationFrequency String
    Replication frequency, supported values are '10minutes', 'hourly', 'daily', values are case sensitive.
    endpointType String
    The endpoint type, default value is dst for destination.

    VolumeDataProtectionSnapshotPolicy, VolumeDataProtectionSnapshotPolicyArgs

    SnapshotPolicyId string
    Resource ID of the snapshot policy to apply to the volume.
    SnapshotPolicyId string
    Resource ID of the snapshot policy to apply to the volume.
    snapshotPolicyId String
    Resource ID of the snapshot policy to apply to the volume.
    snapshotPolicyId string
    Resource ID of the snapshot policy to apply to the volume.
    snapshot_policy_id str
    Resource ID of the snapshot policy to apply to the volume.
    snapshotPolicyId String
    Resource ID of the snapshot policy to apply to the volume.

    VolumeExportPolicyRule, VolumeExportPolicyRuleArgs

    AllowedClients List<string>
    A list of allowed clients IPv4 addresses.
    RuleIndex int
    The index number of the rule.
    CifsEnabled bool

    Deprecated: Deprecated in favour of protocols_enabled

    Nfsv3Enabled bool

    Deprecated: Deprecated in favour of protocols_enabled

    Nfsv4Enabled bool

    Deprecated: Deprecated in favour of protocols_enabled

    ProtocolsEnabled string
    A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifs_enabled, nfsv3_enabled and nfsv4_enabled.
    RootAccessEnabled bool
    Is root access permitted to this volume?
    UnixReadOnly bool
    Is the file system on unix read only?
    UnixReadWrite bool
    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.
    CifsEnabled bool

    Deprecated: Deprecated in favour of protocols_enabled

    Nfsv3Enabled bool

    Deprecated: Deprecated in favour of protocols_enabled

    Nfsv4Enabled bool

    Deprecated: Deprecated in favour of protocols_enabled

    ProtocolsEnabled string
    A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifs_enabled, nfsv3_enabled and nfsv4_enabled.
    RootAccessEnabled bool
    Is root access permitted to this volume?
    UnixReadOnly bool
    Is the file system on unix read only?
    UnixReadWrite bool
    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.
    cifsEnabled Boolean

    Deprecated: Deprecated in favour of protocols_enabled

    nfsv3Enabled Boolean

    Deprecated: Deprecated in favour of protocols_enabled

    nfsv4Enabled Boolean

    Deprecated: Deprecated in favour of protocols_enabled

    protocolsEnabled String
    A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifs_enabled, nfsv3_enabled and nfsv4_enabled.
    rootAccessEnabled Boolean
    Is root access permitted to this volume?
    unixReadOnly Boolean
    Is the file system on unix read only?
    unixReadWrite Boolean
    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.
    cifsEnabled boolean

    Deprecated: Deprecated in favour of protocols_enabled

    nfsv3Enabled boolean

    Deprecated: Deprecated in favour of protocols_enabled

    nfsv4Enabled boolean

    Deprecated: Deprecated in favour of protocols_enabled

    protocolsEnabled string
    A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifs_enabled, nfsv3_enabled and nfsv4_enabled.
    rootAccessEnabled boolean
    Is root access permitted to this volume?
    unixReadOnly boolean
    Is the file system on unix read only?
    unixReadWrite boolean
    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.
    cifs_enabled bool

    Deprecated: Deprecated in favour of protocols_enabled

    nfsv3_enabled bool

    Deprecated: Deprecated in favour of protocols_enabled

    nfsv4_enabled bool

    Deprecated: Deprecated in favour of protocols_enabled

    protocols_enabled str
    A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifs_enabled, nfsv3_enabled and nfsv4_enabled.
    root_access_enabled bool
    Is root access permitted to this volume?
    unix_read_only bool
    Is the file system on unix read only?
    unix_read_write bool
    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.
    cifsEnabled Boolean

    Deprecated: Deprecated in favour of protocols_enabled

    nfsv3Enabled Boolean

    Deprecated: Deprecated in favour of protocols_enabled

    nfsv4Enabled Boolean

    Deprecated: Deprecated in favour of protocols_enabled

    protocolsEnabled String
    A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifs_enabled, nfsv3_enabled and nfsv4_enabled.
    rootAccessEnabled Boolean
    Is root access permitted to this volume?
    unixReadOnly Boolean
    Is the file system on unix read only?
    unixReadWrite Boolean
    Is the file system on unix read and write?

    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
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.