pulumi-azure-kotlin/com.pulumi.azure.network.kotlin/VirtualNetwork

VirtualNetwork

class VirtualNetwork : KotlinCustomResource

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. NOTE on Virtual Networks and DNS Servers: This provider currently provides both a standalone virtual network DNS Servers resource, and allows for DNS servers to be defined in-line within the Virtual Network resource. At this time you cannot use a Virtual Network with in-line DNS servers in conjunction with any Virtual Network DNS Servers resources. Doing so will cause a conflict of Virtual Network DNS Servers configurations and will overwrite virtual networks DNS servers.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleNetworkSecurityGroup = new azure.network.NetworkSecurityGroup("example", {
    name: "example-security-group",
    location: example.location,
    resourceGroupName: example.name,
});
const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
    name: "example-network",
    location: example.location,
    resourceGroupName: example.name,
    addressSpaces: ["10&#46;0&#46;0&#46;0/16"],
    dnsServers: [
        "10.0.0.4",
        "10.0.0.5",
    ],
    subnets: [
        {
            name: "subnet1",
            addressPrefixes: ["10&#46;0&#46;1&#46;0/24"],
        },
        {
            name: "subnet2",
            addressPrefixes: ["10&#46;0&#46;2&#46;0/24"],
            securityGroup: exampleNetworkSecurityGroup.id,
        },
    ],
    tags: {
        environment: "Production",
    },
});

import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_network_security_group = azure.network.NetworkSecurityGroup("example",
    name="example-security-group",
    location=example.location,
    resource_group_name=example.name)
example_virtual_network = azure.network.VirtualNetwork("example",
    name="example-network",
    location=example.location,
    resource_group_name=example.name,
    address_spaces=["10&#46;0&#46;0&#46;0/16"],
    dns_servers=[
        "10.0.0.4",
        "10.0.0.5",
    ],
    subnets=[
        {
            "name": "subnet1",
            "address_prefixes": ["10&#46;0&#46;1&#46;0/24"],
        },
        {
            "name": "subnet2",
            "address_prefixes": ["10&#46;0&#46;2&#46;0/24"],
            "security_group": example_network_security_group.id,
        },
    ],
    tags={
        "environment": "Production",
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });
    var exampleNetworkSecurityGroup = new Azure.Network.NetworkSecurityGroup("example", new()
    {
        Name = "example-security-group",
        Location = example.Location,
        ResourceGroupName = example.Name,
    });
    var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
    {
        Name = "example-network",
        Location = example.Location,
        ResourceGroupName = example.Name,
        AddressSpaces = new[]
        {
            "10.0.0.0/16",
        },
        DnsServers = new[]
        {
            "10.0.0.4",
            "10.0.0.5",
        },
        Subnets = new[]
        {
            new Azure.Network.Inputs.VirtualNetworkSubnetArgs
            {
                Name = "subnet1",
                AddressPrefixes = new[]
                {
                    "10.0.1.0/24",
                },
            },
            new Azure.Network.Inputs.VirtualNetworkSubnetArgs
            {
                Name = "subnet2",
                AddressPrefixes = new[]
                {
                    "10.0.2.0/24",
                },
                SecurityGroup = exampleNetworkSecurityGroup.Id,
            },
        },
        Tags =
        {
            { "environment", "Production" },
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleNetworkSecurityGroup, err := network.NewNetworkSecurityGroup(ctx, "example", &network.NetworkSecurityGroupArgs{
			Name:              pulumi.String("example-security-group"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		_, err = network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
			Name:              pulumi.String("example-network"),
			Location:          example.Location,
			ResourceGroupName: example.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"),
			},
			Subnets: network.VirtualNetworkSubnetArray{
				&network.VirtualNetworkSubnetArgs{
					Name: pulumi.String("subnet1"),
					AddressPrefixes: pulumi.StringArray{
						pulumi.String("10.0.1.0/24"),
					},
				},
				&network.VirtualNetworkSubnetArgs{
					Name: pulumi.String("subnet2"),
					AddressPrefixes: pulumi.StringArray{
						pulumi.String("10.0.2.0/24"),
					},
					SecurityGroup: exampleNetworkSecurityGroup.ID(),
				},
			},
			Tags: pulumi.StringMap{
				"environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.network.NetworkSecurityGroup;
import com.pulumi.azure.network.NetworkSecurityGroupArgs;
import com.pulumi.azure.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.inputs.VirtualNetworkSubnetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());
        var exampleNetworkSecurityGroup = new NetworkSecurityGroup("exampleNetworkSecurityGroup", NetworkSecurityGroupArgs.builder()
            .name("example-security-group")
            .location(example.location())
            .resourceGroupName(example.name())
            .build());
        var exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .name("example-network")
            .location(example.location())
            .resourceGroupName(example.name())
            .addressSpaces("10.0.0.0/16")
            .dnsServers(
                "10.0.0.4",
                "10.0.0.5")
            .subnets(
                VirtualNetworkSubnetArgs.builder()
                    .name("subnet1")
                    .addressPrefixes("10.0.1.0/24")
                    .build(),
                VirtualNetworkSubnetArgs.builder()
                    .name("subnet2")
                    .addressPrefixes("10.0.2.0/24")
                    .securityGroup(exampleNetworkSecurityGroup.id())
                    .build())
            .tags(Map.of("environment", "Production"))
            .build());
    }
}

resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleNetworkSecurityGroup:
    type: azure:network:NetworkSecurityGroup
    name: example
    properties:
      name: example-security-group
      location: ${example.location}
      resourceGroupName: ${example.name}
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    name: example
    properties:
      name: example-network
      location: ${example.location}
      resourceGroupName: ${example.name}
      addressSpaces:
        - 10.0.0.0/16
      dnsServers:
        - 10.0.0.4
        - 10.0.0.5
      subnets:
        - name: subnet1
          addressPrefixes:
            - 10.0.1.0/24
        - name: subnet2
          addressPrefixes:
            - 10.0.2.0/24
          securityGroup: ${exampleNetworkSecurityGroup.id}
      tags:
        environment: Production

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

Properties

addressSpaces

val addressSpaces: Output<List<String>>

The address space that is used the virtual network. You can supply more than one address space.

bgpCommunity

val bgpCommunity: Output<String>?

The BGP community attribute in format <as-number>:<community-value>.

ddosProtectionPlan

val ddosProtectionPlan: Output<VirtualNetworkDdosProtectionPlan>?

A ddos_protection_plan block as documented below.

dnsServers

val dnsServers: Output<List<String>>

List of IP addresses of DNS servers

edgeZone

val edgeZone: Output<String>?

Specifies the Edge Zone within the Azure Region where this Virtual Network should exist. Changing this forces a new Virtual Network to be created.

encryption

val encryption: Output<VirtualNetworkEncryption>?

A encryption block as defined below.

flowTimeoutInMinutes

val flowTimeoutInMinutes: Output<Int>?

The flow timeout in minutes for the Virtual Network, which is used to enable connection tracking for intra-VM flows. Possible values are between 4 and 30 minutes.

guid

val guid: Output<String>

The GUID of the virtual network.

val id: Output<String>

location

val location: Output<String>

The location/region where the virtual network is created. Changing this forces a new resource to be created.

name

val name: Output<String>

The name of the virtual network. Changing this forces a new resource to be created.

privateEndpointVnetPolicies

val privateEndpointVnetPolicies: Output<String>?

The Private Endpoint VNet Policies for the Virtual Network. Possible values are Disabled and Basic. Defaults to Disabled.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

resourceGroupName

val resourceGroupName: Output<String>

The name of the resource group in which to create the virtual network. Changing this forces a new resource to be created.

subnets

val subnets: Output<List<VirtualNetworkSubnet>>

Can be specified multiple times to define multiple subnets. Each subnet block supports fields documented below.