1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getNetworkVirtualApplianceConnection
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.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.network.getNetworkVirtualApplianceConnection

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.3.0 published on Monday, Apr 28, 2025 by Pulumi

    Retrieves the details of specified NVA connection.

    Uses Azure REST API version 2024-05-01.

    Other available API versions: 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-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 getNetworkVirtualApplianceConnection

    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 getNetworkVirtualApplianceConnection(args: GetNetworkVirtualApplianceConnectionArgs, opts?: InvokeOptions): Promise<GetNetworkVirtualApplianceConnectionResult>
    function getNetworkVirtualApplianceConnectionOutput(args: GetNetworkVirtualApplianceConnectionOutputArgs, opts?: InvokeOptions): Output<GetNetworkVirtualApplianceConnectionResult>
    def get_network_virtual_appliance_connection(connection_name: Optional[str] = None,
                                                 network_virtual_appliance_name: Optional[str] = None,
                                                 resource_group_name: Optional[str] = None,
                                                 opts: Optional[InvokeOptions] = None) -> GetNetworkVirtualApplianceConnectionResult
    def get_network_virtual_appliance_connection_output(connection_name: Optional[pulumi.Input[str]] = None,
                                                 network_virtual_appliance_name: Optional[pulumi.Input[str]] = None,
                                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                                 opts: Optional[InvokeOptions] = None) -> Output[GetNetworkVirtualApplianceConnectionResult]
    func LookupNetworkVirtualApplianceConnection(ctx *Context, args *LookupNetworkVirtualApplianceConnectionArgs, opts ...InvokeOption) (*LookupNetworkVirtualApplianceConnectionResult, error)
    func LookupNetworkVirtualApplianceConnectionOutput(ctx *Context, args *LookupNetworkVirtualApplianceConnectionOutputArgs, opts ...InvokeOption) LookupNetworkVirtualApplianceConnectionResultOutput

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

    public static class GetNetworkVirtualApplianceConnection 
    {
        public static Task<GetNetworkVirtualApplianceConnectionResult> InvokeAsync(GetNetworkVirtualApplianceConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetNetworkVirtualApplianceConnectionResult> Invoke(GetNetworkVirtualApplianceConnectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNetworkVirtualApplianceConnectionResult> getNetworkVirtualApplianceConnection(GetNetworkVirtualApplianceConnectionArgs args, InvokeOptions options)
    public static Output<GetNetworkVirtualApplianceConnectionResult> getNetworkVirtualApplianceConnection(GetNetworkVirtualApplianceConnectionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:network:getNetworkVirtualApplianceConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ConnectionName string
    The name of the NVA connection.
    NetworkVirtualApplianceName string
    The name of the Network Virtual Appliance.
    ResourceGroupName string
    The name of the resource group.
    ConnectionName string
    The name of the NVA connection.
    NetworkVirtualApplianceName string
    The name of the Network Virtual Appliance.
    ResourceGroupName string
    The name of the resource group.
    connectionName String
    The name of the NVA connection.
    networkVirtualApplianceName String
    The name of the Network Virtual Appliance.
    resourceGroupName String
    The name of the resource group.
    connectionName string
    The name of the NVA connection.
    networkVirtualApplianceName string
    The name of the Network Virtual Appliance.
    resourceGroupName string
    The name of the resource group.
    connection_name str
    The name of the NVA connection.
    network_virtual_appliance_name str
    The name of the Network Virtual Appliance.
    resource_group_name str
    The name of the resource group.
    connectionName String
    The name of the NVA connection.
    networkVirtualApplianceName String
    The name of the Network Virtual Appliance.
    resourceGroupName String
    The name of the resource group.

    getNetworkVirtualApplianceConnection Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Properties Pulumi.AzureNative.Network.Outputs.NetworkVirtualApplianceConnectionPropertiesResponse
    Properties of the express route connection.
    Id string
    Resource ID.
    Name string
    The name of the resource.
    AzureApiVersion string
    The Azure API version of the resource.
    Properties NetworkVirtualApplianceConnectionPropertiesResponse
    Properties of the express route connection.
    Id string
    Resource ID.
    Name string
    The name of the resource.
    azureApiVersion String
    The Azure API version of the resource.
    properties NetworkVirtualApplianceConnectionPropertiesResponse
    Properties of the express route connection.
    id String
    Resource ID.
    name String
    The name of the resource.
    azureApiVersion string
    The Azure API version of the resource.
    properties NetworkVirtualApplianceConnectionPropertiesResponse
    Properties of the express route connection.
    id string
    Resource ID.
    name string
    The name of the resource.
    azure_api_version str
    The Azure API version of the resource.
    properties NetworkVirtualApplianceConnectionPropertiesResponse
    Properties of the express route connection.
    id str
    Resource ID.
    name str
    The name of the resource.
    azureApiVersion String
    The Azure API version of the resource.
    properties Property Map
    Properties of the express route connection.
    id String
    Resource ID.
    name String
    The name of the resource.

    Supporting Types

    NetworkVirtualApplianceConnectionPropertiesResponse

    ProvisioningState string
    The provisioning state of the NetworkVirtualApplianceConnection resource.
    Asn double
    Network Virtual Appliance ASN.
    BgpPeerAddress List<string>
    List of bgpPeerAddresses for the NVA instances
    EnableInternetSecurity bool
    Enable internet security.
    Name string
    The name of the resource.
    RoutingConfiguration Pulumi.AzureNative.Network.Inputs.RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    TunnelIdentifier double
    Unique identifier for the connection.
    ProvisioningState string
    The provisioning state of the NetworkVirtualApplianceConnection resource.
    Asn float64
    Network Virtual Appliance ASN.
    BgpPeerAddress []string
    List of bgpPeerAddresses for the NVA instances
    EnableInternetSecurity bool
    Enable internet security.
    Name string
    The name of the resource.
    RoutingConfiguration RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    TunnelIdentifier float64
    Unique identifier for the connection.
    provisioningState String
    The provisioning state of the NetworkVirtualApplianceConnection resource.
    asn Double
    Network Virtual Appliance ASN.
    bgpPeerAddress List<String>
    List of bgpPeerAddresses for the NVA instances
    enableInternetSecurity Boolean
    Enable internet security.
    name String
    The name of the resource.
    routingConfiguration RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    tunnelIdentifier Double
    Unique identifier for the connection.
    provisioningState string
    The provisioning state of the NetworkVirtualApplianceConnection resource.
    asn number
    Network Virtual Appliance ASN.
    bgpPeerAddress string[]
    List of bgpPeerAddresses for the NVA instances
    enableInternetSecurity boolean
    Enable internet security.
    name string
    The name of the resource.
    routingConfiguration RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    tunnelIdentifier number
    Unique identifier for the connection.
    provisioning_state str
    The provisioning state of the NetworkVirtualApplianceConnection resource.
    asn float
    Network Virtual Appliance ASN.
    bgp_peer_address Sequence[str]
    List of bgpPeerAddresses for the NVA instances
    enable_internet_security bool
    Enable internet security.
    name str
    The name of the resource.
    routing_configuration RoutingConfigurationResponse
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    tunnel_identifier float
    Unique identifier for the connection.
    provisioningState String
    The provisioning state of the NetworkVirtualApplianceConnection resource.
    asn Number
    Network Virtual Appliance ASN.
    bgpPeerAddress List<String>
    List of bgpPeerAddresses for the NVA instances
    enableInternetSecurity Boolean
    Enable internet security.
    name String
    The name of the resource.
    routingConfiguration Property Map
    The Routing Configuration indicating the associated and propagated route tables on this connection.
    tunnelIdentifier Number
    Unique identifier for the connection.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi