Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. VirtualHub

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure

azure.network.VirtualHub

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Virtual Hub within a Virtual WAN.

    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 exampleVirtualWan = new azure.network.VirtualWan("example", {
    name: "example-virtualwan",
    resourceGroupName: example.name,
    location: example.location,
});
const exampleVirtualHub = new azure.network.VirtualHub("example", {
    name: "example-virtualhub",
    resourceGroupName: example.name,
    location: example.location,
    virtualWanId: exampleVirtualWan.id,
    addressPrefix: "10.0.0.0/23",
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_virtual_wan = azure.network.VirtualWan("example",
    name="example-virtualwan",
    resource_group_name=example.name,
    location=example.location)
example_virtual_hub = azure.network.VirtualHub("example",
    name="example-virtualhub",
    resource_group_name=example.name,
    location=example.location,
    virtual_wan_id=example_virtual_wan.id,
    address_prefix="10.0.0.0/23")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/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
		}
		exampleVirtualWan, err := network.NewVirtualWan(ctx, "example", &network.VirtualWanArgs{
			Name:              pulumi.String("example-virtualwan"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
		})
		if err != nil {
			return err
		}
		_, err = network.NewVirtualHub(ctx, "example", &network.VirtualHubArgs{
			Name:              pulumi.String("example-virtualhub"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			VirtualWanId:      exampleVirtualWan.ID(),
			AddressPrefix:     pulumi.String("10.0.0.0/23"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 exampleVirtualWan = new Azure.Network.VirtualWan("example", new()
    {
        Name = "example-virtualwan",
        ResourceGroupName = example.Name,
        Location = example.Location,
    });

    var exampleVirtualHub = new Azure.Network.VirtualHub("example", new()
    {
        Name = "example-virtualhub",
        ResourceGroupName = example.Name,
        Location = example.Location,
        VirtualWanId = exampleVirtualWan.Id,
        AddressPrefix = "10.0.0.0/23",
    });

});

    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.VirtualWan;
import com.pulumi.azure.network.VirtualWanArgs;
import com.pulumi.azure.network.VirtualHub;
import com.pulumi.azure.network.VirtualHubArgs;
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 exampleVirtualWan = new VirtualWan("exampleVirtualWan", VirtualWanArgs.builder()        
            .name("example-virtualwan")
            .resourceGroupName(example.name())
            .location(example.location())
            .build());

        var exampleVirtualHub = new VirtualHub("exampleVirtualHub", VirtualHubArgs.builder()        
            .name("example-virtualhub")
            .resourceGroupName(example.name())
            .location(example.location())
            .virtualWanId(exampleVirtualWan.id())
            .addressPrefix("10.0.0.0/23")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleVirtualWan:
    type: azure:network:VirtualWan
    name: example
    properties:
      name: example-virtualwan
      resourceGroupName: ${example.name}
      location: ${example.location}
  exampleVirtualHub:
    type: azure:network:VirtualHub
    name: example
    properties:
      name: example-virtualhub
      resourceGroupName: ${example.name}
      location: ${example.location}
      virtualWanId: ${exampleVirtualWan.id}
      addressPrefix: 10.0.0.0/23

    Create VirtualHub Resource

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

    Constructor syntax

    new VirtualHub(name: string, args: VirtualHubArgs, opts?: CustomResourceOptions);
    @overload
def VirtualHub(resource_name: str,
               args: VirtualHubArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def VirtualHub(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               resource_group_name: Optional[str] = None,
               address_prefix: Optional[str] = None,
               hub_routing_preference: Optional[str] = None,
               location: Optional[str] = None,
               name: Optional[str] = None,
               routes: Optional[Sequence[VirtualHubRouteArgs]] = None,
               sku: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               virtual_router_auto_scale_min_capacity: Optional[int] = None,
               virtual_wan_id: Optional[str] = None)
    func NewVirtualHub(ctx *Context, name string, args VirtualHubArgs, opts ...ResourceOption) (*VirtualHub, error)
    public VirtualHub(string name, VirtualHubArgs args, CustomResourceOptions? opts = null)
    public VirtualHub(String name, VirtualHubArgs args)
public VirtualHub(String name, VirtualHubArgs args, CustomResourceOptions options)

    type: azure:network:VirtualHub
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 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.
    args VirtualHubArgs
    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 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.
    name String
    The unique name of the resource.
    args VirtualHubArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var virtualHubResource = new Azure.Network.VirtualHub("virtualHubResource", new()
{
    ResourceGroupName = "string",
    AddressPrefix = "string",
    HubRoutingPreference = "string",
    Location = "string",
    Name = "string",
    Routes = new[]
    {
        new Azure.Network.Inputs.VirtualHubRouteArgs
        {
            AddressPrefixes = new[]
            {
                "string",
            },
            NextHopIpAddress = "string",
        },
    },
    Sku = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VirtualRouterAutoScaleMinCapacity = 0,
    VirtualWanId = "string",
});

    example, err := network.NewVirtualHub(ctx, "virtualHubResource", &network.VirtualHubArgs{
	ResourceGroupName:    pulumi.String("string"),
	AddressPrefix:        pulumi.String("string"),
	HubRoutingPreference: pulumi.String("string"),
	Location:             pulumi.String("string"),
	Name:                 pulumi.String("string"),
	Routes: network.VirtualHubRouteArray{
		&network.VirtualHubRouteArgs{
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("string"),
			},
			NextHopIpAddress: pulumi.String("string"),
		},
	},
	Sku: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VirtualRouterAutoScaleMinCapacity: pulumi.Int(0),
	VirtualWanId:                      pulumi.String("string"),
})

    var virtualHubResource = new VirtualHub("virtualHubResource", VirtualHubArgs.builder()        
    .resourceGroupName("string")
    .addressPrefix("string")
    .hubRoutingPreference("string")
    .location("string")
    .name("string")
    .routes(VirtualHubRouteArgs.builder()
        .addressPrefixes("string")
        .nextHopIpAddress("string")
        .build())
    .sku("string")
    .tags(Map.of("string", "string"))
    .virtualRouterAutoScaleMinCapacity(0)
    .virtualWanId("string")
    .build());

    virtual_hub_resource = azure.network.VirtualHub("virtualHubResource",
    resource_group_name="string",
    address_prefix="string",
    hub_routing_preference="string",
    location="string",
    name="string",
    routes=[azure.network.VirtualHubRouteArgs(
        address_prefixes=["string"],
        next_hop_ip_address="string",
    )],
    sku="string",
    tags={
        "string": "string",
    },
    virtual_router_auto_scale_min_capacity=0,
    virtual_wan_id="string")

    const virtualHubResource = new azure.network.VirtualHub("virtualHubResource", {
    resourceGroupName: "string",
    addressPrefix: "string",
    hubRoutingPreference: "string",
    location: "string",
    name: "string",
    routes: [{
        addressPrefixes: ["string"],
        nextHopIpAddress: "string",
    }],
    sku: "string",
    tags: {
        string: "string",
    },
    virtualRouterAutoScaleMinCapacity: 0,
    virtualWanId: "string",
});

    type: azure:network:VirtualHub
properties:
    addressPrefix: string
    hubRoutingPreference: string
    location: string
    name: string
    resourceGroupName: string
    routes:
        - addressPrefixes:
            - string
          nextHopIpAddress: string
    sku: string
    tags:
        string: string
    virtualRouterAutoScaleMinCapacity: 0
    virtualWanId: string

    VirtualHub Resource Properties

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

    Inputs

    The VirtualHub resource accepts the following input properties:

    ResourceGroupName string
    Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created.
    AddressPrefix string
    The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. The address prefix subnet cannot be smaller than a /24. Azure recommends using a /23.
    HubRoutingPreference string
    The hub routing preference. Possible values are ExpressRoute, ASPath and VpnGateway. Defaults to ExpressRoute.
    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<VirtualHubRoute>
    One or more route blocks as defined below.
    Sku string
    The SKU of the Virtual Hub. Possible values are Basic and Standard. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the Virtual Hub.
    VirtualRouterAutoScaleMinCapacity int
    Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
    VirtualWanId string
    The ID of a Virtual WAN within which the Virtual Hub should be created. 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.
    AddressPrefix string
    The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. The address prefix subnet cannot be smaller than a /24. Azure recommends using a /23.
    HubRoutingPreference string
    The hub routing preference. Possible values are ExpressRoute, ASPath and VpnGateway. Defaults to ExpressRoute.
    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 []VirtualHubRouteArgs
    One or more route blocks as defined below.
    Sku string
    The SKU of the Virtual Hub. Possible values are Basic and Standard. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the Virtual Hub.
    VirtualRouterAutoScaleMinCapacity int
    Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
    VirtualWanId string
    The ID of a Virtual WAN within which the Virtual Hub should be created. 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.
    addressPrefix String
    The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. The address prefix subnet cannot be smaller than a /24. Azure recommends using a /23.
    hubRoutingPreference String
    The hub routing preference. Possible values are ExpressRoute, ASPath and VpnGateway. Defaults to ExpressRoute.
    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<VirtualHubRoute>
    One or more route blocks as defined below.
    sku String
    The SKU of the Virtual Hub. Possible values are Basic and Standard. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the Virtual Hub.
    virtualRouterAutoScaleMinCapacity Integer
    Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
    virtualWanId String
    The ID of a Virtual WAN within which the Virtual Hub should be created. 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.
    addressPrefix string
    The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. The address prefix subnet cannot be smaller than a /24. Azure recommends using a /23.
    hubRoutingPreference string
    The hub routing preference. Possible values are ExpressRoute, ASPath and VpnGateway. Defaults to ExpressRoute.
    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.
    sku string
    The SKU of the Virtual Hub. Possible values are Basic and Standard. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the Virtual Hub.
    virtualRouterAutoScaleMinCapacity number
    Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
    virtualWanId string
    The ID of a Virtual WAN within which the Virtual Hub should be created. 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.
    address_prefix str
    The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. The address prefix subnet cannot be smaller than a /24. Azure recommends using a /23.
    hub_routing_preference str
    The hub routing preference. Possible values are ExpressRoute, ASPath and VpnGateway. Defaults to ExpressRoute.
    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 Sequence[VirtualHubRouteArgs]
    One or more route blocks as defined below.
    sku str
    The SKU of the Virtual Hub. Possible values are Basic and Standard. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the Virtual Hub.
    virtual_router_auto_scale_min_capacity int
    Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
    virtual_wan_id str
    The ID of a Virtual WAN within which the Virtual Hub should be created. 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.
    addressPrefix String
    The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. The address prefix subnet cannot be smaller than a /24. Azure recommends using a /23.
    hubRoutingPreference String
    The hub routing preference. Possible values are ExpressRoute, ASPath and VpnGateway. Defaults to ExpressRoute.
    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<Property Map>
    One or more route blocks as defined below.
    sku String
    The SKU of the Virtual Hub. Possible values are Basic and Standard. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the Virtual Hub.
    virtualRouterAutoScaleMinCapacity Number
    Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
    virtualWanId String
    The ID of a Virtual WAN within which the Virtual Hub should be created. Changing this forces a new resource to be created.

    Outputs

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

    DefaultRouteTableId string
    The ID of the default Route Table in the Virtual Hub.
    Id string
    The provider-assigned unique ID for this managed resource.
    VirtualRouterAsn int
    The Autonomous System Number of the Virtual Hub BGP router.
    VirtualRouterIps List<string>
    The IP addresses of the Virtual Hub BGP router.
    DefaultRouteTableId string
    The ID of the default Route Table in the Virtual Hub.
    Id string
    The provider-assigned unique ID for this managed resource.
    VirtualRouterAsn int
    The Autonomous System Number of the Virtual Hub BGP router.
    VirtualRouterIps []string
    The IP addresses of the Virtual Hub BGP router.
    defaultRouteTableId String
    The ID of the default Route Table in the Virtual Hub.
    id String
    The provider-assigned unique ID for this managed resource.
    virtualRouterAsn Integer
    The Autonomous System Number of the Virtual Hub BGP router.
    virtualRouterIps List<String>
    The IP addresses of the Virtual Hub BGP router.
    defaultRouteTableId string
    The ID of the default Route Table in the Virtual Hub.
    id string
    The provider-assigned unique ID for this managed resource.
    virtualRouterAsn number
    The Autonomous System Number of the Virtual Hub BGP router.
    virtualRouterIps string[]
    The IP addresses of the Virtual Hub BGP router.
    default_route_table_id str
    The ID of the default Route Table in the Virtual Hub.
    id str
    The provider-assigned unique ID for this managed resource.
    virtual_router_asn int
    The Autonomous System Number of the Virtual Hub BGP router.
    virtual_router_ips Sequence[str]
    The IP addresses of the Virtual Hub BGP router.
    defaultRouteTableId String
    The ID of the default Route Table in the Virtual Hub.
    id String
    The provider-assigned unique ID for this managed resource.
    virtualRouterAsn Number
    The Autonomous System Number of the Virtual Hub BGP router.
    virtualRouterIps List<String>
    The IP addresses of the Virtual Hub BGP router.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_prefix: Optional[str] = None,
        default_route_table_id: Optional[str] = None,
        hub_routing_preference: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        routes: Optional[Sequence[VirtualHubRouteArgs]] = None,
        sku: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        virtual_router_asn: Optional[int] = None,
        virtual_router_auto_scale_min_capacity: Optional[int] = None,
        virtual_router_ips: Optional[Sequence[str]] = None,
        virtual_wan_id: Optional[str] = None) -> VirtualHub
    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)
    public static VirtualHub get(String name, Output<String> id, VirtualHubState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AddressPrefix string
    The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. The address prefix subnet cannot be smaller than a /24. Azure recommends using a /23.
    DefaultRouteTableId string
    The ID of the default Route Table in the Virtual Hub.
    HubRoutingPreference string
    The hub routing preference. Possible values are ExpressRoute, ASPath and VpnGateway. Defaults to ExpressRoute.
    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<VirtualHubRoute>
    One or more route blocks as defined below.
    Sku string
    The SKU of the Virtual Hub. Possible values are Basic and Standard. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the Virtual Hub.
    VirtualRouterAsn int
    The Autonomous System Number of the Virtual Hub BGP router.
    VirtualRouterAutoScaleMinCapacity int
    Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
    VirtualRouterIps List<string>
    The IP addresses of the Virtual Hub BGP router.
    VirtualWanId string
    The ID of a Virtual WAN within which the Virtual Hub should be created. Changing this forces a new resource to be created.
    AddressPrefix string
    The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. The address prefix subnet cannot be smaller than a /24. Azure recommends using a /23.
    DefaultRouteTableId string
    The ID of the default Route Table in the Virtual Hub.
    HubRoutingPreference string
    The hub routing preference. Possible values are ExpressRoute, ASPath and VpnGateway. Defaults to ExpressRoute.
    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 []VirtualHubRouteArgs
    One or more route blocks as defined below.
    Sku string
    The SKU of the Virtual Hub. Possible values are Basic and Standard. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the Virtual Hub.
    VirtualRouterAsn int
    The Autonomous System Number of the Virtual Hub BGP router.
    VirtualRouterAutoScaleMinCapacity int
    Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
    VirtualRouterIps []string
    The IP addresses of the Virtual Hub BGP router.
    VirtualWanId string
    The ID of a Virtual WAN within which the Virtual Hub should be created. Changing this forces a new resource to be created.
    addressPrefix String
    The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. The address prefix subnet cannot be smaller than a /24. Azure recommends using a /23.
    defaultRouteTableId String
    The ID of the default Route Table in the Virtual Hub.
    hubRoutingPreference String
    The hub routing preference. Possible values are ExpressRoute, ASPath and VpnGateway. Defaults to ExpressRoute.
    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<VirtualHubRoute>
    One or more route blocks as defined below.
    sku String
    The SKU of the Virtual Hub. Possible values are Basic and Standard. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the Virtual Hub.
    virtualRouterAsn Integer
    The Autonomous System Number of the Virtual Hub BGP router.
    virtualRouterAutoScaleMinCapacity Integer
    Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
    virtualRouterIps List<String>
    The IP addresses of the Virtual Hub BGP router.
    virtualWanId String
    The ID of a Virtual WAN within which the Virtual Hub should be created. Changing this forces a new resource to be created.
    addressPrefix string
    The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. The address prefix subnet cannot be smaller than a /24. Azure recommends using a /23.
    defaultRouteTableId string
    The ID of the default Route Table in the Virtual Hub.
    hubRoutingPreference string
    The hub routing preference. Possible values are ExpressRoute, ASPath and VpnGateway. Defaults to ExpressRoute.
    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.
    sku string
    The SKU of the Virtual Hub. Possible values are Basic and Standard. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the Virtual Hub.
    virtualRouterAsn number
    The Autonomous System Number of the Virtual Hub BGP router.
    virtualRouterAutoScaleMinCapacity number
    Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
    virtualRouterIps string[]
    The IP addresses of the Virtual Hub BGP router.
    virtualWanId string
    The ID of a Virtual WAN within which the Virtual Hub should be created. Changing this forces a new resource to be created.
    address_prefix str
    The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. The address prefix subnet cannot be smaller than a /24. Azure recommends using a /23.
    default_route_table_id str
    The ID of the default Route Table in the Virtual Hub.
    hub_routing_preference str
    The hub routing preference. Possible values are ExpressRoute, ASPath and VpnGateway. Defaults to ExpressRoute.
    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 Sequence[VirtualHubRouteArgs]
    One or more route blocks as defined below.
    sku str
    The SKU of the Virtual Hub. Possible values are Basic and Standard. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the Virtual Hub.
    virtual_router_asn int
    The Autonomous System Number of the Virtual Hub BGP router.
    virtual_router_auto_scale_min_capacity int
    Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
    virtual_router_ips Sequence[str]
    The IP addresses of the Virtual Hub BGP router.
    virtual_wan_id str
    The ID of a Virtual WAN within which the Virtual Hub should be created. Changing this forces a new resource to be created.
    addressPrefix String
    The Address Prefix which should be used for this Virtual Hub. Changing this forces a new resource to be created. The address prefix subnet cannot be smaller than a /24. Azure recommends using a /23.
    defaultRouteTableId String
    The ID of the default Route Table in the Virtual Hub.
    hubRoutingPreference String
    The hub routing preference. Possible values are ExpressRoute, ASPath and VpnGateway. Defaults to ExpressRoute.
    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<Property Map>
    One or more route blocks as defined below.
    sku String
    The SKU of the Virtual Hub. Possible values are Basic and Standard. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the Virtual Hub.
    virtualRouterAsn Number
    The Autonomous System Number of the Virtual Hub BGP router.
    virtualRouterAutoScaleMinCapacity Number
    Minimum instance capacity for the scaling configuration of the Virtual Hub Router.
    virtualRouterIps List<String>
    The IP addresses of the Virtual Hub BGP router.
    virtualWanId String
    The ID of a Virtual WAN within which the Virtual Hub should be created. Changing this forces a new resource to be created.

    Supporting Types

    VirtualHubRoute, VirtualHubRouteArgs

    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 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.
    address_prefixes Sequence[str]
    A list of Address Prefixes.
    next_hop_ip_address str
    The IP Address that Packets should be forwarded to as the Next Hop.
    addressPrefixes List<String>
    A list of Address Prefixes.
    nextHopIpAddress String
    The IP Address that Packets should be forwarded to as the Next Hop.

    Import

    Virtual Hub’s can be imported using the resource id, e.g.

    $ pulumi import azure:network/virtualHub:VirtualHub example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/virtualHubs/hub1

    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.

    Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-azure