VirtualHub

Manages a Virtual Hub within a Virtual WAN.

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 exampleVirtualWan = new Azure.Network.VirtualWan("exampleVirtualWan", new Azure.Network.VirtualWanArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
        });
        var exampleVirtualHub = new Azure.Network.VirtualHub("exampleVirtualHub", new Azure.Network.VirtualHubArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            VirtualWanId = exampleVirtualWan.Id,
            AddressPrefix = "10.0.1.0/24",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/network"
    "github.com/pulumi/pulumi/sdk/v2/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
        }
        exampleVirtualWan, err := network.NewVirtualWan(ctx, "exampleVirtualWan", &network.VirtualWanArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            Location:          exampleResourceGroup.Location,
        })
        if err != nil {
            return err
        }
        _, err = network.NewVirtualHub(ctx, "exampleVirtualHub", &network.VirtualHubArgs{
            ResourceGroupName: exampleResourceGroup.Name,
            Location:          exampleResourceGroup.Location,
            VirtualWanId:      exampleVirtualWan.ID(),
            AddressPrefix:     pulumi.String("10.0.1.0/24"),
        })
        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_virtual_wan = azure.network.VirtualWan("exampleVirtualWan",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_virtual_hub = azure.network.VirtualHub("exampleVirtualHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    virtual_wan_id=example_virtual_wan.id,
    address_prefix="10.0.1.0/24")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleVirtualWan = new azure.network.VirtualWan("exampleVirtualWan", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleVirtualHub = new azure.network.VirtualHub("exampleVirtualHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    virtualWanId: exampleVirtualWan.id,
    addressPrefix: "10.0.1.0/24",
});

Create a VirtualHub Resource

new VirtualHub(name: string, args: VirtualHubArgs, opts?: CustomResourceOptions);

def VirtualHub(resource_name, opts=None, address_prefix=None, location=None, name=None, resource_group_name=None, routes=None, tags=None, virtual_wan_id=None, __props__=None);

func NewVirtualHub(ctx *Context, name string, args VirtualHubArgs, opts ...ResourceOption) (*VirtualHub, error)

public VirtualHub(string name, VirtualHubArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args VirtualHubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args VirtualHubArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VirtualHubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

VirtualHub Resource Properties

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

Inputs

The VirtualHub resource accepts the following input properties:

AddressPrefix string: The Address Prefix which should be used for this Virtual Hub.
ResourceGroupName string: Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.
VirtualWanId string: The ID of a Virtual WAN within which the Virtual Hub should be created.
Location string: Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.
Name string: The name of the Virtual Hub. Changing this forces a new resource to be created.
Routes List<VirtualHubRouteArgs>: One or more route blocks as defined below.
Tags Dictionary<string, string>: A mapping of tags to assign to the Virtual Hub.

AddressPrefix string: The Address Prefix which should be used for this Virtual Hub.
ResourceGroupName string: Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.
VirtualWanId string: The ID of a Virtual WAN within which the Virtual Hub should be created.
Location string: Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.
Name string: The name of the Virtual Hub. Changing this forces a new resource to be created.
Routes []VirtualHubRoute: One or more route blocks as defined below.
Tags map[string]string: A mapping of tags to assign to the Virtual Hub.

addressPrefix string: The Address Prefix which should be used for this Virtual Hub.
resourceGroupName string: Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.
virtualWanId string: The ID of a Virtual WAN within which the Virtual Hub should be created.
location string: Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.
name string: The name of the Virtual Hub. Changing this forces a new resource to be created.
routes VirtualHubRoute[]: One or more route blocks as defined below.
tags {[key: string]: string}: A mapping of tags to assign to the Virtual Hub.

address_prefix str: The Address Prefix which should be used for this Virtual Hub.
resource_group_name str: Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.
virtual_wan_id str: The ID of a Virtual WAN within which the Virtual Hub should be created.
location str: Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.
name str: The name of the Virtual Hub. Changing this forces a new resource to be created.
routes List[VirtualHubRoute]: One or more route blocks as defined below.
tags Dict[str, str]: A mapping of tags to assign to the Virtual Hub.

Outputs

All input properties are implicitly available as output properties. Additionally, the VirtualHub 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing VirtualHub Resource

Get an existing VirtualHub 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?: VirtualHubState, opts?: CustomResourceOptions): VirtualHub

static get(resource_name, id, opts=None, address_prefix=None, location=None, name=None, resource_group_name=None, routes=None, tags=None, virtual_wan_id=None, __props__=None);

func GetVirtualHub(ctx *Context, name string, id IDInput, state *VirtualHubState, opts ...ResourceOption) (*VirtualHub, error)

public static VirtualHub Get(string name, Input<string> id, VirtualHubState? 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:

AddressPrefix string: The Address Prefix which should be used for this Virtual Hub.
Location string: Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.
Name string: The name of the Virtual Hub. Changing this forces a new resource to be created.
ResourceGroupName string: Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.
Routes List<VirtualHubRouteArgs>: One or more route blocks as defined below.
Tags Dictionary<string, string>: A mapping of tags to assign to the Virtual Hub.
VirtualWanId string: The ID of a Virtual WAN within which the Virtual Hub should be created.

AddressPrefix string: The Address Prefix which should be used for this Virtual Hub.
Location string: Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.
Name string: The name of the Virtual Hub. Changing this forces a new resource to be created.
ResourceGroupName string: Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.
Routes []VirtualHubRoute: One or more route blocks as defined below.
Tags map[string]string: A mapping of tags to assign to the Virtual Hub.
VirtualWanId string: The ID of a Virtual WAN within which the Virtual Hub should be created.

addressPrefix string: The Address Prefix which should be used for this Virtual Hub.
location string: Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.
name string: The name of the Virtual Hub. Changing this forces a new resource to be created.
resourceGroupName string: Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.
routes VirtualHubRoute[]: One or more route blocks as defined below.
tags {[key: string]: string}: A mapping of tags to assign to the Virtual Hub.
virtualWanId string: The ID of a Virtual WAN within which the Virtual Hub should be created.

address_prefix str: The Address Prefix which should be used for this Virtual Hub.
location str: Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created.
name str: The name of the Virtual Hub. Changing this forces a new resource to be created.
resource_group_name str: Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.
routes List[VirtualHubRoute]: One or more route blocks as defined below.
tags Dict[str, str]: A mapping of tags to assign to the Virtual Hub.
virtual_wan_id str: The ID of a Virtual WAN within which the Virtual Hub should be created.

Supporting Types

VirtualHubRoute

See the input and output API doc for this type.

AddressPrefixes List<string>: A list of Address Prefixes.
NextHopIpAddress string: The IP Address that Packets should be forwarded to as the Next Hop.

AddressPrefixes []string: A list of Address Prefixes.
NextHopIpAddress string: The IP Address that Packets should be forwarded to as the Next Hop.

addressPrefixes string[]: A list of Address Prefixes.
nextHopIpAddress string: The IP Address that Packets should be forwarded to as the Next Hop.

address_prefixes List[str]: A list of Address Prefixes.
nextHopIpAddress str: The IP Address that Packets should be forwarded to as the Next Hop.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud