1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. datalake
  6. StoreVirtualNetworkRule

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

    Allows you to add, update, or remove an Azure Data Lake Store to a subnet of a virtual network.

    Note: This resoruce manages an Azure Data Lake Storage Gen1, previously known as Azure Data Lake Store.

    Example Usage

    using Pulumi;
    using Azure = Pulumi.Azure;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
            {
                Location = "northeurope",
            });
            var vnet = new Azure.Network.VirtualNetwork("vnet", new Azure.Network.VirtualNetworkArgs
            {
                AddressSpaces = 
                {
                    "10.7.29.0/29",
                },
                Location = exampleResourceGroup.Location,
                ResourceGroupName = exampleResourceGroup.Name,
            });
            var subnet = new Azure.Network.Subnet("subnet", new Azure.Network.SubnetArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                VirtualNetworkName = vnet.Name,
                AddressPrefixes = 
                {
                    "10.7.29.0/29",
                },
                ServiceEndpoints = 
                {
                    "Microsoft.AzureActiveDirectory",
                },
            });
            var exampleStore = new Azure.DataLake.Store("exampleStore", new Azure.DataLake.StoreArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                Location = exampleResourceGroup.Location,
            });
            var adlsvnetrule = new Azure.DataLake.StoreVirtualNetworkRule("adlsvnetrule", new Azure.DataLake.StoreVirtualNetworkRuleArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                AccountName = exampleStore.Name,
                SubnetId = subnet.Id,
            });
        }
    
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/datalake"
    	"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("northeurope"),
    		})
    		if err != nil {
    			return err
    		}
    		vnet, err := network.NewVirtualNetwork(ctx, "vnet", &network.VirtualNetworkArgs{
    			AddressSpaces: pulumi.StringArray{
    				pulumi.String("10.7.29.0/29"),
    			},
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    		})
    		if err != nil {
    			return err
    		}
    		subnet, err := network.NewSubnet(ctx, "subnet", &network.SubnetArgs{
    			ResourceGroupName:  exampleResourceGroup.Name,
    			VirtualNetworkName: vnet.Name,
    			AddressPrefixes: pulumi.StringArray{
    				pulumi.String("10.7.29.0/29"),
    			},
    			ServiceEndpoints: pulumi.StringArray{
    				pulumi.String("Microsoft.AzureActiveDirectory"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleStore, err := datalake.NewStore(ctx, "exampleStore", &datalake.StoreArgs{
    			ResourceGroupName: exampleResourceGroup.Name,
    			Location:          exampleResourceGroup.Location,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datalake.NewStoreVirtualNetworkRule(ctx, "adlsvnetrule", &datalake.StoreVirtualNetworkRuleArgs{
    			ResourceGroupName: exampleResourceGroup.Name,
    			AccountName:       exampleStore.Name,
    			SubnetId:          subnet.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "northeurope"});
    const vnet = new azure.network.VirtualNetwork("vnet", {
        addressSpaces: ["10.7.29.0/29"],
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
    });
    const subnet = new azure.network.Subnet("subnet", {
        resourceGroupName: exampleResourceGroup.name,
        virtualNetworkName: vnet.name,
        addressPrefixes: ["10.7.29.0/29"],
        serviceEndpoints: ["Microsoft.AzureActiveDirectory"],
    });
    const exampleStore = new azure.datalake.Store("exampleStore", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.location,
    });
    const adlsvnetrule = new azure.datalake.StoreVirtualNetworkRule("adlsvnetrule", {
        resourceGroupName: exampleResourceGroup.name,
        accountName: exampleStore.name,
        subnetId: subnet.id,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="northeurope")
    vnet = azure.network.VirtualNetwork("vnet",
        address_spaces=["10.7.29.0/29"],
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name)
    subnet = azure.network.Subnet("subnet",
        resource_group_name=example_resource_group.name,
        virtual_network_name=vnet.name,
        address_prefixes=["10.7.29.0/29"],
        service_endpoints=["Microsoft.AzureActiveDirectory"])
    example_store = azure.datalake.Store("exampleStore",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.location)
    adlsvnetrule = azure.datalake.StoreVirtualNetworkRule("adlsvnetrule",
        resource_group_name=example_resource_group.name,
        account_name=example_store.name,
        subnet_id=subnet.id)
    

    Example coming soon!

    Create StoreVirtualNetworkRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StoreVirtualNetworkRule(name: string, args: StoreVirtualNetworkRuleArgs, opts?: CustomResourceOptions);
    @overload
    def StoreVirtualNetworkRule(resource_name: str,
                                args: StoreVirtualNetworkRuleArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def StoreVirtualNetworkRule(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                account_name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                subnet_id: Optional[str] = None,
                                name: Optional[str] = None)
    func NewStoreVirtualNetworkRule(ctx *Context, name string, args StoreVirtualNetworkRuleArgs, opts ...ResourceOption) (*StoreVirtualNetworkRule, error)
    public StoreVirtualNetworkRule(string name, StoreVirtualNetworkRuleArgs args, CustomResourceOptions? opts = null)
    public StoreVirtualNetworkRule(String name, StoreVirtualNetworkRuleArgs args)
    public StoreVirtualNetworkRule(String name, StoreVirtualNetworkRuleArgs args, CustomResourceOptions options)
    
    type: azure:datalake:StoreVirtualNetworkRule
    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 StoreVirtualNetworkRuleArgs
    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 StoreVirtualNetworkRuleArgs
    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 StoreVirtualNetworkRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StoreVirtualNetworkRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StoreVirtualNetworkRuleArgs
    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 storeVirtualNetworkRuleResource = new Azure.DataLake.StoreVirtualNetworkRule("storeVirtualNetworkRuleResource", new()
    {
        AccountName = "string",
        ResourceGroupName = "string",
        SubnetId = "string",
        Name = "string",
    });
    
    example, err := datalake.NewStoreVirtualNetworkRule(ctx, "storeVirtualNetworkRuleResource", &datalake.StoreVirtualNetworkRuleArgs{
    	AccountName:       pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	SubnetId:          pulumi.String("string"),
    	Name:              pulumi.String("string"),
    })
    
    var storeVirtualNetworkRuleResource = new StoreVirtualNetworkRule("storeVirtualNetworkRuleResource", StoreVirtualNetworkRuleArgs.builder()
        .accountName("string")
        .resourceGroupName("string")
        .subnetId("string")
        .name("string")
        .build());
    
    store_virtual_network_rule_resource = azure.datalake.StoreVirtualNetworkRule("storeVirtualNetworkRuleResource",
        account_name="string",
        resource_group_name="string",
        subnet_id="string",
        name="string")
    
    const storeVirtualNetworkRuleResource = new azure.datalake.StoreVirtualNetworkRule("storeVirtualNetworkRuleResource", {
        accountName: "string",
        resourceGroupName: "string",
        subnetId: "string",
        name: "string",
    });
    
    type: azure:datalake:StoreVirtualNetworkRule
    properties:
        accountName: string
        name: string
        resourceGroupName: string
        subnetId: string
    

    StoreVirtualNetworkRule 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 StoreVirtualNetworkRule resource accepts the following input properties:

    AccountName string
    The name of the Data Lake Store to which this Data Lake Store virtual network rule will be applied to. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group where the Data Lake Store resides. Changing this forces a new resource to be created.
    SubnetId string
    The ID of the subnet that the Data Lake Store will be connected to.
    Name string
    The name of the Data Lake Store virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters, underscores, periods and hyphens. Cannot start with a period, underscore or hyphen, and cannot end with a period and a hyphen.
    AccountName string
    The name of the Data Lake Store to which this Data Lake Store virtual network rule will be applied to. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group where the Data Lake Store resides. Changing this forces a new resource to be created.
    SubnetId string
    The ID of the subnet that the Data Lake Store will be connected to.
    Name string
    The name of the Data Lake Store virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters, underscores, periods and hyphens. Cannot start with a period, underscore or hyphen, and cannot end with a period and a hyphen.
    accountName String
    The name of the Data Lake Store to which this Data Lake Store virtual network rule will be applied to. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group where the Data Lake Store resides. Changing this forces a new resource to be created.
    subnetId String
    The ID of the subnet that the Data Lake Store will be connected to.
    name String
    The name of the Data Lake Store virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters, underscores, periods and hyphens. Cannot start with a period, underscore or hyphen, and cannot end with a period and a hyphen.
    accountName string
    The name of the Data Lake Store to which this Data Lake Store virtual network rule will be applied to. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group where the Data Lake Store resides. Changing this forces a new resource to be created.
    subnetId string
    The ID of the subnet that the Data Lake Store will be connected to.
    name string
    The name of the Data Lake Store virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters, underscores, periods and hyphens. Cannot start with a period, underscore or hyphen, and cannot end with a period and a hyphen.
    account_name str
    The name of the Data Lake Store to which this Data Lake Store virtual network rule will be applied to. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group where the Data Lake Store resides. Changing this forces a new resource to be created.
    subnet_id str
    The ID of the subnet that the Data Lake Store will be connected to.
    name str
    The name of the Data Lake Store virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters, underscores, periods and hyphens. Cannot start with a period, underscore or hyphen, and cannot end with a period and a hyphen.
    accountName String
    The name of the Data Lake Store to which this Data Lake Store virtual network rule will be applied to. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group where the Data Lake Store resides. Changing this forces a new resource to be created.
    subnetId String
    The ID of the subnet that the Data Lake Store will be connected to.
    name String
    The name of the Data Lake Store virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters, underscores, periods and hyphens. Cannot start with a period, underscore or hyphen, and cannot end with a period and a hyphen.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StoreVirtualNetworkRule resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing StoreVirtualNetworkRule Resource

    Get an existing StoreVirtualNetworkRule 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?: StoreVirtualNetworkRuleState, opts?: CustomResourceOptions): StoreVirtualNetworkRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_name: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            subnet_id: Optional[str] = None) -> StoreVirtualNetworkRule
    func GetStoreVirtualNetworkRule(ctx *Context, name string, id IDInput, state *StoreVirtualNetworkRuleState, opts ...ResourceOption) (*StoreVirtualNetworkRule, error)
    public static StoreVirtualNetworkRule Get(string name, Input<string> id, StoreVirtualNetworkRuleState? state, CustomResourceOptions? opts = null)
    public static StoreVirtualNetworkRule get(String name, Output<String> id, StoreVirtualNetworkRuleState state, CustomResourceOptions options)
    resources:  _:    type: azure:datalake:StoreVirtualNetworkRule    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 Data Lake Store to which this Data Lake Store virtual network rule will be applied to. Changing this forces a new resource to be created.
    Name string
    The name of the Data Lake Store virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters, underscores, periods and hyphens. Cannot start with a period, underscore or hyphen, and cannot end with a period and a hyphen.
    ResourceGroupName string
    The name of the resource group where the Data Lake Store resides. Changing this forces a new resource to be created.
    SubnetId string
    The ID of the subnet that the Data Lake Store will be connected to.
    AccountName string
    The name of the Data Lake Store to which this Data Lake Store virtual network rule will be applied to. Changing this forces a new resource to be created.
    Name string
    The name of the Data Lake Store virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters, underscores, periods and hyphens. Cannot start with a period, underscore or hyphen, and cannot end with a period and a hyphen.
    ResourceGroupName string
    The name of the resource group where the Data Lake Store resides. Changing this forces a new resource to be created.
    SubnetId string
    The ID of the subnet that the Data Lake Store will be connected to.
    accountName String
    The name of the Data Lake Store to which this Data Lake Store virtual network rule will be applied to. Changing this forces a new resource to be created.
    name String
    The name of the Data Lake Store virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters, underscores, periods and hyphens. Cannot start with a period, underscore or hyphen, and cannot end with a period and a hyphen.
    resourceGroupName String
    The name of the resource group where the Data Lake Store resides. Changing this forces a new resource to be created.
    subnetId String
    The ID of the subnet that the Data Lake Store will be connected to.
    accountName string
    The name of the Data Lake Store to which this Data Lake Store virtual network rule will be applied to. Changing this forces a new resource to be created.
    name string
    The name of the Data Lake Store virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters, underscores, periods and hyphens. Cannot start with a period, underscore or hyphen, and cannot end with a period and a hyphen.
    resourceGroupName string
    The name of the resource group where the Data Lake Store resides. Changing this forces a new resource to be created.
    subnetId string
    The ID of the subnet that the Data Lake Store will be connected to.
    account_name str
    The name of the Data Lake Store to which this Data Lake Store virtual network rule will be applied to. Changing this forces a new resource to be created.
    name str
    The name of the Data Lake Store virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters, underscores, periods and hyphens. Cannot start with a period, underscore or hyphen, and cannot end with a period and a hyphen.
    resource_group_name str
    The name of the resource group where the Data Lake Store resides. Changing this forces a new resource to be created.
    subnet_id str
    The ID of the subnet that the Data Lake Store will be connected to.
    accountName String
    The name of the Data Lake Store to which this Data Lake Store virtual network rule will be applied to. Changing this forces a new resource to be created.
    name String
    The name of the Data Lake Store virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters, underscores, periods and hyphens. Cannot start with a period, underscore or hyphen, and cannot end with a period and a hyphen.
    resourceGroupName String
    The name of the resource group where the Data Lake Store resides. Changing this forces a new resource to be created.
    subnetId String
    The ID of the subnet that the Data Lake Store will be connected to.

    Import

    Data Lake Store Virtual Network Rules can be imported using the resource id, e.g.

     $ pulumi import azure:datalake/storeVirtualNetworkRule:StoreVirtualNetworkRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.DataLakeStore/accounts/myaccount/virtualNetworkRules/vnetrulename
    

    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.