Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getVpnConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.5.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getVpnConnection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.5.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-azure-native

    Retrieves the details of a vpn connection.

    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 for details.

    Using getVpnConnection

    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 getVpnConnection(args: GetVpnConnectionArgs, opts?: InvokeOptions): Promise<GetVpnConnectionResult>
function getVpnConnectionOutput(args: GetVpnConnectionOutputArgs, opts?: InvokeOptions): Output<GetVpnConnectionResult>
    def get_vpn_connection(connection_name: Optional[str] = None,
                       gateway_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetVpnConnectionResult
def get_vpn_connection_output(connection_name: Optional[pulumi.Input[str]] = None,
                       gateway_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetVpnConnectionResult]
    func LookupVpnConnection(ctx *Context, args *LookupVpnConnectionArgs, opts ...InvokeOption) (*LookupVpnConnectionResult, error)
func LookupVpnConnectionOutput(ctx *Context, args *LookupVpnConnectionOutputArgs, opts ...InvokeOption) LookupVpnConnectionResultOutput

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

    public static class GetVpnConnection 
{
    public static Task<GetVpnConnectionResult> InvokeAsync(GetVpnConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetVpnConnectionResult> Invoke(GetVpnConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVpnConnectionResult> getVpnConnection(GetVpnConnectionArgs args, InvokeOptions options)
public static Output<GetVpnConnectionResult> getVpnConnection(GetVpnConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:network:getVpnConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ConnectionName string
    The name of the vpn connection.
    GatewayName string
    The name of the gateway.
    ResourceGroupName string
    The resource group name of the VpnGateway.
    ConnectionName string
    The name of the vpn connection.
    GatewayName string
    The name of the gateway.
    ResourceGroupName string
    The resource group name of the VpnGateway.
    connectionName String
    The name of the vpn connection.
    gatewayName String
    The name of the gateway.
    resourceGroupName String
    The resource group name of the VpnGateway.
    connectionName string
    The name of the vpn connection.
    gatewayName string
    The name of the gateway.
    resourceGroupName string
    The resource group name of the VpnGateway.
    connection_name str
    The name of the vpn connection.
    gateway_name str
    The name of the gateway.
    resource_group_name str
    The resource group name of the VpnGateway.
    connectionName String
    The name of the vpn connection.
    gatewayName String
    The name of the gateway.
    resourceGroupName String
    The resource group name of the VpnGateway.

    getVpnConnection Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    ConnectionStatus string
    The connection status.
    EgressBytesTransferred double
    Egress bytes transferred.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    IngressBytesTransferred double
    Ingress bytes transferred.
    ProvisioningState string
    The provisioning state of the VPN connection resource.
    ConnectionBandwidth int
    Expected bandwidth in MBPS.
    DpdTimeoutSeconds int
    DPD timeout in seconds for vpn connection.
    EnableBgp bool
    EnableBgp flag.
    EnableInternetSecurity bool
    Enable internet security.
    EnableRateLimiting bool
    EnableBgp flag.
    Id string
    Resource ID.
    IpsecPolicies List<Pulumi.AzureNative.Network.Outputs.IpsecPolicyResponse>
    The IPSec Policies to be considered by this connection.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    RemoteVpnSite Pulumi.AzureNative.Network.Outputs.SubResourceResponse
    Id of the connected vpn site.
    RoutingConfiguration Pulumi.AzureNative.Network.Outputs.RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    RoutingWeight int
    Routing weight for vpn connection.
    SharedKey string
    SharedKey for the vpn connection.
    TrafficSelectorPolicies List<Pulumi.AzureNative.Network.Outputs.TrafficSelectorPolicyResponse>
    The Traffic Selector Policies to be considered by this connection.
    UseLocalAzureIpAddress bool
    Use local azure ip to initiate connection.
    UsePolicyBasedTrafficSelectors bool
    Enable policy-based traffic selectors.
    VpnConnectionProtocolType string
    Connection protocol used for this connection.
    VpnLinkConnections List<Pulumi.AzureNative.Network.Outputs.VpnSiteLinkConnectionResponse>
    List of all vpn site link connections to the gateway.
    AzureApiVersion string
    The Azure API version of the resource.
    ConnectionStatus string
    The connection status.
    EgressBytesTransferred float64
    Egress bytes transferred.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    IngressBytesTransferred float64
    Ingress bytes transferred.
    ProvisioningState string
    The provisioning state of the VPN connection resource.
    ConnectionBandwidth int
    Expected bandwidth in MBPS.
    DpdTimeoutSeconds int
    DPD timeout in seconds for vpn connection.
    EnableBgp bool
    EnableBgp flag.
    EnableInternetSecurity bool
    Enable internet security.
    EnableRateLimiting bool
    EnableBgp flag.
    Id string
    Resource ID.
    IpsecPolicies []IpsecPolicyResponse
    The IPSec Policies to be considered by this connection.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    RemoteVpnSite SubResourceResponse
    Id of the connected vpn site.
    RoutingConfiguration RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    RoutingWeight int
    Routing weight for vpn connection.
    SharedKey string
    SharedKey for the vpn connection.
    TrafficSelectorPolicies []TrafficSelectorPolicyResponse
    The Traffic Selector Policies to be considered by this connection.
    UseLocalAzureIpAddress bool
    Use local azure ip to initiate connection.
    UsePolicyBasedTrafficSelectors bool
    Enable policy-based traffic selectors.
    VpnConnectionProtocolType string
    Connection protocol used for this connection.
    VpnLinkConnections []VpnSiteLinkConnectionResponse
    List of all vpn site link connections to the gateway.
    azureApiVersion String
    The Azure API version of the resource.
    connectionStatus String
    The connection status.
    egressBytesTransferred Double
    Egress bytes transferred.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    ingressBytesTransferred Double
    Ingress bytes transferred.
    provisioningState String
    The provisioning state of the VPN connection resource.
    connectionBandwidth Integer
    Expected bandwidth in MBPS.
    dpdTimeoutSeconds Integer
    DPD timeout in seconds for vpn connection.
    enableBgp Boolean
    EnableBgp flag.
    enableInternetSecurity Boolean
    Enable internet security.
    enableRateLimiting Boolean
    EnableBgp flag.
    id String
    Resource ID.
    ipsecPolicies List<IpsecPolicyResponse>
    The IPSec Policies to be considered by this connection.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    remoteVpnSite SubResourceResponse
    Id of the connected vpn site.
    routingConfiguration RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    routingWeight Integer
    Routing weight for vpn connection.
    sharedKey String
    SharedKey for the vpn connection.
    trafficSelectorPolicies List<TrafficSelectorPolicyResponse>
    The Traffic Selector Policies to be considered by this connection.
    useLocalAzureIpAddress Boolean
    Use local azure ip to initiate connection.
    usePolicyBasedTrafficSelectors Boolean
    Enable policy-based traffic selectors.
    vpnConnectionProtocolType String
    Connection protocol used for this connection.
    vpnLinkConnections List<VpnSiteLinkConnectionResponse>
    List of all vpn site link connections to the gateway.
    azureApiVersion string
    The Azure API version of the resource.
    connectionStatus string
    The connection status.
    egressBytesTransferred number
    Egress bytes transferred.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    ingressBytesTransferred number
    Ingress bytes transferred.
    provisioningState string
    The provisioning state of the VPN connection resource.
    connectionBandwidth number
    Expected bandwidth in MBPS.
    dpdTimeoutSeconds number
    DPD timeout in seconds for vpn connection.
    enableBgp boolean
    EnableBgp flag.
    enableInternetSecurity boolean
    Enable internet security.
    enableRateLimiting boolean
    EnableBgp flag.
    id string
    Resource ID.
    ipsecPolicies IpsecPolicyResponse[]
    The IPSec Policies to be considered by this connection.
    name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    remoteVpnSite SubResourceResponse
    Id of the connected vpn site.
    routingConfiguration RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    routingWeight number
    Routing weight for vpn connection.
    sharedKey string
    SharedKey for the vpn connection.
    trafficSelectorPolicies TrafficSelectorPolicyResponse[]
    The Traffic Selector Policies to be considered by this connection.
    useLocalAzureIpAddress boolean
    Use local azure ip to initiate connection.
    usePolicyBasedTrafficSelectors boolean
    Enable policy-based traffic selectors.
    vpnConnectionProtocolType string
    Connection protocol used for this connection.
    vpnLinkConnections VpnSiteLinkConnectionResponse[]
    List of all vpn site link connections to the gateway.
    azure_api_version str
    The Azure API version of the resource.
    connection_status str
    The connection status.
    egress_bytes_transferred float
    Egress bytes transferred.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    ingress_bytes_transferred float
    Ingress bytes transferred.
    provisioning_state str
    The provisioning state of the VPN connection resource.
    connection_bandwidth int
    Expected bandwidth in MBPS.
    dpd_timeout_seconds int
    DPD timeout in seconds for vpn connection.
    enable_bgp bool
    EnableBgp flag.
    enable_internet_security bool
    Enable internet security.
    enable_rate_limiting bool
    EnableBgp flag.
    id str
    Resource ID.
    ipsec_policies Sequence[IpsecPolicyResponse]
    The IPSec Policies to be considered by this connection.
    name str
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    remote_vpn_site SubResourceResponse
    Id of the connected vpn site.
    routing_configuration RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    routing_weight int
    Routing weight for vpn connection.
    shared_key str
    SharedKey for the vpn connection.
    traffic_selector_policies Sequence[TrafficSelectorPolicyResponse]
    The Traffic Selector Policies to be considered by this connection.
    use_local_azure_ip_address bool
    Use local azure ip to initiate connection.
    use_policy_based_traffic_selectors bool
    Enable policy-based traffic selectors.
    vpn_connection_protocol_type str
    Connection protocol used for this connection.
    vpn_link_connections Sequence[VpnSiteLinkConnectionResponse]
    List of all vpn site link connections to the gateway.
    azureApiVersion String
    The Azure API version of the resource.
    connectionStatus String
    The connection status.
    egressBytesTransferred Number
    Egress bytes transferred.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    ingressBytesTransferred Number
    Ingress bytes transferred.
    provisioningState String
    The provisioning state of the VPN connection resource.
    connectionBandwidth Number
    Expected bandwidth in MBPS.
    dpdTimeoutSeconds Number
    DPD timeout in seconds for vpn connection.
    enableBgp Boolean
    EnableBgp flag.
    enableInternetSecurity Boolean
    Enable internet security.
    enableRateLimiting Boolean
    EnableBgp flag.
    id String
    Resource ID.
    ipsecPolicies List<Property Map>
    The IPSec Policies to be considered by this connection.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    remoteVpnSite Property Map
    Id of the connected vpn site.
    routingConfiguration Property Map
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    routingWeight Number
    Routing weight for vpn connection.
    sharedKey String
    SharedKey for the vpn connection.
    trafficSelectorPolicies List<Property Map>
    The Traffic Selector Policies to be considered by this connection.
    useLocalAzureIpAddress Boolean
    Use local azure ip to initiate connection.
    usePolicyBasedTrafficSelectors Boolean
    Enable policy-based traffic selectors.
    vpnConnectionProtocolType String
    Connection protocol used for this connection.
    vpnLinkConnections List<Property Map>
    List of all vpn site link connections to the gateway.

    Supporting Types

    GatewayCustomBgpIpAddressIpConfigurationResponse

    CustomBgpIpAddress string
    The custom BgpPeeringAddress which belongs to IpconfigurationId.
    IpConfigurationId string
    The IpconfigurationId of ipconfiguration which belongs to gateway.
    CustomBgpIpAddress string
    The custom BgpPeeringAddress which belongs to IpconfigurationId.
    IpConfigurationId string
    The IpconfigurationId of ipconfiguration which belongs to gateway.
    customBgpIpAddress String
    The custom BgpPeeringAddress which belongs to IpconfigurationId.
    ipConfigurationId String
    The IpconfigurationId of ipconfiguration which belongs to gateway.
    customBgpIpAddress string
    The custom BgpPeeringAddress which belongs to IpconfigurationId.
    ipConfigurationId string
    The IpconfigurationId of ipconfiguration which belongs to gateway.
    custom_bgp_ip_address str
    The custom BgpPeeringAddress which belongs to IpconfigurationId.
    ip_configuration_id str
    The IpconfigurationId of ipconfiguration which belongs to gateway.
    customBgpIpAddress String
    The custom BgpPeeringAddress which belongs to IpconfigurationId.
    ipConfigurationId String
    The IpconfigurationId of ipconfiguration which belongs to gateway.

    IpsecPolicyResponse

    DhGroup string
    The DH Group used in IKE Phase 1 for initial SA.
    IkeEncryption string
    The IKE encryption algorithm (IKE phase 2).
    IkeIntegrity string
    The IKE integrity algorithm (IKE phase 2).
    IpsecEncryption string
    The IPSec encryption algorithm (IKE phase 1).
    IpsecIntegrity string
    The IPSec integrity algorithm (IKE phase 1).
    PfsGroup string
    The Pfs Group used in IKE Phase 2 for new child SA.
    SaDataSizeKilobytes int
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
    SaLifeTimeSeconds int
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
    DhGroup string
    The DH Group used in IKE Phase 1 for initial SA.
    IkeEncryption string
    The IKE encryption algorithm (IKE phase 2).
    IkeIntegrity string
    The IKE integrity algorithm (IKE phase 2).
    IpsecEncryption string
    The IPSec encryption algorithm (IKE phase 1).
    IpsecIntegrity string
    The IPSec integrity algorithm (IKE phase 1).
    PfsGroup string
    The Pfs Group used in IKE Phase 2 for new child SA.
    SaDataSizeKilobytes int
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
    SaLifeTimeSeconds int
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
    dhGroup String
    The DH Group used in IKE Phase 1 for initial SA.
    ikeEncryption String
    The IKE encryption algorithm (IKE phase 2).
    ikeIntegrity String
    The IKE integrity algorithm (IKE phase 2).
    ipsecEncryption String
    The IPSec encryption algorithm (IKE phase 1).
    ipsecIntegrity String
    The IPSec integrity algorithm (IKE phase 1).
    pfsGroup String
    The Pfs Group used in IKE Phase 2 for new child SA.
    saDataSizeKilobytes Integer
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
    saLifeTimeSeconds Integer
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
    dhGroup string
    The DH Group used in IKE Phase 1 for initial SA.
    ikeEncryption string
    The IKE encryption algorithm (IKE phase 2).
    ikeIntegrity string
    The IKE integrity algorithm (IKE phase 2).
    ipsecEncryption string
    The IPSec encryption algorithm (IKE phase 1).
    ipsecIntegrity string
    The IPSec integrity algorithm (IKE phase 1).
    pfsGroup string
    The Pfs Group used in IKE Phase 2 for new child SA.
    saDataSizeKilobytes number
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
    saLifeTimeSeconds number
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
    dh_group str
    The DH Group used in IKE Phase 1 for initial SA.
    ike_encryption str
    The IKE encryption algorithm (IKE phase 2).
    ike_integrity str
    The IKE integrity algorithm (IKE phase 2).
    ipsec_encryption str
    The IPSec encryption algorithm (IKE phase 1).
    ipsec_integrity str
    The IPSec integrity algorithm (IKE phase 1).
    pfs_group str
    The Pfs Group used in IKE Phase 2 for new child SA.
    sa_data_size_kilobytes int
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
    sa_life_time_seconds int
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.
    dhGroup String
    The DH Group used in IKE Phase 1 for initial SA.
    ikeEncryption String
    The IKE encryption algorithm (IKE phase 2).
    ikeIntegrity String
    The IKE integrity algorithm (IKE phase 2).
    ipsecEncryption String
    The IPSec encryption algorithm (IKE phase 1).
    ipsecIntegrity String
    The IPSec integrity algorithm (IKE phase 1).
    pfsGroup String
    The Pfs Group used in IKE Phase 2 for new child SA.
    saDataSizeKilobytes Number
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel.
    saLifeTimeSeconds Number
    The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel.

    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.

    TrafficSelectorPolicyResponse

    LocalAddressRanges List<string>
    A collection of local address spaces in CIDR format.
    RemoteAddressRanges List<string>
    A collection of remote address spaces in CIDR format.
    LocalAddressRanges []string
    A collection of local address spaces in CIDR format.
    RemoteAddressRanges []string
    A collection of remote address spaces in CIDR format.
    localAddressRanges List<String>
    A collection of local address spaces in CIDR format.
    remoteAddressRanges List<String>
    A collection of remote address spaces in CIDR format.
    localAddressRanges string[]
    A collection of local address spaces in CIDR format.
    remoteAddressRanges string[]
    A collection of remote address spaces in CIDR format.
    local_address_ranges Sequence[str]
    A collection of local address spaces in CIDR format.
    remote_address_ranges Sequence[str]
    A collection of remote address spaces in CIDR format.
    localAddressRanges List<String>
    A collection of local address spaces in CIDR format.
    remoteAddressRanges List<String>
    A collection of remote address spaces in CIDR format.

    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.

    VpnSiteLinkConnectionResponse

    ConnectionStatus string
    The connection status.
    EgressBytesTransferred double
    Egress bytes transferred.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    IngressBytesTransferred double
    Ingress bytes transferred.
    ProvisioningState string
    The provisioning state of the VPN site link connection resource.
    Type string
    Resource type.
    ConnectionBandwidth int
    Expected bandwidth in MBPS.
    DpdTimeoutSeconds int
    Dead Peer Detection timeout in seconds for VpnLink connection.
    EgressNatRules List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
    List of egress NatRules.
    EnableBgp bool
    EnableBgp flag.
    EnableRateLimiting bool
    EnableBgp flag.
    Id string
    Resource ID.
    IngressNatRules List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
    List of ingress NatRules.
    IpsecPolicies List<Pulumi.AzureNative.Network.Inputs.IpsecPolicyResponse>
    The IPSec Policies to be considered by this connection.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    RoutingWeight int
    Routing weight for vpn connection.
    SharedKey string
    SharedKey for the vpn connection.
    UseLocalAzureIpAddress bool
    Use local azure ip to initiate connection.
    UsePolicyBasedTrafficSelectors bool
    Enable policy-based traffic selectors.
    VpnConnectionProtocolType string
    Connection protocol used for this connection.
    VpnGatewayCustomBgpAddresses List<Pulumi.AzureNative.Network.Inputs.GatewayCustomBgpIpAddressIpConfigurationResponse>
    vpnGatewayCustomBgpAddresses used by this connection.
    VpnLinkConnectionMode string
    Vpn link connection mode.
    VpnSiteLink Pulumi.AzureNative.Network.Inputs.SubResourceResponse
    Id of the connected vpn site link.
    ConnectionStatus string
    The connection status.
    EgressBytesTransferred float64
    Egress bytes transferred.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    IngressBytesTransferred float64
    Ingress bytes transferred.
    ProvisioningState string
    The provisioning state of the VPN site link connection resource.
    Type string
    Resource type.
    ConnectionBandwidth int
    Expected bandwidth in MBPS.
    DpdTimeoutSeconds int
    Dead Peer Detection timeout in seconds for VpnLink connection.
    EgressNatRules []SubResourceResponse
    List of egress NatRules.
    EnableBgp bool
    EnableBgp flag.
    EnableRateLimiting bool
    EnableBgp flag.
    Id string
    Resource ID.
    IngressNatRules []SubResourceResponse
    List of ingress NatRules.
    IpsecPolicies []IpsecPolicyResponse
    The IPSec Policies to be considered by this connection.
    Name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    RoutingWeight int
    Routing weight for vpn connection.
    SharedKey string
    SharedKey for the vpn connection.
    UseLocalAzureIpAddress bool
    Use local azure ip to initiate connection.
    UsePolicyBasedTrafficSelectors bool
    Enable policy-based traffic selectors.
    VpnConnectionProtocolType string
    Connection protocol used for this connection.
    VpnGatewayCustomBgpAddresses []GatewayCustomBgpIpAddressIpConfigurationResponse
    vpnGatewayCustomBgpAddresses used by this connection.
    VpnLinkConnectionMode string
    Vpn link connection mode.
    VpnSiteLink SubResourceResponse
    Id of the connected vpn site link.
    connectionStatus String
    The connection status.
    egressBytesTransferred Double
    Egress bytes transferred.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    ingressBytesTransferred Double
    Ingress bytes transferred.
    provisioningState String
    The provisioning state of the VPN site link connection resource.
    type String
    Resource type.
    connectionBandwidth Integer
    Expected bandwidth in MBPS.
    dpdTimeoutSeconds Integer
    Dead Peer Detection timeout in seconds for VpnLink connection.
    egressNatRules List<SubResourceResponse>
    List of egress NatRules.
    enableBgp Boolean
    EnableBgp flag.
    enableRateLimiting Boolean
    EnableBgp flag.
    id String
    Resource ID.
    ingressNatRules List<SubResourceResponse>
    List of ingress NatRules.
    ipsecPolicies List<IpsecPolicyResponse>
    The IPSec Policies to be considered by this connection.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    routingWeight Integer
    Routing weight for vpn connection.
    sharedKey String
    SharedKey for the vpn connection.
    useLocalAzureIpAddress Boolean
    Use local azure ip to initiate connection.
    usePolicyBasedTrafficSelectors Boolean
    Enable policy-based traffic selectors.
    vpnConnectionProtocolType String
    Connection protocol used for this connection.
    vpnGatewayCustomBgpAddresses List<GatewayCustomBgpIpAddressIpConfigurationResponse>
    vpnGatewayCustomBgpAddresses used by this connection.
    vpnLinkConnectionMode String
    Vpn link connection mode.
    vpnSiteLink SubResourceResponse
    Id of the connected vpn site link.
    connectionStatus string
    The connection status.
    egressBytesTransferred number
    Egress bytes transferred.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    ingressBytesTransferred number
    Ingress bytes transferred.
    provisioningState string
    The provisioning state of the VPN site link connection resource.
    type string
    Resource type.
    connectionBandwidth number
    Expected bandwidth in MBPS.
    dpdTimeoutSeconds number
    Dead Peer Detection timeout in seconds for VpnLink connection.
    egressNatRules SubResourceResponse[]
    List of egress NatRules.
    enableBgp boolean
    EnableBgp flag.
    enableRateLimiting boolean
    EnableBgp flag.
    id string
    Resource ID.
    ingressNatRules SubResourceResponse[]
    List of ingress NatRules.
    ipsecPolicies IpsecPolicyResponse[]
    The IPSec Policies to be considered by this connection.
    name string
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    routingWeight number
    Routing weight for vpn connection.
    sharedKey string
    SharedKey for the vpn connection.
    useLocalAzureIpAddress boolean
    Use local azure ip to initiate connection.
    usePolicyBasedTrafficSelectors boolean
    Enable policy-based traffic selectors.
    vpnConnectionProtocolType string
    Connection protocol used for this connection.
    vpnGatewayCustomBgpAddresses GatewayCustomBgpIpAddressIpConfigurationResponse[]
    vpnGatewayCustomBgpAddresses used by this connection.
    vpnLinkConnectionMode string
    Vpn link connection mode.
    vpnSiteLink SubResourceResponse
    Id of the connected vpn site link.
    connection_status str
    The connection status.
    egress_bytes_transferred float
    Egress bytes transferred.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    ingress_bytes_transferred float
    Ingress bytes transferred.
    provisioning_state str
    The provisioning state of the VPN site link connection resource.
    type str
    Resource type.
    connection_bandwidth int
    Expected bandwidth in MBPS.
    dpd_timeout_seconds int
    Dead Peer Detection timeout in seconds for VpnLink connection.
    egress_nat_rules Sequence[SubResourceResponse]
    List of egress NatRules.
    enable_bgp bool
    EnableBgp flag.
    enable_rate_limiting bool
    EnableBgp flag.
    id str
    Resource ID.
    ingress_nat_rules Sequence[SubResourceResponse]
    List of ingress NatRules.
    ipsec_policies Sequence[IpsecPolicyResponse]
    The IPSec Policies to be considered by this connection.
    name str
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    routing_weight int
    Routing weight for vpn connection.
    shared_key str
    SharedKey for the vpn connection.
    use_local_azure_ip_address bool
    Use local azure ip to initiate connection.
    use_policy_based_traffic_selectors bool
    Enable policy-based traffic selectors.
    vpn_connection_protocol_type str
    Connection protocol used for this connection.
    vpn_gateway_custom_bgp_addresses Sequence[GatewayCustomBgpIpAddressIpConfigurationResponse]
    vpnGatewayCustomBgpAddresses used by this connection.
    vpn_link_connection_mode str
    Vpn link connection mode.
    vpn_site_link SubResourceResponse
    Id of the connected vpn site link.
    connectionStatus String
    The connection status.
    egressBytesTransferred Number
    Egress bytes transferred.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    ingressBytesTransferred Number
    Ingress bytes transferred.
    provisioningState String
    The provisioning state of the VPN site link connection resource.
    type String
    Resource type.
    connectionBandwidth Number
    Expected bandwidth in MBPS.
    dpdTimeoutSeconds Number
    Dead Peer Detection timeout in seconds for VpnLink connection.
    egressNatRules List<Property Map>
    List of egress NatRules.
    enableBgp Boolean
    EnableBgp flag.
    enableRateLimiting Boolean
    EnableBgp flag.
    id String
    Resource ID.
    ingressNatRules List<Property Map>
    List of ingress NatRules.
    ipsecPolicies List<Property Map>
    The IPSec Policies to be considered by this connection.
    name String
    The name of the resource that is unique within a resource group. This name can be used to access the resource.
    routingWeight Number
    Routing weight for vpn connection.
    sharedKey String
    SharedKey for the vpn connection.
    useLocalAzureIpAddress Boolean
    Use local azure ip to initiate connection.
    usePolicyBasedTrafficSelectors Boolean
    Enable policy-based traffic selectors.
    vpnConnectionProtocolType String
    Connection protocol used for this connection.
    vpnGatewayCustomBgpAddresses List<Property Map>
    vpnGatewayCustomBgpAddresses used by this connection.
    vpnLinkConnectionMode String
    Vpn link connection mode.
    vpnSiteLink Property Map
    Id of the connected vpn site link.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.5.0 published on Monday, May 19, 2025 by Pulumi
    pulumi/pulumi-azure-native