@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.04 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Retrieves the details of a VirtualHub.
*
* Uses Azure REST API version 2024-05-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 function getVirtualHub(args: GetVirtualHubArgs, opts?: pulumi.InvokeOptions): Promise<GetVirtualHubResult>;
export interface GetVirtualHubArgs {
/**
* The resource group name of the VirtualHub.
*/
resourceGroupName: string;
/**
* The name of the VirtualHub.
*/
virtualHubName: string;
}
/**
* VirtualHub Resource.
*/
export interface GetVirtualHubResult {
/**
* Address-prefix for this VirtualHub.
*/
readonly addressPrefix?: string;
/**
* Flag to control transit for VirtualRouter hub.
*/
readonly allowBranchToBranchTraffic?: boolean;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The azureFirewall associated with this VirtualHub.
*/
readonly azureFirewall?: outputs.network.SubResourceResponse;
/**
* List of references to Bgp Connections.
*/
readonly bgpConnections: outputs.network.SubResourceResponse[];
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: string;
/**
* The expressRouteGateway associated with this VirtualHub.
*/
readonly expressRouteGateway?: outputs.network.SubResourceResponse;
/**
* The hubRoutingPreference of this VirtualHub.
*/
readonly hubRoutingPreference?: string;
/**
* Resource ID.
*/
readonly id?: string;
/**
* List of references to IpConfigurations.
*/
readonly ipConfigurations: outputs.network.SubResourceResponse[];
/**
* Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server.
*/
readonly kind: string;
/**
* Resource location.
*/
readonly location: string;
/**
* Resource name.
*/
readonly name: string;
/**
* The P2SVpnGateway associated with this VirtualHub.
*/
readonly p2SVpnGateway?: outputs.network.SubResourceResponse;
/**
* The preferred gateway to route on-prem traffic
*/
readonly preferredRoutingGateway?: string;
/**
* The provisioning state of the virtual hub resource.
*/
readonly provisioningState: string;
/**
* List of references to RouteMaps.
*/
readonly routeMaps: outputs.network.SubResourceResponse[];
/**
* The routeTable associated with this virtual hub.
*/
readonly routeTable?: outputs.network.VirtualHubRouteTableResponse;
/**
* The routing state.
*/
readonly routingState: string;
/**
* The securityPartnerProvider associated with this VirtualHub.
*/
readonly securityPartnerProvider?: outputs.network.SubResourceResponse;
/**
* The Security Provider name.
*/
readonly securityProviderName?: string;
/**
* The sku of this VirtualHub.
*/
readonly sku?: string;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* Resource type.
*/
readonly type: string;
/**
* List of all virtual hub route table v2s associated with this VirtualHub.
*/
readonly virtualHubRouteTableV2s?: outputs.network.VirtualHubRouteTableV2Response[];
/**
* VirtualRouter ASN.
*/
readonly virtualRouterAsn?: number;
/**
* The VirtualHub Router autoscale configuration.
*/
readonly virtualRouterAutoScaleConfiguration?: outputs.network.VirtualRouterAutoScaleConfigurationResponse;
/**
* VirtualRouter IPs.
*/
readonly virtualRouterIps?: string[];
/**
* The VirtualWAN to which the VirtualHub belongs.
*/
readonly virtualWan?: outputs.network.SubResourceResponse;
/**
* The VpnGateway associated with this VirtualHub.
*/
readonly vpnGateway?: outputs.network.SubResourceResponse;
}
/**
* Retrieves the details of a VirtualHub.
*
* Uses Azure REST API version 2024-05-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 function getVirtualHubOutput(args: GetVirtualHubOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVirtualHubResult>;
export interface GetVirtualHubOutputArgs {
/**
* The resource group name of the VirtualHub.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the VirtualHub.
*/
virtualHubName: pulumi.Input<string>;
}