import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a Virtual Hub within a Virtual WAN. * * ## Example Usage * * ```typescript * 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", * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.Network` - 2025-01-01 * * ## Import * * Virtual Hub's can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:network/virtualHub:VirtualHub example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/virtualHubs/hub1 * ``` */ export declare class VirtualHub extends pulumi.CustomResource { /** * Get an existing VirtualHub resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: VirtualHubState, opts?: pulumi.CustomResourceOptions): VirtualHub; /** * Returns true if the given object is an instance of VirtualHub. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is VirtualHub; /** * 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`](https://docs.microsoft.com/azure/virtual-wan/virtual-wan-faq#what-is-the-recommended-hub-address-space-during-hub-creation). */ readonly addressPrefix: pulumi.Output; /** * Boolean flag to specify whether branch to branch traffic is allowed. Defaults to `false`. */ readonly branchToBranchTrafficEnabled: pulumi.Output; /** * The ID of the default Route Table in the Virtual Hub. */ readonly defaultRouteTableId: pulumi.Output; /** * The hub routing preference. Possible values are `ExpressRoute`, `ASPath` and `VpnGateway`. Defaults to `ExpressRoute`. */ readonly hubRoutingPreference: pulumi.Output; /** * Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created. */ readonly location: pulumi.Output; /** * The name of the Virtual Hub. Changing this forces a new resource to be created. */ readonly name: pulumi.Output; /** * Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created. */ readonly resourceGroupName: pulumi.Output; /** * One or more `route` blocks as defined below. */ readonly routes: pulumi.Output; /** * The SKU of the Virtual Hub. Possible values are `Basic` and `Standard`. Changing this forces a new resource to be created. */ readonly sku: pulumi.Output; /** * A mapping of tags to assign to the Virtual Hub. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The Autonomous System Number of the Virtual Hub BGP router. */ readonly virtualRouterAsn: pulumi.Output; /** * Minimum instance capacity for the scaling configuration of the Virtual Hub Router. Defaults to `2`. */ readonly virtualRouterAutoScaleMinCapacity: pulumi.Output; /** * The IP addresses of the Virtual Hub BGP router. */ readonly virtualRouterIps: pulumi.Output; /** * The ID of a Virtual WAN within which the Virtual Hub should be created. Changing this forces a new resource to be created. */ readonly virtualWanId: pulumi.Output; /** * Create a VirtualHub resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: VirtualHubArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering VirtualHub resources. */ export interface VirtualHubState { /** * 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`](https://docs.microsoft.com/azure/virtual-wan/virtual-wan-faq#what-is-the-recommended-hub-address-space-during-hub-creation). */ addressPrefix?: pulumi.Input; /** * Boolean flag to specify whether branch to branch traffic is allowed. Defaults to `false`. */ branchToBranchTrafficEnabled?: pulumi.Input; /** * The ID of the default Route Table in the Virtual Hub. */ defaultRouteTableId?: pulumi.Input; /** * The hub routing preference. Possible values are `ExpressRoute`, `ASPath` and `VpnGateway`. Defaults to `ExpressRoute`. */ hubRoutingPreference?: pulumi.Input; /** * Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * The name of the Virtual Hub. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created. */ resourceGroupName?: pulumi.Input; /** * One or more `route` blocks as defined below. */ routes?: pulumi.Input[]>; /** * The SKU of the Virtual Hub. Possible values are `Basic` and `Standard`. Changing this forces a new resource to be created. */ sku?: pulumi.Input; /** * A mapping of tags to assign to the Virtual Hub. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * The Autonomous System Number of the Virtual Hub BGP router. */ virtualRouterAsn?: pulumi.Input; /** * Minimum instance capacity for the scaling configuration of the Virtual Hub Router. Defaults to `2`. */ virtualRouterAutoScaleMinCapacity?: pulumi.Input; /** * The IP addresses of the Virtual Hub BGP router. */ virtualRouterIps?: pulumi.Input[]>; /** * The ID of a Virtual WAN within which the Virtual Hub should be created. Changing this forces a new resource to be created. */ virtualWanId?: pulumi.Input; } /** * The set of arguments for constructing a VirtualHub resource. */ export interface VirtualHubArgs { /** * 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`](https://docs.microsoft.com/azure/virtual-wan/virtual-wan-faq#what-is-the-recommended-hub-address-space-during-hub-creation). */ addressPrefix?: pulumi.Input; /** * Boolean flag to specify whether branch to branch traffic is allowed. Defaults to `false`. */ branchToBranchTrafficEnabled?: pulumi.Input; /** * The hub routing preference. Possible values are `ExpressRoute`, `ASPath` and `VpnGateway`. Defaults to `ExpressRoute`. */ hubRoutingPreference?: pulumi.Input; /** * Specifies the supported Azure location where the Virtual Hub should exist. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * The name of the Virtual Hub. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Specifies the name of the Resource Group where the Virtual Hub should exist. Changing this forces a new resource to be created. */ resourceGroupName: pulumi.Input; /** * One or more `route` blocks as defined below. */ routes?: pulumi.Input[]>; /** * The SKU of the Virtual Hub. Possible values are `Basic` and `Standard`. Changing this forces a new resource to be created. */ sku?: pulumi.Input; /** * A mapping of tags to assign to the Virtual Hub. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Minimum instance capacity for the scaling configuration of the Virtual Hub Router. Defaults to `2`. */ virtualRouterAutoScaleMinCapacity?: pulumi.Input; /** * The ID of a Virtual WAN within which the Virtual Hub should be created. Changing this forces a new resource to be created. */ virtualWanId?: pulumi.Input; }