VirtualNetwork

Manages a virtual network including any configured subnets. Each subnet can optionally be configured with a security group to be associated with the subnet.

NOTE on Virtual Networks and Subnet’s: This provider currently provides both a standalone Subnet resource, and allows for Subnets to be defined in-line within the Virtual Network resource. At this time you cannot use a Virtual Network with in-line Subnets in conjunction with any Subnet resources. Doing so will cause a conflict of Subnet configurations and will overwrite Subnet’s.

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 = "West Europe",
        });
        var exampleNetworkSecurityGroup = new Azure.Network.NetworkSecurityGroup("exampleNetworkSecurityGroup", new Azure.Network.NetworkSecurityGroupArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
        });
        var exampleDdosProtectionPlan = new Azure.Network.DdosProtectionPlan("exampleDdosProtectionPlan", new Azure.Network.DdosProtectionPlanArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
        });
        var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new Azure.Network.VirtualNetworkArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            AddressSpaces = 
            {
                "10.0.0.0/16",
            },
            DnsServers = 
            {
                "10.0.0.4",
                "10.0.0.5",
            },
            DdosProtectionPlan = new Azure.Network.Inputs.VirtualNetworkDdosProtectionPlanArgs
            {
                Id = exampleDdosProtectionPlan.Id,
                Enable = true,
            },
            Subnets = 
            {
                new Azure.Network.Inputs.VirtualNetworkSubnetArgs
                {
                    Name = "subnet1",
                    AddressPrefix = "10.0.1.0/24",
                },
                new Azure.Network.Inputs.VirtualNetworkSubnetArgs
                {
                    Name = "subnet2",
                    AddressPrefix = "10.0.2.0/24",
                },
                new Azure.Network.Inputs.VirtualNetworkSubnetArgs
                {
                    Name = "subnet3",
                    AddressPrefix = "10.0.3.0/24",
                    SecurityGroup = exampleNetworkSecurityGroup.Id,
                },
            },
            Tags = 
            {
                { "environment", "Production" },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"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
		}
		exampleNetworkSecurityGroup, err := network.NewNetworkSecurityGroup(ctx, "exampleNetworkSecurityGroup", &network.NetworkSecurityGroupArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		exampleDdosProtectionPlan, err := network.NewDdosProtectionPlan(ctx, "exampleDdosProtectionPlan", &network.DdosProtectionPlanArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		_, err = network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			AddressSpaces: pulumi.StringArray{
				pulumi.String("10.0.0.0/16"),
			},
			DnsServers: pulumi.StringArray{
				pulumi.String("10.0.0.4"),
				pulumi.String("10.0.0.5"),
			},
			DdosProtectionPlan: &network.VirtualNetworkDdosProtectionPlanArgs{
				Id:     exampleDdosProtectionPlan.ID(),
				Enable: pulumi.Bool(true),
			},
			Subnets: network.VirtualNetworkSubnetArray{
				&network.VirtualNetworkSubnetArgs{
					Name:          pulumi.String("subnet1"),
					AddressPrefix: pulumi.String("10.0.1.0/24"),
				},
				&network.VirtualNetworkSubnetArgs{
					Name:          pulumi.String("subnet2"),
					AddressPrefix: pulumi.String("10.0.2.0/24"),
				},
				&network.VirtualNetworkSubnetArgs{
					Name:          pulumi.String("subnet3"),
					AddressPrefix: pulumi.String("10.0.3.0/24"),
					SecurityGroup: exampleNetworkSecurityGroup.ID(),
				},
			},
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_network_security_group = azure.network.NetworkSecurityGroup("exampleNetworkSecurityGroup",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_ddos_protection_plan = azure.network.DdosProtectionPlan("exampleDdosProtectionPlan",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
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"],
    dns_servers=[
        "10.0.0.4",
        "10.0.0.5",
    ],
    ddos_protection_plan=azure.network.VirtualNetworkDdosProtectionPlanArgs(
        id=example_ddos_protection_plan.id,
        enable=True,
    ),
    subnets=[
        azure.network.VirtualNetworkSubnetArgs(
            name="subnet1",
            address_prefix="10.0.1.0/24",
        ),
        azure.network.VirtualNetworkSubnetArgs(
            name="subnet2",
            address_prefix="10.0.2.0/24",
        ),
        azure.network.VirtualNetworkSubnetArgs(
            name="subnet3",
            address_prefix="10.0.3.0/24",
            security_group=example_network_security_group.id,
        ),
    ],
    tags={
        "environment": "Production",
    })
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleNetworkSecurityGroup = new azure.network.NetworkSecurityGroup("exampleNetworkSecurityGroup", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleDdosProtectionPlan = new azure.network.DdosProtectionPlan("exampleDdosProtectionPlan", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    addressSpaces: ["10.0.0.0/16"],
    dnsServers: [
        "10.0.0.4",
        "10.0.0.5",
    ],
    ddosProtectionPlan: {
        id: exampleDdosProtectionPlan.id,
        enable: true,
    },
    subnets: [
        {
            name: "subnet1",
            addressPrefix: "10.0.1.0/24",
        },
        {
            name: "subnet2",
            addressPrefix: "10.0.2.0/24",
        },
        {
            name: "subnet3",
            addressPrefix: "10.0.3.0/24",
            securityGroup: exampleNetworkSecurityGroup.id,
        },
    ],
    tags: {
        environment: "Production",
    },
});

Create a VirtualNetwork Resource

new VirtualNetwork(name: string, args: VirtualNetworkArgs, opts?: CustomResourceOptions);
@overload
def VirtualNetwork(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   address_spaces: Optional[Sequence[str]] = None,
                   bgp_community: Optional[str] = None,
                   ddos_protection_plan: Optional[VirtualNetworkDdosProtectionPlanArgs] = None,
                   dns_servers: Optional[Sequence[str]] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   subnets: Optional[Sequence[VirtualNetworkSubnetArgs]] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   vm_protection_enabled: Optional[bool] = None)
@overload
def VirtualNetwork(resource_name: str,
                   args: VirtualNetworkArgs,
                   opts: Optional[ResourceOptions] = None)
func NewVirtualNetwork(ctx *Context, name string, args VirtualNetworkArgs, opts ...ResourceOption) (*VirtualNetwork, error)
public VirtualNetwork(string name, VirtualNetworkArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args VirtualNetworkArgs
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 VirtualNetworkArgs
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 VirtualNetworkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args VirtualNetworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

VirtualNetwork Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The VirtualNetwork resource accepts the following input properties:

AddressSpaces List<string>
The address space that is used the virtual network. You can supply more than one address space.
ResourceGroupName string
The name of the resource group in which to create the virtual network.
BgpCommunity string
The BGP community attribute in format <as-number>:<community-value>.
DdosProtectionPlan VirtualNetworkDdosProtectionPlanArgs
A ddos_protection_plan block as documented below.
DnsServers List<string>
List of IP addresses of DNS servers
Location string
The location/region where the virtual network is created. Changing this forces a new resource to be created.
Name string
The name of the virtual network. Changing this forces a new resource to be created.
Subnets List<VirtualNetworkSubnetArgs>
Can be specified multiple times to define multiple subnets. Each subnet block supports fields documented below.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
VmProtectionEnabled bool
Whether to enable VM protection for all the subnets in this Virtual Network. Defaults to false.
AddressSpaces []string
The address space that is used the virtual network. You can supply more than one address space.
ResourceGroupName string
The name of the resource group in which to create the virtual network.
BgpCommunity string
The BGP community attribute in format <as-number>:<community-value>.
DdosProtectionPlan VirtualNetworkDdosProtectionPlan
A ddos_protection_plan block as documented below.
DnsServers []string
List of IP addresses of DNS servers
Location string
The location/region where the virtual network is created. Changing this forces a new resource to be created.
Name string
The name of the virtual network. Changing this forces a new resource to be created.
Subnets []VirtualNetworkSubnet
Can be specified multiple times to define multiple subnets. Each subnet block supports fields documented below.
Tags map[string]string
A mapping of tags to assign to the resource.
VmProtectionEnabled bool
Whether to enable VM protection for all the subnets in this Virtual Network. Defaults to false.
addressSpaces string[]
The address space that is used the virtual network. You can supply more than one address space.
resourceGroupName string
The name of the resource group in which to create the virtual network.
bgpCommunity string
The BGP community attribute in format <as-number>:<community-value>.
ddosProtectionPlan VirtualNetworkDdosProtectionPlanArgs
A ddos_protection_plan block as documented below.
dnsServers string[]
List of IP addresses of DNS servers
location string
The location/region where the virtual network is created. Changing this forces a new resource to be created.
name string
The name of the virtual network. Changing this forces a new resource to be created.
subnets VirtualNetworkSubnetArgs[]
Can be specified multiple times to define multiple subnets. Each subnet block supports fields documented below.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
vmProtectionEnabled boolean
Whether to enable VM protection for all the subnets in this Virtual Network. Defaults to false.
address_spaces Sequence[str]
The address space that is used the virtual network. You can supply more than one address space.
resource_group_name str
The name of the resource group in which to create the virtual network.
bgp_community str
The BGP community attribute in format <as-number>:<community-value>.
ddos_protection_plan VirtualNetworkDdosProtectionPlanArgs
A ddos_protection_plan block as documented below.
dns_servers Sequence[str]
List of IP addresses of DNS servers
location str
The location/region where the virtual network is created. Changing this forces a new resource to be created.
name str
The name of the virtual network. Changing this forces a new resource to be created.
subnets Sequence[VirtualNetworkSubnetArgs]
Can be specified multiple times to define multiple subnets. Each subnet block supports fields documented below.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
vm_protection_enabled bool
Whether to enable VM protection for all the subnets in this Virtual Network. Defaults to false.

Outputs

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

Guid string
The GUID of the virtual network.
Id string
The provider-assigned unique ID for this managed resource.
Guid string
The GUID of the virtual network.
Id string
The provider-assigned unique ID for this managed resource.
guid string
The GUID of the virtual network.
id string
The provider-assigned unique ID for this managed resource.
guid str
The GUID of the virtual network.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing VirtualNetwork Resource

Get an existing VirtualNetwork 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?: VirtualNetworkState, opts?: CustomResourceOptions): VirtualNetwork
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_spaces: Optional[Sequence[str]] = None,
        bgp_community: Optional[str] = None,
        ddos_protection_plan: Optional[VirtualNetworkDdosProtectionPlanArgs] = None,
        dns_servers: Optional[Sequence[str]] = None,
        guid: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        subnets: Optional[Sequence[VirtualNetworkSubnetArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        vm_protection_enabled: Optional[bool] = None) -> VirtualNetwork
func GetVirtualNetwork(ctx *Context, name string, id IDInput, state *VirtualNetworkState, opts ...ResourceOption) (*VirtualNetwork, error)
public static VirtualNetwork Get(string name, Input<string> id, VirtualNetworkState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

AddressSpaces List<string>
The address space that is used the virtual network. You can supply more than one address space.
BgpCommunity string
The BGP community attribute in format <as-number>:<community-value>.
DdosProtectionPlan VirtualNetworkDdosProtectionPlanArgs
A ddos_protection_plan block as documented below.
DnsServers List<string>
List of IP addresses of DNS servers
Guid string
The GUID of the virtual network.
Location string
The location/region where the virtual network is created. Changing this forces a new resource to be created.
Name string
The name of the virtual network. Changing this forces a new resource to be created.
ResourceGroupName string
The name of the resource group in which to create the virtual network.
Subnets List<VirtualNetworkSubnetArgs>
Can be specified multiple times to define multiple subnets. Each subnet block supports fields documented below.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
VmProtectionEnabled bool
Whether to enable VM protection for all the subnets in this Virtual Network. Defaults to false.
AddressSpaces []string
The address space that is used the virtual network. You can supply more than one address space.
BgpCommunity string
The BGP community attribute in format <as-number>:<community-value>.
DdosProtectionPlan VirtualNetworkDdosProtectionPlan
A ddos_protection_plan block as documented below.
DnsServers []string
List of IP addresses of DNS servers
Guid string
The GUID of the virtual network.
Location string
The location/region where the virtual network is created. Changing this forces a new resource to be created.
Name string
The name of the virtual network. Changing this forces a new resource to be created.
ResourceGroupName string
The name of the resource group in which to create the virtual network.
Subnets []VirtualNetworkSubnet
Can be specified multiple times to define multiple subnets. Each subnet block supports fields documented below.
Tags map[string]string
A mapping of tags to assign to the resource.
VmProtectionEnabled bool
Whether to enable VM protection for all the subnets in this Virtual Network. Defaults to false.
addressSpaces string[]
The address space that is used the virtual network. You can supply more than one address space.
bgpCommunity string
The BGP community attribute in format <as-number>:<community-value>.
ddosProtectionPlan VirtualNetworkDdosProtectionPlanArgs
A ddos_protection_plan block as documented below.
dnsServers string[]
List of IP addresses of DNS servers
guid string
The GUID of the virtual network.
location string
The location/region where the virtual network is created. Changing this forces a new resource to be created.
name string
The name of the virtual network. Changing this forces a new resource to be created.
resourceGroupName string
The name of the resource group in which to create the virtual network.
subnets VirtualNetworkSubnetArgs[]
Can be specified multiple times to define multiple subnets. Each subnet block supports fields documented below.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
vmProtectionEnabled boolean
Whether to enable VM protection for all the subnets in this Virtual Network. Defaults to false.
address_spaces Sequence[str]
The address space that is used the virtual network. You can supply more than one address space.
bgp_community str
The BGP community attribute in format <as-number>:<community-value>.
ddos_protection_plan VirtualNetworkDdosProtectionPlanArgs
A ddos_protection_plan block as documented below.
dns_servers Sequence[str]
List of IP addresses of DNS servers
guid str
The GUID of the virtual network.
location str
The location/region where the virtual network is created. Changing this forces a new resource to be created.
name str
The name of the virtual network. Changing this forces a new resource to be created.
resource_group_name str
The name of the resource group in which to create the virtual network.
subnets Sequence[VirtualNetworkSubnetArgs]
Can be specified multiple times to define multiple subnets. Each subnet block supports fields documented below.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
vm_protection_enabled bool
Whether to enable VM protection for all the subnets in this Virtual Network. Defaults to false.

Supporting Types

VirtualNetworkDdosProtectionPlan

Enable bool
Enable/disable DDoS Protection Plan on Virtual Network.
Id string
The ID of DDoS Protection Plan.
Enable bool
Enable/disable DDoS Protection Plan on Virtual Network.
Id string
The ID of DDoS Protection Plan.
enable boolean
Enable/disable DDoS Protection Plan on Virtual Network.
id string
The ID of DDoS Protection Plan.
enable bool
Enable/disable DDoS Protection Plan on Virtual Network.
id str
The ID of DDoS Protection Plan.

VirtualNetworkSubnet

AddressPrefix string
The address prefix to use for the subnet.
Name string
The name of the virtual network. Changing this forces a new resource to be created.
Id string
The ID of DDoS Protection Plan.
SecurityGroup string
The Network Security Group to associate with the subnet. (Referenced by id, ie. azurerm_network_security_group.example.id)
AddressPrefix string
The address prefix to use for the subnet.
Name string
The name of the virtual network. Changing this forces a new resource to be created.
Id string
The ID of DDoS Protection Plan.
SecurityGroup string
The Network Security Group to associate with the subnet. (Referenced by id, ie. azurerm_network_security_group.example.id)
addressPrefix string
The address prefix to use for the subnet.
name string
The name of the virtual network. Changing this forces a new resource to be created.
id string
The ID of DDoS Protection Plan.
securityGroup string
The Network Security Group to associate with the subnet. (Referenced by id, ie. azurerm_network_security_group.example.id)
address_prefix str
The address prefix to use for the subnet.
name str
The name of the virtual network. Changing this forces a new resource to be created.
id str
The ID of DDoS Protection Plan.
security_group str
The Network Security Group to associate with the subnet. (Referenced by id, ie. azurerm_network_security_group.example.id)

Import

Virtual Networks can be imported using the resource id, e.g.

 $ pulumi import azure:network/virtualNetwork:VirtualNetwork exampleNetwork /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/virtualNetworks/myvnet1

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.