1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. VirtualHub
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.44.1 published on Thursday, Jun 6, 2024 by Pulumi

azure-native.network.VirtualHub

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.44.1 published on Thursday, Jun 6, 2024 by Pulumi

    VirtualHub Resource. Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2020-11-01.

    Other available API versions: 2018-07-01, 2020-04-01, 2020-06-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01.

    Example Usage

    VirtualHubPut

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var virtualHub = new AzureNative.Network.VirtualHub("virtualHub", new()
        {
            AddressPrefix = "10.168.0.0/24",
            Location = "West US",
            ResourceGroupName = "rg1",
            Sku = "Basic",
            Tags = 
            {
                { "key1", "value1" },
            },
            VirtualHubName = "virtualHub2",
            VirtualWan = new AzureNative.Network.Inputs.SubResourceArgs
            {
                Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1",
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/network/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := network.NewVirtualHub(ctx, "virtualHub", &network.VirtualHubArgs{
    			AddressPrefix:     pulumi.String("10.168.0.0/24"),
    			Location:          pulumi.String("West US"),
    			ResourceGroupName: pulumi.String("rg1"),
    			Sku:               pulumi.String("Basic"),
    			Tags: pulumi.StringMap{
    				"key1": pulumi.String("value1"),
    			},
    			VirtualHubName: pulumi.String("virtualHub2"),
    			VirtualWan: &network.SubResourceArgs{
    				Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"),
    			},
    		})
    		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.azurenative.network.VirtualHub;
    import com.pulumi.azurenative.network.VirtualHubArgs;
    import com.pulumi.azurenative.network.inputs.SubResourceArgs;
    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 virtualHub = new VirtualHub("virtualHub", VirtualHubArgs.builder()
                .addressPrefix("10.168.0.0/24")
                .location("West US")
                .resourceGroupName("rg1")
                .sku("Basic")
                .tags(Map.of("key1", "value1"))
                .virtualHubName("virtualHub2")
                .virtualWan(SubResourceArgs.builder()
                    .id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1")
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    virtual_hub = azure_native.network.VirtualHub("virtualHub",
        address_prefix="10.168.0.0/24",
        location="West US",
        resource_group_name="rg1",
        sku="Basic",
        tags={
            "key1": "value1",
        },
        virtual_hub_name="virtualHub2",
        virtual_wan=azure_native.network.SubResourceArgs(
            id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1",
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const virtualHub = new azure_native.network.VirtualHub("virtualHub", {
        addressPrefix: "10.168.0.0/24",
        location: "West US",
        resourceGroupName: "rg1",
        sku: "Basic",
        tags: {
            key1: "value1",
        },
        virtualHubName: "virtualHub2",
        virtualWan: {
            id: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1",
        },
    });
    
    resources:
      virtualHub:
        type: azure-native:network:VirtualHub
        properties:
          addressPrefix: 10.168.0.0/24
          location: West US
          resourceGroupName: rg1
          sku: Basic
          tags:
            key1: value1
          virtualHubName: virtualHub2
          virtualWan:
            id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1
    

    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,
                   route_table: Optional[VirtualHubRouteTableArgs] = None,
                   id: Optional[str] = None,
                   security_partner_provider: Optional[SubResourceArgs] = None,
                   sku: Optional[str] = None,
                   security_provider_name: Optional[str] = None,
                   location: Optional[str] = None,
                   p2_s_vpn_gateway: Optional[SubResourceArgs] = None,
                   preferred_routing_gateway: Optional[Union[str, PreferredRoutingGateway]] = None,
                   allow_branch_to_branch_traffic: Optional[bool] = None,
                   address_prefix: Optional[str] = None,
                   express_route_gateway: Optional[SubResourceArgs] = None,
                   azure_firewall: Optional[SubResourceArgs] = None,
                   hub_routing_preference: Optional[Union[str, HubRoutingPreference]] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   virtual_hub_name: Optional[str] = None,
                   virtual_hub_route_table_v2s: Optional[Sequence[VirtualHubRouteTableV2Args]] = None,
                   virtual_router_asn: Optional[float] = None,
                   virtual_router_auto_scale_configuration: Optional[VirtualRouterAutoScaleConfigurationArgs] = None,
                   virtual_router_ips: Optional[Sequence[str]] = None,
                   virtual_wan: Optional[SubResourceArgs] = None,
                   vpn_gateway: Optional[SubResourceArgs] = 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-native: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 AzureNative.Network.VirtualHub("virtualHubResource", new()
    {
        ResourceGroupName = "string",
        RouteTable = new AzureNative.Network.Inputs.VirtualHubRouteTableArgs
        {
            Routes = new[]
            {
                new AzureNative.Network.Inputs.VirtualHubRouteArgs
                {
                    AddressPrefixes = new[]
                    {
                        "string",
                    },
                    NextHopIpAddress = "string",
                },
            },
        },
        Id = "string",
        SecurityPartnerProvider = new AzureNative.Network.Inputs.SubResourceArgs
        {
            Id = "string",
        },
        Sku = "string",
        SecurityProviderName = "string",
        Location = "string",
        P2SVpnGateway = new AzureNative.Network.Inputs.SubResourceArgs
        {
            Id = "string",
        },
        PreferredRoutingGateway = "string",
        AllowBranchToBranchTraffic = false,
        AddressPrefix = "string",
        ExpressRouteGateway = new AzureNative.Network.Inputs.SubResourceArgs
        {
            Id = "string",
        },
        AzureFirewall = new AzureNative.Network.Inputs.SubResourceArgs
        {
            Id = "string",
        },
        HubRoutingPreference = "string",
        Tags = 
        {
            { "string", "string" },
        },
        VirtualHubName = "string",
        VirtualHubRouteTableV2s = new[]
        {
            new AzureNative.Network.Inputs.VirtualHubRouteTableV2Args
            {
                AttachedConnections = new[]
                {
                    "string",
                },
                Id = "string",
                Name = "string",
                Routes = new[]
                {
                    new AzureNative.Network.Inputs.VirtualHubRouteV2Args
                    {
                        DestinationType = "string",
                        Destinations = new[]
                        {
                            "string",
                        },
                        NextHopType = "string",
                        NextHops = new[]
                        {
                            "string",
                        },
                    },
                },
            },
        },
        VirtualRouterAsn = 0,
        VirtualRouterAutoScaleConfiguration = new AzureNative.Network.Inputs.VirtualRouterAutoScaleConfigurationArgs
        {
            MinCapacity = 0,
        },
        VirtualRouterIps = new[]
        {
            "string",
        },
        VirtualWan = new AzureNative.Network.Inputs.SubResourceArgs
        {
            Id = "string",
        },
        VpnGateway = new AzureNative.Network.Inputs.SubResourceArgs
        {
            Id = "string",
        },
    });
    
    example, err := network.NewVirtualHub(ctx, "virtualHubResource", &network.VirtualHubArgs{
    ResourceGroupName: pulumi.String("string"),
    RouteTable: &network.VirtualHubRouteTableArgs{
    Routes: network.VirtualHubRouteArray{
    &network.VirtualHubRouteArgs{
    AddressPrefixes: pulumi.StringArray{
    pulumi.String("string"),
    },
    NextHopIpAddress: pulumi.String("string"),
    },
    },
    },
    Id: pulumi.String("string"),
    SecurityPartnerProvider: &network.SubResourceArgs{
    Id: pulumi.String("string"),
    },
    Sku: pulumi.String("string"),
    SecurityProviderName: pulumi.String("string"),
    Location: pulumi.String("string"),
    P2SVpnGateway: &network.SubResourceArgs{
    Id: pulumi.String("string"),
    },
    PreferredRoutingGateway: pulumi.String("string"),
    AllowBranchToBranchTraffic: pulumi.Bool(false),
    AddressPrefix: pulumi.String("string"),
    ExpressRouteGateway: &network.SubResourceArgs{
    Id: pulumi.String("string"),
    },
    AzureFirewall: &network.SubResourceArgs{
    Id: pulumi.String("string"),
    },
    HubRoutingPreference: pulumi.String("string"),
    Tags: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    VirtualHubName: pulumi.String("string"),
    VirtualHubRouteTableV2s: network.VirtualHubRouteTableV2TypeArray{
    &network.VirtualHubRouteTableV2TypeArgs{
    AttachedConnections: pulumi.StringArray{
    pulumi.String("string"),
    },
    Id: pulumi.String("string"),
    Name: pulumi.String("string"),
    Routes: network.VirtualHubRouteV2Array{
    &network.VirtualHubRouteV2Args{
    DestinationType: pulumi.String("string"),
    Destinations: pulumi.StringArray{
    pulumi.String("string"),
    },
    NextHopType: pulumi.String("string"),
    NextHops: pulumi.StringArray{
    pulumi.String("string"),
    },
    },
    },
    },
    },
    VirtualRouterAsn: pulumi.Float64(0),
    VirtualRouterAutoScaleConfiguration: &network.VirtualRouterAutoScaleConfigurationArgs{
    MinCapacity: pulumi.Int(0),
    },
    VirtualRouterIps: pulumi.StringArray{
    pulumi.String("string"),
    },
    VirtualWan: &network.SubResourceArgs{
    Id: pulumi.String("string"),
    },
    VpnGateway: &network.SubResourceArgs{
    Id: pulumi.String("string"),
    },
    })
    
    var virtualHubResource = new VirtualHub("virtualHubResource", VirtualHubArgs.builder()
        .resourceGroupName("string")
        .routeTable(VirtualHubRouteTableArgs.builder()
            .routes(VirtualHubRouteArgs.builder()
                .addressPrefixes("string")
                .nextHopIpAddress("string")
                .build())
            .build())
        .id("string")
        .securityPartnerProvider(SubResourceArgs.builder()
            .id("string")
            .build())
        .sku("string")
        .securityProviderName("string")
        .location("string")
        .p2SVpnGateway(SubResourceArgs.builder()
            .id("string")
            .build())
        .preferredRoutingGateway("string")
        .allowBranchToBranchTraffic(false)
        .addressPrefix("string")
        .expressRouteGateway(SubResourceArgs.builder()
            .id("string")
            .build())
        .azureFirewall(SubResourceArgs.builder()
            .id("string")
            .build())
        .hubRoutingPreference("string")
        .tags(Map.of("string", "string"))
        .virtualHubName("string")
        .virtualHubRouteTableV2s(VirtualHubRouteTableV2Args.builder()
            .attachedConnections("string")
            .id("string")
            .name("string")
            .routes(VirtualHubRouteV2Args.builder()
                .destinationType("string")
                .destinations("string")
                .nextHopType("string")
                .nextHops("string")
                .build())
            .build())
        .virtualRouterAsn(0)
        .virtualRouterAutoScaleConfiguration(VirtualRouterAutoScaleConfigurationArgs.builder()
            .minCapacity(0)
            .build())
        .virtualRouterIps("string")
        .virtualWan(SubResourceArgs.builder()
            .id("string")
            .build())
        .vpnGateway(SubResourceArgs.builder()
            .id("string")
            .build())
        .build());
    
    virtual_hub_resource = azure_native.network.VirtualHub("virtualHubResource",
        resource_group_name="string",
        route_table=azure_native.network.VirtualHubRouteTableArgs(
            routes=[azure_native.network.VirtualHubRouteArgs(
                address_prefixes=["string"],
                next_hop_ip_address="string",
            )],
        ),
        id="string",
        security_partner_provider=azure_native.network.SubResourceArgs(
            id="string",
        ),
        sku="string",
        security_provider_name="string",
        location="string",
        p2_s_vpn_gateway=azure_native.network.SubResourceArgs(
            id="string",
        ),
        preferred_routing_gateway="string",
        allow_branch_to_branch_traffic=False,
        address_prefix="string",
        express_route_gateway=azure_native.network.SubResourceArgs(
            id="string",
        ),
        azure_firewall=azure_native.network.SubResourceArgs(
            id="string",
        ),
        hub_routing_preference="string",
        tags={
            "string": "string",
        },
        virtual_hub_name="string",
        virtual_hub_route_table_v2s=[azure_native.network.VirtualHubRouteTableV2Args(
            attached_connections=["string"],
            id="string",
            name="string",
            routes=[azure_native.network.VirtualHubRouteV2Args(
                destination_type="string",
                destinations=["string"],
                next_hop_type="string",
                next_hops=["string"],
            )],
        )],
        virtual_router_asn=0,
        virtual_router_auto_scale_configuration=azure_native.network.VirtualRouterAutoScaleConfigurationArgs(
            min_capacity=0,
        ),
        virtual_router_ips=["string"],
        virtual_wan=azure_native.network.SubResourceArgs(
            id="string",
        ),
        vpn_gateway=azure_native.network.SubResourceArgs(
            id="string",
        ))
    
    const virtualHubResource = new azure_native.network.VirtualHub("virtualHubResource", {
        resourceGroupName: "string",
        routeTable: {
            routes: [{
                addressPrefixes: ["string"],
                nextHopIpAddress: "string",
            }],
        },
        id: "string",
        securityPartnerProvider: {
            id: "string",
        },
        sku: "string",
        securityProviderName: "string",
        location: "string",
        p2SVpnGateway: {
            id: "string",
        },
        preferredRoutingGateway: "string",
        allowBranchToBranchTraffic: false,
        addressPrefix: "string",
        expressRouteGateway: {
            id: "string",
        },
        azureFirewall: {
            id: "string",
        },
        hubRoutingPreference: "string",
        tags: {
            string: "string",
        },
        virtualHubName: "string",
        virtualHubRouteTableV2s: [{
            attachedConnections: ["string"],
            id: "string",
            name: "string",
            routes: [{
                destinationType: "string",
                destinations: ["string"],
                nextHopType: "string",
                nextHops: ["string"],
            }],
        }],
        virtualRouterAsn: 0,
        virtualRouterAutoScaleConfiguration: {
            minCapacity: 0,
        },
        virtualRouterIps: ["string"],
        virtualWan: {
            id: "string",
        },
        vpnGateway: {
            id: "string",
        },
    });
    
    type: azure-native:network:VirtualHub
    properties:
        addressPrefix: string
        allowBranchToBranchTraffic: false
        azureFirewall:
            id: string
        expressRouteGateway:
            id: string
        hubRoutingPreference: string
        id: string
        location: string
        p2SVpnGateway:
            id: string
        preferredRoutingGateway: string
        resourceGroupName: string
        routeTable:
            routes:
                - addressPrefixes:
                    - string
                  nextHopIpAddress: string
        securityPartnerProvider:
            id: string
        securityProviderName: string
        sku: string
        tags:
            string: string
        virtualHubName: string
        virtualHubRouteTableV2s:
            - attachedConnections:
                - string
              id: string
              name: string
              routes:
                - destinationType: string
                  destinations:
                    - string
                  nextHopType: string
                  nextHops:
                    - string
        virtualRouterAsn: 0
        virtualRouterAutoScaleConfiguration:
            minCapacity: 0
        virtualRouterIps:
            - string
        virtualWan:
            id: string
        vpnGateway:
            id: 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
    The resource group name of the VirtualHub.
    AddressPrefix string
    Address-prefix for this VirtualHub.
    AllowBranchToBranchTraffic bool
    Flag to control transit for VirtualRouter hub.
    AzureFirewall Pulumi.AzureNative.Network.Inputs.SubResource
    The azureFirewall associated with this VirtualHub.
    ExpressRouteGateway Pulumi.AzureNative.Network.Inputs.SubResource
    The expressRouteGateway associated with this VirtualHub.
    HubRoutingPreference string | Pulumi.AzureNative.Network.HubRoutingPreference
    The hubRoutingPreference of this VirtualHub.
    Id string
    Resource ID.
    Location string
    Resource location.
    P2SVpnGateway Pulumi.AzureNative.Network.Inputs.SubResource
    The P2SVpnGateway associated with this VirtualHub.
    PreferredRoutingGateway string | Pulumi.AzureNative.Network.PreferredRoutingGateway
    The preferred gateway to route on-prem traffic
    RouteTable Pulumi.AzureNative.Network.Inputs.VirtualHubRouteTable
    The routeTable associated with this virtual hub.
    SecurityPartnerProvider Pulumi.AzureNative.Network.Inputs.SubResource
    The securityPartnerProvider associated with this VirtualHub.
    SecurityProviderName string
    The Security Provider name.
    Sku string
    The sku of this VirtualHub.
    Tags Dictionary<string, string>
    Resource tags.
    VirtualHubName string
    The name of the VirtualHub.
    VirtualHubRouteTableV2s List<Pulumi.AzureNative.Network.Inputs.VirtualHubRouteTableV2>
    List of all virtual hub route table v2s associated with this VirtualHub. These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
    VirtualRouterAsn double
    VirtualRouter ASN.
    VirtualRouterAutoScaleConfiguration Pulumi.AzureNative.Network.Inputs.VirtualRouterAutoScaleConfiguration
    The VirtualHub Router autoscale configuration.
    VirtualRouterIps List<string>
    VirtualRouter IPs.
    VirtualWan Pulumi.AzureNative.Network.Inputs.SubResource
    The VirtualWAN to which the VirtualHub belongs.
    VpnGateway Pulumi.AzureNative.Network.Inputs.SubResource
    The VpnGateway associated with this VirtualHub.
    ResourceGroupName string
    The resource group name of the VirtualHub.
    AddressPrefix string
    Address-prefix for this VirtualHub.
    AllowBranchToBranchTraffic bool
    Flag to control transit for VirtualRouter hub.
    AzureFirewall SubResourceArgs
    The azureFirewall associated with this VirtualHub.
    ExpressRouteGateway SubResourceArgs
    The expressRouteGateway associated with this VirtualHub.
    HubRoutingPreference string | HubRoutingPreference
    The hubRoutingPreference of this VirtualHub.
    Id string
    Resource ID.
    Location string
    Resource location.
    P2SVpnGateway SubResourceArgs
    The P2SVpnGateway associated with this VirtualHub.
    PreferredRoutingGateway string | PreferredRoutingGateway
    The preferred gateway to route on-prem traffic
    RouteTable VirtualHubRouteTableArgs
    The routeTable associated with this virtual hub.
    SecurityPartnerProvider SubResourceArgs
    The securityPartnerProvider associated with this VirtualHub.
    SecurityProviderName string
    The Security Provider name.
    Sku string
    The sku of this VirtualHub.
    Tags map[string]string
    Resource tags.
    VirtualHubName string
    The name of the VirtualHub.
    VirtualHubRouteTableV2s []VirtualHubRouteTableV2TypeArgs
    List of all virtual hub route table v2s associated with this VirtualHub. These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
    VirtualRouterAsn float64
    VirtualRouter ASN.
    VirtualRouterAutoScaleConfiguration VirtualRouterAutoScaleConfigurationArgs
    The VirtualHub Router autoscale configuration.
    VirtualRouterIps []string
    VirtualRouter IPs.
    VirtualWan SubResourceArgs
    The VirtualWAN to which the VirtualHub belongs.
    VpnGateway SubResourceArgs
    The VpnGateway associated with this VirtualHub.
    resourceGroupName String
    The resource group name of the VirtualHub.
    addressPrefix String
    Address-prefix for this VirtualHub.
    allowBranchToBranchTraffic Boolean
    Flag to control transit for VirtualRouter hub.
    azureFirewall SubResource
    The azureFirewall associated with this VirtualHub.
    expressRouteGateway SubResource
    The expressRouteGateway associated with this VirtualHub.
    hubRoutingPreference String | HubRoutingPreference
    The hubRoutingPreference of this VirtualHub.
    id String
    Resource ID.
    location String
    Resource location.
    p2SVpnGateway SubResource
    The P2SVpnGateway associated with this VirtualHub.
    preferredRoutingGateway String | PreferredRoutingGateway
    The preferred gateway to route on-prem traffic
    routeTable VirtualHubRouteTable
    The routeTable associated with this virtual hub.
    securityPartnerProvider SubResource
    The securityPartnerProvider associated with this VirtualHub.
    securityProviderName String
    The Security Provider name.
    sku String
    The sku of this VirtualHub.
    tags Map<String,String>
    Resource tags.
    virtualHubName String
    The name of the VirtualHub.
    virtualHubRouteTableV2s List<VirtualHubRouteTableV2>
    List of all virtual hub route table v2s associated with this VirtualHub. These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
    virtualRouterAsn Double
    VirtualRouter ASN.
    virtualRouterAutoScaleConfiguration VirtualRouterAutoScaleConfiguration
    The VirtualHub Router autoscale configuration.
    virtualRouterIps List<String>
    VirtualRouter IPs.
    virtualWan SubResource
    The VirtualWAN to which the VirtualHub belongs.
    vpnGateway SubResource
    The VpnGateway associated with this VirtualHub.
    resourceGroupName string
    The resource group name of the VirtualHub.
    addressPrefix string
    Address-prefix for this VirtualHub.
    allowBranchToBranchTraffic boolean
    Flag to control transit for VirtualRouter hub.
    azureFirewall SubResource
    The azureFirewall associated with this VirtualHub.
    expressRouteGateway SubResource
    The expressRouteGateway associated with this VirtualHub.
    hubRoutingPreference string | HubRoutingPreference
    The hubRoutingPreference of this VirtualHub.
    id string
    Resource ID.
    location string
    Resource location.
    p2SVpnGateway SubResource
    The P2SVpnGateway associated with this VirtualHub.
    preferredRoutingGateway string | PreferredRoutingGateway
    The preferred gateway to route on-prem traffic
    routeTable VirtualHubRouteTable
    The routeTable associated with this virtual hub.
    securityPartnerProvider SubResource
    The securityPartnerProvider associated with this VirtualHub.
    securityProviderName string
    The Security Provider name.
    sku string
    The sku of this VirtualHub.
    tags {[key: string]: string}
    Resource tags.
    virtualHubName string
    The name of the VirtualHub.
    virtualHubRouteTableV2s VirtualHubRouteTableV2[]
    List of all virtual hub route table v2s associated with this VirtualHub. These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
    virtualRouterAsn number
    VirtualRouter ASN.
    virtualRouterAutoScaleConfiguration VirtualRouterAutoScaleConfiguration
    The VirtualHub Router autoscale configuration.
    virtualRouterIps string[]
    VirtualRouter IPs.
    virtualWan SubResource
    The VirtualWAN to which the VirtualHub belongs.
    vpnGateway SubResource
    The VpnGateway associated with this VirtualHub.
    resource_group_name str
    The resource group name of the VirtualHub.
    address_prefix str
    Address-prefix for this VirtualHub.
    allow_branch_to_branch_traffic bool
    Flag to control transit for VirtualRouter hub.
    azure_firewall SubResourceArgs
    The azureFirewall associated with this VirtualHub.
    express_route_gateway SubResourceArgs
    The expressRouteGateway associated with this VirtualHub.
    hub_routing_preference str | HubRoutingPreference
    The hubRoutingPreference of this VirtualHub.
    id str
    Resource ID.
    location str
    Resource location.
    p2_s_vpn_gateway SubResourceArgs
    The P2SVpnGateway associated with this VirtualHub.
    preferred_routing_gateway str | PreferredRoutingGateway
    The preferred gateway to route on-prem traffic
    route_table VirtualHubRouteTableArgs
    The routeTable associated with this virtual hub.
    security_partner_provider SubResourceArgs
    The securityPartnerProvider associated with this VirtualHub.
    security_provider_name str
    The Security Provider name.
    sku str
    The sku of this VirtualHub.
    tags Mapping[str, str]
    Resource tags.
    virtual_hub_name str
    The name of the VirtualHub.
    virtual_hub_route_table_v2s Sequence[VirtualHubRouteTableV2Args]
    List of all virtual hub route table v2s associated with this VirtualHub. These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
    virtual_router_asn float
    VirtualRouter ASN.
    virtual_router_auto_scale_configuration VirtualRouterAutoScaleConfigurationArgs
    The VirtualHub Router autoscale configuration.
    virtual_router_ips Sequence[str]
    VirtualRouter IPs.
    virtual_wan SubResourceArgs
    The VirtualWAN to which the VirtualHub belongs.
    vpn_gateway SubResourceArgs
    The VpnGateway associated with this VirtualHub.
    resourceGroupName String
    The resource group name of the VirtualHub.
    addressPrefix String
    Address-prefix for this VirtualHub.
    allowBranchToBranchTraffic Boolean
    Flag to control transit for VirtualRouter hub.
    azureFirewall Property Map
    The azureFirewall associated with this VirtualHub.
    expressRouteGateway Property Map
    The expressRouteGateway associated with this VirtualHub.
    hubRoutingPreference String | "ExpressRoute" | "VpnGateway" | "ASPath"
    The hubRoutingPreference of this VirtualHub.
    id String
    Resource ID.
    location String
    Resource location.
    p2SVpnGateway Property Map
    The P2SVpnGateway associated with this VirtualHub.
    preferredRoutingGateway String | "ExpressRoute" | "VpnGateway" | "None"
    The preferred gateway to route on-prem traffic
    routeTable Property Map
    The routeTable associated with this virtual hub.
    securityPartnerProvider Property Map
    The securityPartnerProvider associated with this VirtualHub.
    securityProviderName String
    The Security Provider name.
    sku String
    The sku of this VirtualHub.
    tags Map<String>
    Resource tags.
    virtualHubName String
    The name of the VirtualHub.
    virtualHubRouteTableV2s List<Property Map>
    List of all virtual hub route table v2s associated with this VirtualHub. These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
    virtualRouterAsn Number
    VirtualRouter ASN.
    virtualRouterAutoScaleConfiguration Property Map
    The VirtualHub Router autoscale configuration.
    virtualRouterIps List<String>
    VirtualRouter IPs.
    virtualWan Property Map
    The VirtualWAN to which the VirtualHub belongs.
    vpnGateway Property Map
    The VpnGateway associated with this VirtualHub.

    Outputs

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

    BgpConnections List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
    List of references to Bgp Connections.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpConfigurations List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
    List of references to IpConfigurations.
    Kind string
    Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the virtual hub resource.
    RouteMaps List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
    List of references to RouteMaps.
    RoutingState string
    The routing state.
    Type string
    Resource type.
    BgpConnections []SubResourceResponse
    List of references to Bgp Connections.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpConfigurations []SubResourceResponse
    List of references to IpConfigurations.
    Kind string
    Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the virtual hub resource.
    RouteMaps []SubResourceResponse
    List of references to RouteMaps.
    RoutingState string
    The routing state.
    Type string
    Resource type.
    bgpConnections List<SubResourceResponse>
    List of references to Bgp Connections.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    ipConfigurations List<SubResourceResponse>
    List of references to IpConfigurations.
    kind String
    Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the virtual hub resource.
    routeMaps List<SubResourceResponse>
    List of references to RouteMaps.
    routingState String
    The routing state.
    type String
    Resource type.
    bgpConnections SubResourceResponse[]
    List of references to Bgp Connections.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    The provider-assigned unique ID for this managed resource.
    ipConfigurations SubResourceResponse[]
    List of references to IpConfigurations.
    kind string
    Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
    name string
    Resource name.
    provisioningState string
    The provisioning state of the virtual hub resource.
    routeMaps SubResourceResponse[]
    List of references to RouteMaps.
    routingState string
    The routing state.
    type string
    Resource type.
    bgp_connections Sequence[SubResourceResponse]
    List of references to Bgp Connections.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_configurations Sequence[SubResourceResponse]
    List of references to IpConfigurations.
    kind str
    Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
    name str
    Resource name.
    provisioning_state str
    The provisioning state of the virtual hub resource.
    route_maps Sequence[SubResourceResponse]
    List of references to RouteMaps.
    routing_state str
    The routing state.
    type str
    Resource type.
    bgpConnections List<Property Map>
    List of references to Bgp Connections.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    ipConfigurations List<Property Map>
    List of references to IpConfigurations.
    kind String
    Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the virtual hub resource.
    routeMaps List<Property Map>
    List of references to RouteMaps.
    routingState String
    The routing state.
    type String
    Resource type.

    Supporting Types

    HubRoutingPreference, HubRoutingPreferenceArgs

    ExpressRoute
    ExpressRoute
    VpnGateway
    VpnGateway
    ASPath
    ASPath
    HubRoutingPreferenceExpressRoute
    ExpressRoute
    HubRoutingPreferenceVpnGateway
    VpnGateway
    HubRoutingPreferenceASPath
    ASPath
    ExpressRoute
    ExpressRoute
    VpnGateway
    VpnGateway
    ASPath
    ASPath
    ExpressRoute
    ExpressRoute
    VpnGateway
    VpnGateway
    ASPath
    ASPath
    EXPRESS_ROUTE
    ExpressRoute
    VPN_GATEWAY
    VpnGateway
    AS_PATH
    ASPath
    "ExpressRoute"
    ExpressRoute
    "VpnGateway"
    VpnGateway
    "ASPath"
    ASPath

    PreferredRoutingGateway, PreferredRoutingGatewayArgs

    ExpressRoute
    ExpressRoute
    VpnGateway
    VpnGateway
    None
    None
    PreferredRoutingGatewayExpressRoute
    ExpressRoute
    PreferredRoutingGatewayVpnGateway
    VpnGateway
    PreferredRoutingGatewayNone
    None
    ExpressRoute
    ExpressRoute
    VpnGateway
    VpnGateway
    None
    None
    ExpressRoute
    ExpressRoute
    VpnGateway
    VpnGateway
    None
    None
    EXPRESS_ROUTE
    ExpressRoute
    VPN_GATEWAY
    VpnGateway
    NONE
    None
    "ExpressRoute"
    ExpressRoute
    "VpnGateway"
    VpnGateway
    "None"
    None

    SubResource, SubResourceArgs

    Id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    Id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id String
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id string
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id str
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.
    id String
    Sub-resource ID. Both absolute resource ID and a relative resource ID are accepted. An absolute ID starts with /subscriptions/ and contains the entire ID of the parent resource and the ID of the sub-resource in the end. A relative ID replaces the ID of the parent resource with a token '$self', followed by the sub-resource ID itself. Example of a relative ID: $self/frontEndConfigurations/my-frontend.

    SubResourceResponse, SubResourceResponseArgs

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    VirtualHubRoute, VirtualHubRouteArgs

    AddressPrefixes List<string>
    List of all addressPrefixes.
    NextHopIpAddress string
    NextHop ip address.
    AddressPrefixes []string
    List of all addressPrefixes.
    NextHopIpAddress string
    NextHop ip address.
    addressPrefixes List<String>
    List of all addressPrefixes.
    nextHopIpAddress String
    NextHop ip address.
    addressPrefixes string[]
    List of all addressPrefixes.
    nextHopIpAddress string
    NextHop ip address.
    address_prefixes Sequence[str]
    List of all addressPrefixes.
    next_hop_ip_address str
    NextHop ip address.
    addressPrefixes List<String>
    List of all addressPrefixes.
    nextHopIpAddress String
    NextHop ip address.

    VirtualHubRouteResponse, VirtualHubRouteResponseArgs

    AddressPrefixes List<string>
    List of all addressPrefixes.
    NextHopIpAddress string
    NextHop ip address.
    AddressPrefixes []string
    List of all addressPrefixes.
    NextHopIpAddress string
    NextHop ip address.
    addressPrefixes List<String>
    List of all addressPrefixes.
    nextHopIpAddress String
    NextHop ip address.
    addressPrefixes string[]
    List of all addressPrefixes.
    nextHopIpAddress string
    NextHop ip address.
    address_prefixes Sequence[str]
    List of all addressPrefixes.
    next_hop_ip_address str
    NextHop ip address.
    addressPrefixes List<String>
    List of all addressPrefixes.
    nextHopIpAddress String
    NextHop ip address.

    VirtualHubRouteTable, VirtualHubRouteTableArgs

    Routes []VirtualHubRoute
    List of all routes.
    routes List<VirtualHubRoute>
    List of all routes.
    routes VirtualHubRoute[]
    List of all routes.
    routes List<Property Map>
    List of all routes.

    VirtualHubRouteTableResponse, VirtualHubRouteTableResponseArgs

    routes List<Property Map>
    List of all routes.

    VirtualHubRouteTableV2, VirtualHubRouteTableV2Args

    AttachedConnections List<string>
    List of all connections attached to this route table v2.
    Id string
    Resource ID.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    Routes List<Pulumi.AzureNative.Network.Inputs.VirtualHubRouteV2>
    List of all routes.
    AttachedConnections []string
    List of all connections attached to this route table v2.
    Id string
    Resource ID.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    Routes []VirtualHubRouteV2
    List of all routes.
    attachedConnections List<String>
    List of all connections attached to this route table v2.
    id String
    Resource ID.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    routes List<VirtualHubRouteV2>
    List of all routes.
    attachedConnections string[]
    List of all connections attached to this route table v2.
    id string
    Resource ID.
    name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    routes VirtualHubRouteV2[]
    List of all routes.
    attached_connections Sequence[str]
    List of all connections attached to this route table v2.
    id str
    Resource ID.
    name str
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    routes Sequence[VirtualHubRouteV2]
    List of all routes.
    attachedConnections List<String>
    List of all connections attached to this route table v2.
    id String
    Resource ID.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    routes List<Property Map>
    List of all routes.

    VirtualHubRouteTableV2Response, VirtualHubRouteTableV2ResponseArgs

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the virtual hub route table v2 resource.
    AttachedConnections List<string>
    List of all connections attached to this route table v2.
    Id string
    Resource ID.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    Routes List<Pulumi.AzureNative.Network.Inputs.VirtualHubRouteV2Response>
    List of all routes.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the virtual hub route table v2 resource.
    AttachedConnections []string
    List of all connections attached to this route table v2.
    Id string
    Resource ID.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    Routes []VirtualHubRouteV2Response
    List of all routes.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the virtual hub route table v2 resource.
    attachedConnections List<String>
    List of all connections attached to this route table v2.
    id String
    Resource ID.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    routes List<VirtualHubRouteV2Response>
    List of all routes.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    provisioningState string
    The provisioning state of the virtual hub route table v2 resource.
    attachedConnections string[]
    List of all connections attached to this route table v2.
    id string
    Resource ID.
    name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    routes VirtualHubRouteV2Response[]
    List of all routes.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    provisioning_state str
    The provisioning state of the virtual hub route table v2 resource.
    attached_connections Sequence[str]
    List of all connections attached to this route table v2.
    id str
    Resource ID.
    name str
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    routes Sequence[VirtualHubRouteV2Response]
    List of all routes.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the virtual hub route table v2 resource.
    attachedConnections List<String>
    List of all connections attached to this route table v2.
    id String
    Resource ID.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    routes List<Property Map>
    List of all routes.

    VirtualHubRouteV2, VirtualHubRouteV2Args

    DestinationType string
    The type of destinations.
    Destinations List<string>
    List of all destinations.
    NextHopType string
    The type of next hops.
    NextHops List<string>
    NextHops ip address.
    DestinationType string
    The type of destinations.
    Destinations []string
    List of all destinations.
    NextHopType string
    The type of next hops.
    NextHops []string
    NextHops ip address.
    destinationType String
    The type of destinations.
    destinations List<String>
    List of all destinations.
    nextHopType String
    The type of next hops.
    nextHops List<String>
    NextHops ip address.
    destinationType string
    The type of destinations.
    destinations string[]
    List of all destinations.
    nextHopType string
    The type of next hops.
    nextHops string[]
    NextHops ip address.
    destination_type str
    The type of destinations.
    destinations Sequence[str]
    List of all destinations.
    next_hop_type str
    The type of next hops.
    next_hops Sequence[str]
    NextHops ip address.
    destinationType String
    The type of destinations.
    destinations List<String>
    List of all destinations.
    nextHopType String
    The type of next hops.
    nextHops List<String>
    NextHops ip address.

    VirtualHubRouteV2Response, VirtualHubRouteV2ResponseArgs

    DestinationType string
    The type of destinations.
    Destinations List<string>
    List of all destinations.
    NextHopType string
    The type of next hops.
    NextHops List<string>
    NextHops ip address.
    DestinationType string
    The type of destinations.
    Destinations []string
    List of all destinations.
    NextHopType string
    The type of next hops.
    NextHops []string
    NextHops ip address.
    destinationType String
    The type of destinations.
    destinations List<String>
    List of all destinations.
    nextHopType String
    The type of next hops.
    nextHops List<String>
    NextHops ip address.
    destinationType string
    The type of destinations.
    destinations string[]
    List of all destinations.
    nextHopType string
    The type of next hops.
    nextHops string[]
    NextHops ip address.
    destination_type str
    The type of destinations.
    destinations Sequence[str]
    List of all destinations.
    next_hop_type str
    The type of next hops.
    next_hops Sequence[str]
    NextHops ip address.
    destinationType String
    The type of destinations.
    destinations List<String>
    List of all destinations.
    nextHopType String
    The type of next hops.
    nextHops List<String>
    NextHops ip address.

    VirtualRouterAutoScaleConfiguration, VirtualRouterAutoScaleConfigurationArgs

    MinCapacity int
    The minimum number of scale units for VirtualHub Router.
    MinCapacity int
    The minimum number of scale units for VirtualHub Router.
    minCapacity Integer
    The minimum number of scale units for VirtualHub Router.
    minCapacity number
    The minimum number of scale units for VirtualHub Router.
    min_capacity int
    The minimum number of scale units for VirtualHub Router.
    minCapacity Number
    The minimum number of scale units for VirtualHub Router.

    VirtualRouterAutoScaleConfigurationResponse, VirtualRouterAutoScaleConfigurationResponseArgs

    MinCapacity int
    The minimum number of scale units for VirtualHub Router.
    MinCapacity int
    The minimum number of scale units for VirtualHub Router.
    minCapacity Integer
    The minimum number of scale units for VirtualHub Router.
    minCapacity number
    The minimum number of scale units for VirtualHub Router.
    min_capacity int
    The minimum number of scale units for VirtualHub Router.
    minCapacity Number
    The minimum number of scale units for VirtualHub Router.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:network:VirtualHub virtualHub2 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.44.1 published on Thursday, Jun 6, 2024 by Pulumi