@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 9.37 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* VirtualHub Resource.
*
* Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.
*
* Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native network [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, 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;
/**
* Address-prefix for this VirtualHub.
*/
readonly addressPrefix: pulumi.Output<string | undefined>;
/**
* Flag to control transit for VirtualRouter hub.
*/
readonly allowBranchToBranchTraffic: pulumi.Output<boolean | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The azureFirewall associated with this VirtualHub.
*/
readonly azureFirewall: pulumi.Output<outputs.network.SubResourceResponse | undefined>;
/**
* List of references to Bgp Connections.
*/
readonly bgpConnections: pulumi.Output<outputs.network.SubResourceResponse[]>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* The expressRouteGateway associated with this VirtualHub.
*/
readonly expressRouteGateway: pulumi.Output<outputs.network.SubResourceResponse | undefined>;
/**
* The hubRoutingPreference of this VirtualHub.
*/
readonly hubRoutingPreference: pulumi.Output<string | undefined>;
/**
* List of references to IpConfigurations.
*/
readonly ipConfigurations: pulumi.Output<outputs.network.SubResourceResponse[]>;
/**
* Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
*/
readonly kind: pulumi.Output<string>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* The P2SVpnGateway associated with this VirtualHub.
*/
readonly p2SVpnGateway: pulumi.Output<outputs.network.SubResourceResponse | undefined>;
/**
* The preferred gateway to route on-prem traffic
*/
readonly preferredRoutingGateway: pulumi.Output<string | undefined>;
/**
* The provisioning state of the virtual hub resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* List of references to RouteMaps.
*/
readonly routeMaps: pulumi.Output<outputs.network.SubResourceResponse[]>;
/**
* The routeTable associated with this virtual hub.
*/
readonly routeTable: pulumi.Output<outputs.network.VirtualHubRouteTableResponse | undefined>;
/**
* The routing state.
*/
readonly routingState: pulumi.Output<string>;
/**
* The securityPartnerProvider associated with this VirtualHub.
*/
readonly securityPartnerProvider: pulumi.Output<outputs.network.SubResourceResponse | undefined>;
/**
* The Security Provider name.
*/
readonly securityProviderName: pulumi.Output<string | undefined>;
/**
* The sku of this VirtualHub.
*/
readonly sku: pulumi.Output<string | undefined>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* List of all virtual hub route table v2s associated with this VirtualHub.
*/
readonly virtualHubRouteTableV2s: pulumi.Output<outputs.network.VirtualHubRouteTableV2Response[] | undefined>;
/**
* VirtualRouter ASN.
*/
readonly virtualRouterAsn: pulumi.Output<number | undefined>;
/**
* The VirtualHub Router autoscale configuration.
*/
readonly virtualRouterAutoScaleConfiguration: pulumi.Output<outputs.network.VirtualRouterAutoScaleConfigurationResponse | undefined>;
/**
* VirtualRouter IPs.
*/
readonly virtualRouterIps: pulumi.Output<string[] | undefined>;
/**
* The VirtualWAN to which the VirtualHub belongs.
*/
readonly virtualWan: pulumi.Output<outputs.network.SubResourceResponse | undefined>;
/**
* The VpnGateway associated with this VirtualHub.
*/
readonly vpnGateway: pulumi.Output<outputs.network.SubResourceResponse | undefined>;
/**
* 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);
}
/**
* The set of arguments for constructing a VirtualHub resource.
*/
export interface VirtualHubArgs {
/**
* Address-prefix for this VirtualHub.
*/
addressPrefix?: pulumi.Input<string>;
/**
* Flag to control transit for VirtualRouter hub.
*/
allowBranchToBranchTraffic?: pulumi.Input<boolean>;
/**
* The azureFirewall associated with this VirtualHub.
*/
azureFirewall?: pulumi.Input<inputs.network.SubResourceArgs>;
/**
* The expressRouteGateway associated with this VirtualHub.
*/
expressRouteGateway?: pulumi.Input<inputs.network.SubResourceArgs>;
/**
* The hubRoutingPreference of this VirtualHub.
*/
hubRoutingPreference?: pulumi.Input<string | enums.network.HubRoutingPreference>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* The P2SVpnGateway associated with this VirtualHub.
*/
p2SVpnGateway?: pulumi.Input<inputs.network.SubResourceArgs>;
/**
* The preferred gateway to route on-prem traffic
*/
preferredRoutingGateway?: pulumi.Input<string | enums.network.PreferredRoutingGateway>;
/**
* The resource group name of the VirtualHub.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The routeTable associated with this virtual hub.
*/
routeTable?: pulumi.Input<inputs.network.VirtualHubRouteTableArgs>;
/**
* The securityPartnerProvider associated with this VirtualHub.
*/
securityPartnerProvider?: pulumi.Input<inputs.network.SubResourceArgs>;
/**
* The Security Provider name.
*/
securityProviderName?: pulumi.Input<string>;
/**
* The sku of this VirtualHub.
*/
sku?: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The name of the VirtualHub.
*/
virtualHubName?: pulumi.Input<string>;
/**
* 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.
*/
virtualHubRouteTableV2s?: pulumi.Input<pulumi.Input<inputs.network.VirtualHubRouteTableV2Args>[]>;
/**
* VirtualRouter ASN.
*/
virtualRouterAsn?: pulumi.Input<number>;
/**
* The VirtualHub Router autoscale configuration.
*/
virtualRouterAutoScaleConfiguration?: pulumi.Input<inputs.network.VirtualRouterAutoScaleConfigurationArgs>;
/**
* VirtualRouter IPs.
*/
virtualRouterIps?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The VirtualWAN to which the VirtualHub belongs.
*/
virtualWan?: pulumi.Input<inputs.network.SubResourceArgs>;
/**
* The VpnGateway associated with this VirtualHub.
*/
vpnGateway?: pulumi.Input<inputs.network.SubResourceArgs>;
}