1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getHubVirtualNetworkConnection
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.46.0 published on Friday, Jun 21, 2024 by Pulumi

azure-native.network.getHubVirtualNetworkConnection

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.46.0 published on Friday, Jun 21, 2024 by Pulumi

    Retrieves the details of a HubVirtualNetworkConnection. Azure REST API version: 2023-02-01.

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

    Using getHubVirtualNetworkConnection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getHubVirtualNetworkConnection(args: GetHubVirtualNetworkConnectionArgs, opts?: InvokeOptions): Promise<GetHubVirtualNetworkConnectionResult>
    function getHubVirtualNetworkConnectionOutput(args: GetHubVirtualNetworkConnectionOutputArgs, opts?: InvokeOptions): Output<GetHubVirtualNetworkConnectionResult>
    def get_hub_virtual_network_connection(connection_name: Optional[str] = None,
                                           resource_group_name: Optional[str] = None,
                                           virtual_hub_name: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetHubVirtualNetworkConnectionResult
    def get_hub_virtual_network_connection_output(connection_name: Optional[pulumi.Input[str]] = None,
                                           resource_group_name: Optional[pulumi.Input[str]] = None,
                                           virtual_hub_name: Optional[pulumi.Input[str]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[GetHubVirtualNetworkConnectionResult]
    func LookupHubVirtualNetworkConnection(ctx *Context, args *LookupHubVirtualNetworkConnectionArgs, opts ...InvokeOption) (*LookupHubVirtualNetworkConnectionResult, error)
    func LookupHubVirtualNetworkConnectionOutput(ctx *Context, args *LookupHubVirtualNetworkConnectionOutputArgs, opts ...InvokeOption) LookupHubVirtualNetworkConnectionResultOutput

    > Note: This function is named LookupHubVirtualNetworkConnection in the Go SDK.

    public static class GetHubVirtualNetworkConnection 
    {
        public static Task<GetHubVirtualNetworkConnectionResult> InvokeAsync(GetHubVirtualNetworkConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetHubVirtualNetworkConnectionResult> Invoke(GetHubVirtualNetworkConnectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHubVirtualNetworkConnectionResult> getHubVirtualNetworkConnection(GetHubVirtualNetworkConnectionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:network:getHubVirtualNetworkConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ConnectionName string
    The name of the vpn connection.
    ResourceGroupName string
    The resource group name of the VirtualHub.
    VirtualHubName string
    The name of the VirtualHub.
    ConnectionName string
    The name of the vpn connection.
    ResourceGroupName string
    The resource group name of the VirtualHub.
    VirtualHubName string
    The name of the VirtualHub.
    connectionName String
    The name of the vpn connection.
    resourceGroupName String
    The resource group name of the VirtualHub.
    virtualHubName String
    The name of the VirtualHub.
    connectionName string
    The name of the vpn connection.
    resourceGroupName string
    The resource group name of the VirtualHub.
    virtualHubName string
    The name of the VirtualHub.
    connection_name str
    The name of the vpn connection.
    resource_group_name str
    The resource group name of the VirtualHub.
    virtual_hub_name str
    The name of the VirtualHub.
    connectionName String
    The name of the vpn connection.
    resourceGroupName String
    The resource group name of the VirtualHub.
    virtualHubName String
    The name of the VirtualHub.

    getHubVirtualNetworkConnection Result

    The following output properties are available:

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the hub virtual network connection resource.
    AllowHubToRemoteVnetTransit bool
    Deprecated: VirtualHub to RemoteVnet transit to enabled or not.
    AllowRemoteVnetToUseHubVnetGateways bool
    Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.
    EnableInternetSecurity bool
    Enable internet security.
    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.
    RemoteVirtualNetwork Pulumi.AzureNative.Network.Outputs.SubResourceResponse
    Reference to the remote virtual network.
    RoutingConfiguration Pulumi.AzureNative.Network.Outputs.RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the hub virtual network connection resource.
    AllowHubToRemoteVnetTransit bool
    Deprecated: VirtualHub to RemoteVnet transit to enabled or not.
    AllowRemoteVnetToUseHubVnetGateways bool
    Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.
    EnableInternetSecurity bool
    Enable internet security.
    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.
    RemoteVirtualNetwork SubResourceResponse
    Reference to the remote virtual network.
    RoutingConfiguration RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the hub virtual network connection resource.
    allowHubToRemoteVnetTransit Boolean
    Deprecated: VirtualHub to RemoteVnet transit to enabled or not.
    allowRemoteVnetToUseHubVnetGateways Boolean
    Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.
    enableInternetSecurity Boolean
    Enable internet security.
    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.
    remoteVirtualNetwork SubResourceResponse
    Reference to the remote virtual network.
    routingConfiguration RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    provisioningState string
    The provisioning state of the hub virtual network connection resource.
    allowHubToRemoteVnetTransit boolean
    Deprecated: VirtualHub to RemoteVnet transit to enabled or not.
    allowRemoteVnetToUseHubVnetGateways boolean
    Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.
    enableInternetSecurity boolean
    Enable internet security.
    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.
    remoteVirtualNetwork SubResourceResponse
    Reference to the remote virtual network.
    routingConfiguration RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    provisioning_state str
    The provisioning state of the hub virtual network connection resource.
    allow_hub_to_remote_vnet_transit bool
    Deprecated: VirtualHub to RemoteVnet transit to enabled or not.
    allow_remote_vnet_to_use_hub_vnet_gateways bool
    Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.
    enable_internet_security bool
    Enable internet security.
    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.
    remote_virtual_network SubResourceResponse
    Reference to the remote virtual network.
    routing_configuration RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the hub virtual network connection resource.
    allowHubToRemoteVnetTransit Boolean
    Deprecated: VirtualHub to RemoteVnet transit to enabled or not.
    allowRemoteVnetToUseHubVnetGateways Boolean
    Deprecated: Allow RemoteVnet to use Virtual Hub's gateways.
    enableInternetSecurity Boolean
    Enable internet security.
    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.
    remoteVirtualNetwork Property Map
    Reference to the remote virtual network.
    routingConfiguration Property Map
    The Routing Configuration indicating the associated and propagated route tables on this connection.

    Supporting Types

    PropagatedRouteTableResponse

    Ids List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
    The list of resource ids of all the RouteTables.
    Labels List<string>
    The list of labels.
    Ids []SubResourceResponse
    The list of resource ids of all the RouteTables.
    Labels []string
    The list of labels.
    ids List<SubResourceResponse>
    The list of resource ids of all the RouteTables.
    labels List<String>
    The list of labels.
    ids SubResourceResponse[]
    The list of resource ids of all the RouteTables.
    labels string[]
    The list of labels.
    ids Sequence[SubResourceResponse]
    The list of resource ids of all the RouteTables.
    labels Sequence[str]
    The list of labels.
    ids List<Property Map>
    The list of resource ids of all the RouteTables.
    labels List<String>
    The list of labels.

    RoutingConfigurationResponse

    AssociatedRouteTable Pulumi.AzureNative.Network.Inputs.SubResourceResponse
    The resource id RouteTable associated with this RoutingConfiguration.
    InboundRouteMap Pulumi.AzureNative.Network.Inputs.SubResourceResponse
    The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
    OutboundRouteMap Pulumi.AzureNative.Network.Inputs.SubResourceResponse
    The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
    PropagatedRouteTables Pulumi.AzureNative.Network.Inputs.PropagatedRouteTableResponse
    The list of RouteTables to advertise the routes to.
    VnetRoutes Pulumi.AzureNative.Network.Inputs.VnetRouteResponse
    List of routes that control routing from VirtualHub into a virtual network connection.
    AssociatedRouteTable SubResourceResponse
    The resource id RouteTable associated with this RoutingConfiguration.
    InboundRouteMap SubResourceResponse
    The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
    OutboundRouteMap SubResourceResponse
    The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
    PropagatedRouteTables PropagatedRouteTableResponse
    The list of RouteTables to advertise the routes to.
    VnetRoutes VnetRouteResponse
    List of routes that control routing from VirtualHub into a virtual network connection.
    associatedRouteTable SubResourceResponse
    The resource id RouteTable associated with this RoutingConfiguration.
    inboundRouteMap SubResourceResponse
    The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
    outboundRouteMap SubResourceResponse
    The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
    propagatedRouteTables PropagatedRouteTableResponse
    The list of RouteTables to advertise the routes to.
    vnetRoutes VnetRouteResponse
    List of routes that control routing from VirtualHub into a virtual network connection.
    associatedRouteTable SubResourceResponse
    The resource id RouteTable associated with this RoutingConfiguration.
    inboundRouteMap SubResourceResponse
    The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
    outboundRouteMap SubResourceResponse
    The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
    propagatedRouteTables PropagatedRouteTableResponse
    The list of RouteTables to advertise the routes to.
    vnetRoutes VnetRouteResponse
    List of routes that control routing from VirtualHub into a virtual network connection.
    associated_route_table SubResourceResponse
    The resource id RouteTable associated with this RoutingConfiguration.
    inbound_route_map SubResourceResponse
    The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
    outbound_route_map SubResourceResponse
    The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
    propagated_route_tables PropagatedRouteTableResponse
    The list of RouteTables to advertise the routes to.
    vnet_routes VnetRouteResponse
    List of routes that control routing from VirtualHub into a virtual network connection.
    associatedRouteTable Property Map
    The resource id RouteTable associated with this RoutingConfiguration.
    inboundRouteMap Property Map
    The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
    outboundRouteMap Property Map
    The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
    propagatedRouteTables Property Map
    The list of RouteTables to advertise the routes to.
    vnetRoutes Property Map
    List of routes that control routing from VirtualHub into a virtual network connection.

    StaticRouteResponse

    AddressPrefixes List<string>
    List of all address prefixes.
    Name string
    The name of the StaticRoute that is unique within a VnetRoute.
    NextHopIpAddress string
    The ip address of the next hop.
    AddressPrefixes []string
    List of all address prefixes.
    Name string
    The name of the StaticRoute that is unique within a VnetRoute.
    NextHopIpAddress string
    The ip address of the next hop.
    addressPrefixes List<String>
    List of all address prefixes.
    name String
    The name of the StaticRoute that is unique within a VnetRoute.
    nextHopIpAddress String
    The ip address of the next hop.
    addressPrefixes string[]
    List of all address prefixes.
    name string
    The name of the StaticRoute that is unique within a VnetRoute.
    nextHopIpAddress string
    The ip address of the next hop.
    address_prefixes Sequence[str]
    List of all address prefixes.
    name str
    The name of the StaticRoute that is unique within a VnetRoute.
    next_hop_ip_address str
    The ip address of the next hop.
    addressPrefixes List<String>
    List of all address prefixes.
    name String
    The name of the StaticRoute that is unique within a VnetRoute.
    nextHopIpAddress String
    The ip address of the next hop.

    StaticRoutesConfigResponse

    PropagateStaticRoutes bool
    Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
    VnetLocalRouteOverrideCriteria string
    Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
    PropagateStaticRoutes bool
    Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
    VnetLocalRouteOverrideCriteria string
    Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
    propagateStaticRoutes Boolean
    Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
    vnetLocalRouteOverrideCriteria String
    Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
    propagateStaticRoutes boolean
    Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
    vnetLocalRouteOverrideCriteria string
    Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
    propagate_static_routes bool
    Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
    vnet_local_route_override_criteria str
    Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.
    propagateStaticRoutes Boolean
    Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
    vnetLocalRouteOverrideCriteria String
    Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.

    SubResourceResponse

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

    VnetRouteResponse

    BgpConnections []SubResourceResponse
    The list of references to HubBgpConnection objects.
    StaticRoutes []StaticRouteResponse
    List of all Static Routes.
    StaticRoutesConfig StaticRoutesConfigResponse
    Configuration for static routes on this HubVnetConnection.
    bgpConnections List<SubResourceResponse>
    The list of references to HubBgpConnection objects.
    staticRoutes List<StaticRouteResponse>
    List of all Static Routes.
    staticRoutesConfig StaticRoutesConfigResponse
    Configuration for static routes on this HubVnetConnection.
    bgpConnections SubResourceResponse[]
    The list of references to HubBgpConnection objects.
    staticRoutes StaticRouteResponse[]
    List of all Static Routes.
    staticRoutesConfig StaticRoutesConfigResponse
    Configuration for static routes on this HubVnetConnection.
    bgp_connections Sequence[SubResourceResponse]
    The list of references to HubBgpConnection objects.
    static_routes Sequence[StaticRouteResponse]
    List of all Static Routes.
    static_routes_config StaticRoutesConfigResponse
    Configuration for static routes on this HubVnetConnection.
    bgpConnections List<Property Map>
    The list of references to HubBgpConnection objects.
    staticRoutes List<Property Map>
    List of all Static Routes.
    staticRoutesConfig Property Map
    Configuration for static routes on this HubVnetConnection.

    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.46.0 published on Friday, Jun 21, 2024 by Pulumi