Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getP2sVpnGatewayP2sVpnConnectionHealth
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getP2sVpnGatewayP2sVpnConnectionHealth

Explore with Pulumi AI

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

Uses Azure REST API version 2024-05-01.

Other available API versions: 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. 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 getP2sVpnGatewayP2sVpnConnectionHealth

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 getP2sVpnGatewayP2sVpnConnectionHealth(args: GetP2sVpnGatewayP2sVpnConnectionHealthArgs, opts?: InvokeOptions): Promise<GetP2sVpnGatewayP2sVpnConnectionHealthResult>
function getP2sVpnGatewayP2sVpnConnectionHealthOutput(args: GetP2sVpnGatewayP2sVpnConnectionHealthOutputArgs, opts?: InvokeOptions): Output<GetP2sVpnGatewayP2sVpnConnectionHealthResult>
Copy
def get_p2s_vpn_gateway_p2s_vpn_connection_health(gateway_name: Optional[str] = None,
                                                  resource_group_name: Optional[str] = None,
                                                  opts: Optional[InvokeOptions] = None) -> GetP2sVpnGatewayP2sVpnConnectionHealthResult
def get_p2s_vpn_gateway_p2s_vpn_connection_health_output(gateway_name: Optional[pulumi.Input[str]] = None,
                                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                                  opts: Optional[InvokeOptions] = None) -> Output[GetP2sVpnGatewayP2sVpnConnectionHealthResult]
Copy
func GetP2sVpnGatewayP2sVpnConnectionHealth(ctx *Context, args *GetP2sVpnGatewayP2sVpnConnectionHealthArgs, opts ...InvokeOption) (*GetP2sVpnGatewayP2sVpnConnectionHealthResult, error)
func GetP2sVpnGatewayP2sVpnConnectionHealthOutput(ctx *Context, args *GetP2sVpnGatewayP2sVpnConnectionHealthOutputArgs, opts ...InvokeOption) GetP2sVpnGatewayP2sVpnConnectionHealthResultOutput
Copy

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

public static class GetP2sVpnGatewayP2sVpnConnectionHealth 
{
    public static Task<GetP2sVpnGatewayP2sVpnConnectionHealthResult> InvokeAsync(GetP2sVpnGatewayP2sVpnConnectionHealthArgs args, InvokeOptions? opts = null)
    public static Output<GetP2sVpnGatewayP2sVpnConnectionHealthResult> Invoke(GetP2sVpnGatewayP2sVpnConnectionHealthInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetP2sVpnGatewayP2sVpnConnectionHealthResult> getP2sVpnGatewayP2sVpnConnectionHealth(GetP2sVpnGatewayP2sVpnConnectionHealthArgs args, InvokeOptions options)
public static Output<GetP2sVpnGatewayP2sVpnConnectionHealthResult> getP2sVpnGatewayP2sVpnConnectionHealth(GetP2sVpnGatewayP2sVpnConnectionHealthArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getP2sVpnGatewayP2sVpnConnectionHealth
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the P2SVpnGateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the P2SVpnGateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the P2SVpnGateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
gatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the P2SVpnGateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
gateway_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the P2SVpnGateway.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the P2SVpnGateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getP2sVpnGatewayP2sVpnConnectionHealth Result

The following output properties are available:

Etag string
A unique read-only string that changes whenever the resource is updated.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
The provisioning state of the P2S VPN gateway resource.
Type string
Resource type.
VpnClientConnectionHealth Pulumi.AzureNative.Network.Outputs.VpnClientConnectionHealthResponse
All P2S VPN clients' connection health status.
CustomDnsServers List<string>
List of all customer specified DNS servers IP addresses.
Id string
Resource ID.
IsRoutingPreferenceInternet bool
Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
P2SConnectionConfigurations List<Pulumi.AzureNative.Network.Outputs.P2SConnectionConfigurationResponse>
List of all p2s connection configurations of the gateway.
Tags Dictionary<string, string>
Resource tags.
VirtualHub Pulumi.AzureNative.Network.Outputs.SubResourceResponse
The VirtualHub to which the gateway belongs.
VpnGatewayScaleUnit int
The scale unit for this p2s vpn gateway.
VpnServerConfiguration Pulumi.AzureNative.Network.Outputs.SubResourceResponse
The VpnServerConfiguration to which the p2sVpnGateway is attached to.
Etag string
A unique read-only string that changes whenever the resource is updated.
Location string
Resource location.
Name string
Resource name.
ProvisioningState string
The provisioning state of the P2S VPN gateway resource.
Type string
Resource type.
VpnClientConnectionHealth VpnClientConnectionHealthResponse
All P2S VPN clients' connection health status.
CustomDnsServers []string
List of all customer specified DNS servers IP addresses.
Id string
Resource ID.
IsRoutingPreferenceInternet bool
Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
P2SConnectionConfigurations []P2SConnectionConfigurationResponse
List of all p2s connection configurations of the gateway.
Tags map[string]string
Resource tags.
VirtualHub SubResourceResponse
The VirtualHub to which the gateway belongs.
VpnGatewayScaleUnit int
The scale unit for this p2s vpn gateway.
VpnServerConfiguration SubResourceResponse
The VpnServerConfiguration to which the p2sVpnGateway is attached to.
etag String
A unique read-only string that changes whenever the resource is updated.
location String
Resource location.
name String
Resource name.
provisioningState String
The provisioning state of the P2S VPN gateway resource.
type String
Resource type.
vpnClientConnectionHealth VpnClientConnectionHealthResponse
All P2S VPN clients' connection health status.
customDnsServers List<String>
List of all customer specified DNS servers IP addresses.
id String
Resource ID.
isRoutingPreferenceInternet Boolean
Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
p2SConnectionConfigurations List<P2SConnectionConfigurationResponse>
List of all p2s connection configurations of the gateway.
tags Map<String,String>
Resource tags.
virtualHub SubResourceResponse
The VirtualHub to which the gateway belongs.
vpnGatewayScaleUnit Integer
The scale unit for this p2s vpn gateway.
vpnServerConfiguration SubResourceResponse
The VpnServerConfiguration to which the p2sVpnGateway is attached to.
etag string
A unique read-only string that changes whenever the resource is updated.
location string
Resource location.
name string
Resource name.
provisioningState string
The provisioning state of the P2S VPN gateway resource.
type string
Resource type.
vpnClientConnectionHealth VpnClientConnectionHealthResponse
All P2S VPN clients' connection health status.
customDnsServers string[]
List of all customer specified DNS servers IP addresses.
id string
Resource ID.
isRoutingPreferenceInternet boolean
Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
p2SConnectionConfigurations P2SConnectionConfigurationResponse[]
List of all p2s connection configurations of the gateway.
tags {[key: string]: string}
Resource tags.
virtualHub SubResourceResponse
The VirtualHub to which the gateway belongs.
vpnGatewayScaleUnit number
The scale unit for this p2s vpn gateway.
vpnServerConfiguration SubResourceResponse
The VpnServerConfiguration to which the p2sVpnGateway is attached to.
etag str
A unique read-only string that changes whenever the resource is updated.
location str
Resource location.
name str
Resource name.
provisioning_state str
The provisioning state of the P2S VPN gateway resource.
type str
Resource type.
vpn_client_connection_health VpnClientConnectionHealthResponse
All P2S VPN clients' connection health status.
custom_dns_servers Sequence[str]
List of all customer specified DNS servers IP addresses.
id str
Resource ID.
is_routing_preference_internet bool
Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
p2_s_connection_configurations Sequence[P2SConnectionConfigurationResponse]
List of all p2s connection configurations of the gateway.
tags Mapping[str, str]
Resource tags.
virtual_hub SubResourceResponse
The VirtualHub to which the gateway belongs.
vpn_gateway_scale_unit int
The scale unit for this p2s vpn gateway.
vpn_server_configuration SubResourceResponse
The VpnServerConfiguration to which the p2sVpnGateway is attached to.
etag String
A unique read-only string that changes whenever the resource is updated.
location String
Resource location.
name String
Resource name.
provisioningState String
The provisioning state of the P2S VPN gateway resource.
type String
Resource type.
vpnClientConnectionHealth Property Map
All P2S VPN clients' connection health status.
customDnsServers List<String>
List of all customer specified DNS servers IP addresses.
id String
Resource ID.
isRoutingPreferenceInternet Boolean
Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
p2SConnectionConfigurations List<Property Map>
List of all p2s connection configurations of the gateway.
tags Map<String>
Resource tags.
virtualHub Property Map
The VirtualHub to which the gateway belongs.
vpnGatewayScaleUnit Number
The scale unit for this p2s vpn gateway.
vpnServerConfiguration Property Map
The VpnServerConfiguration to which the p2sVpnGateway is attached to.

Supporting Types

AddressSpaceResponse

AddressPrefixes List<string>
A list of address blocks reserved for this virtual network in CIDR notation.
IpamPoolPrefixAllocations List<Pulumi.AzureNative.Network.Inputs.IpamPoolPrefixAllocationResponse>
A list of IPAM Pools allocating IP address prefixes.
AddressPrefixes []string
A list of address blocks reserved for this virtual network in CIDR notation.
IpamPoolPrefixAllocations []IpamPoolPrefixAllocationResponse
A list of IPAM Pools allocating IP address prefixes.
addressPrefixes List<String>
A list of address blocks reserved for this virtual network in CIDR notation.
ipamPoolPrefixAllocations List<IpamPoolPrefixAllocationResponse>
A list of IPAM Pools allocating IP address prefixes.
addressPrefixes string[]
A list of address blocks reserved for this virtual network in CIDR notation.
ipamPoolPrefixAllocations IpamPoolPrefixAllocationResponse[]
A list of IPAM Pools allocating IP address prefixes.
address_prefixes Sequence[str]
A list of address blocks reserved for this virtual network in CIDR notation.
ipam_pool_prefix_allocations Sequence[IpamPoolPrefixAllocationResponse]
A list of IPAM Pools allocating IP address prefixes.
addressPrefixes List<String>
A list of address blocks reserved for this virtual network in CIDR notation.
ipamPoolPrefixAllocations List<Property Map>
A list of IPAM Pools allocating IP address prefixes.

IpamPoolPrefixAllocationResponse

AllocatedAddressPrefixes This property is required. List<string>
List of assigned IP address prefixes in the IpamPool of the associated resource.
Id string
Resource id of the associated Azure IpamPool resource.
NumberOfIpAddresses string
Number of IP addresses to allocate.
AllocatedAddressPrefixes This property is required. []string
List of assigned IP address prefixes in the IpamPool of the associated resource.
Id string
Resource id of the associated Azure IpamPool resource.
NumberOfIpAddresses string
Number of IP addresses to allocate.
allocatedAddressPrefixes This property is required. List<String>
List of assigned IP address prefixes in the IpamPool of the associated resource.
id String
Resource id of the associated Azure IpamPool resource.
numberOfIpAddresses String
Number of IP addresses to allocate.
allocatedAddressPrefixes This property is required. string[]
List of assigned IP address prefixes in the IpamPool of the associated resource.
id string
Resource id of the associated Azure IpamPool resource.
numberOfIpAddresses string
Number of IP addresses to allocate.
allocated_address_prefixes This property is required. Sequence[str]
List of assigned IP address prefixes in the IpamPool of the associated resource.
id str
Resource id of the associated Azure IpamPool resource.
number_of_ip_addresses str
Number of IP addresses to allocate.
allocatedAddressPrefixes This property is required. List<String>
List of assigned IP address prefixes in the IpamPool of the associated resource.
id String
Resource id of the associated Azure IpamPool resource.
numberOfIpAddresses String
Number of IP addresses to allocate.

P2SConnectionConfigurationResponse

ConfigurationPolicyGroupAssociations This property is required. List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
PreviousConfigurationPolicyGroupAssociations This property is required. List<Pulumi.AzureNative.Network.Inputs.VpnServerConfigurationPolicyGroupResponse>
List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to.
ProvisioningState This property is required. string
The provisioning state of the P2SConnectionConfiguration resource.
EnableInternetSecurity bool
Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.
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.
RoutingConfiguration Pulumi.AzureNative.Network.Inputs.RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
VpnClientAddressPool Pulumi.AzureNative.Network.Inputs.AddressSpaceResponse
The reference to the address space resource which represents Address space for P2S VpnClient.
ConfigurationPolicyGroupAssociations This property is required. []SubResourceResponse
List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
PreviousConfigurationPolicyGroupAssociations This property is required. []VpnServerConfigurationPolicyGroupResponse
List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to.
ProvisioningState This property is required. string
The provisioning state of the P2SConnectionConfiguration resource.
EnableInternetSecurity bool
Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.
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.
RoutingConfiguration RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
VpnClientAddressPool AddressSpaceResponse
The reference to the address space resource which represents Address space for P2S VpnClient.
configurationPolicyGroupAssociations This property is required. List<SubResourceResponse>
List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
previousConfigurationPolicyGroupAssociations This property is required. List<VpnServerConfigurationPolicyGroupResponse>
List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to.
provisioningState This property is required. String
The provisioning state of the P2SConnectionConfiguration resource.
enableInternetSecurity Boolean
Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.
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.
routingConfiguration RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
vpnClientAddressPool AddressSpaceResponse
The reference to the address space resource which represents Address space for P2S VpnClient.
configurationPolicyGroupAssociations This property is required. SubResourceResponse[]
List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to.
etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
previousConfigurationPolicyGroupAssociations This property is required. VpnServerConfigurationPolicyGroupResponse[]
List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to.
provisioningState This property is required. string
The provisioning state of the P2SConnectionConfiguration resource.
enableInternetSecurity boolean
Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.
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.
routingConfiguration RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
vpnClientAddressPool AddressSpaceResponse
The reference to the address space resource which represents Address space for P2S VpnClient.
configuration_policy_group_associations This property is required. Sequence[SubResourceResponse]
List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to.
etag This property is required. str
A unique read-only string that changes whenever the resource is updated.
previous_configuration_policy_group_associations This property is required. Sequence[VpnServerConfigurationPolicyGroupResponse]
List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to.
provisioning_state This property is required. str
The provisioning state of the P2SConnectionConfiguration resource.
enable_internet_security bool
Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.
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.
routing_configuration RoutingConfigurationResponse
The Routing Configuration indicating the associated and propagated route tables on this connection.
vpn_client_address_pool AddressSpaceResponse
The reference to the address space resource which represents Address space for P2S VpnClient.
configurationPolicyGroupAssociations This property is required. List<Property Map>
List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
previousConfigurationPolicyGroupAssociations This property is required. List<Property Map>
List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to.
provisioningState This property is required. String
The provisioning state of the P2SConnectionConfiguration resource.
enableInternetSecurity Boolean
Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.
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.
routingConfiguration Property Map
The Routing Configuration indicating the associated and propagated route tables on this connection.
vpnClientAddressPool Property Map
The reference to the address space resource which represents Address space for P2S VpnClient.

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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
The list of references to HubBgpConnection objects.
StaticRoutes List<Pulumi.AzureNative.Network.Inputs.StaticRouteResponse>
List of all Static Routes.
StaticRoutesConfig Pulumi.AzureNative.Network.Inputs.StaticRoutesConfigResponse
Configuration for static routes on this HubVnetConnection.
BgpConnections This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

VpnClientConnectionHealthResponse

TotalEgressBytesTransferred This property is required. double
Total of the Egress Bytes Transferred in this connection.
TotalIngressBytesTransferred This property is required. double
Total of the Ingress Bytes Transferred in this P2S Vpn connection.
AllocatedIpAddresses List<string>
List of allocated ip addresses to the connected p2s vpn clients.
VpnClientConnectionsCount int
The total of p2s vpn clients connected at this time to this P2SVpnGateway.
TotalEgressBytesTransferred This property is required. float64
Total of the Egress Bytes Transferred in this connection.
TotalIngressBytesTransferred This property is required. float64
Total of the Ingress Bytes Transferred in this P2S Vpn connection.
AllocatedIpAddresses []string
List of allocated ip addresses to the connected p2s vpn clients.
VpnClientConnectionsCount int
The total of p2s vpn clients connected at this time to this P2SVpnGateway.
totalEgressBytesTransferred This property is required. Double
Total of the Egress Bytes Transferred in this connection.
totalIngressBytesTransferred This property is required. Double
Total of the Ingress Bytes Transferred in this P2S Vpn connection.
allocatedIpAddresses List<String>
List of allocated ip addresses to the connected p2s vpn clients.
vpnClientConnectionsCount Integer
The total of p2s vpn clients connected at this time to this P2SVpnGateway.
totalEgressBytesTransferred This property is required. number
Total of the Egress Bytes Transferred in this connection.
totalIngressBytesTransferred This property is required. number
Total of the Ingress Bytes Transferred in this P2S Vpn connection.
allocatedIpAddresses string[]
List of allocated ip addresses to the connected p2s vpn clients.
vpnClientConnectionsCount number
The total of p2s vpn clients connected at this time to this P2SVpnGateway.
total_egress_bytes_transferred This property is required. float
Total of the Egress Bytes Transferred in this connection.
total_ingress_bytes_transferred This property is required. float
Total of the Ingress Bytes Transferred in this P2S Vpn connection.
allocated_ip_addresses Sequence[str]
List of allocated ip addresses to the connected p2s vpn clients.
vpn_client_connections_count int
The total of p2s vpn clients connected at this time to this P2SVpnGateway.
totalEgressBytesTransferred This property is required. Number
Total of the Egress Bytes Transferred in this connection.
totalIngressBytesTransferred This property is required. Number
Total of the Ingress Bytes Transferred in this P2S Vpn connection.
allocatedIpAddresses List<String>
List of allocated ip addresses to the connected p2s vpn clients.
vpnClientConnectionsCount Number
The total of p2s vpn clients connected at this time to this P2SVpnGateway.

VpnServerConfigurationPolicyGroupMemberResponse

AttributeType string
The Vpn Policy member attribute type.
AttributeValue string
The value of Attribute used for this VpnServerConfigurationPolicyGroupMember.
Name string
Name of the VpnServerConfigurationPolicyGroupMember.
AttributeType string
The Vpn Policy member attribute type.
AttributeValue string
The value of Attribute used for this VpnServerConfigurationPolicyGroupMember.
Name string
Name of the VpnServerConfigurationPolicyGroupMember.
attributeType String
The Vpn Policy member attribute type.
attributeValue String
The value of Attribute used for this VpnServerConfigurationPolicyGroupMember.
name String
Name of the VpnServerConfigurationPolicyGroupMember.
attributeType string
The Vpn Policy member attribute type.
attributeValue string
The value of Attribute used for this VpnServerConfigurationPolicyGroupMember.
name string
Name of the VpnServerConfigurationPolicyGroupMember.
attribute_type str
The Vpn Policy member attribute type.
attribute_value str
The value of Attribute used for this VpnServerConfigurationPolicyGroupMember.
name str
Name of the VpnServerConfigurationPolicyGroupMember.
attributeType String
The Vpn Policy member attribute type.
attributeValue String
The value of Attribute used for this VpnServerConfigurationPolicyGroupMember.
name String
Name of the VpnServerConfigurationPolicyGroupMember.

VpnServerConfigurationPolicyGroupResponse

Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
P2SConnectionConfigurations This property is required. List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>
List of references to P2SConnectionConfigurations.
ProvisioningState This property is required. string
The provisioning state of the VpnServerConfigurationPolicyGroup resource.
Type This property is required. string
Resource type.
Id string
Resource ID.
IsDefault bool
Shows if this is a Default VpnServerConfigurationPolicyGroup or not.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
PolicyMembers List<Pulumi.AzureNative.Network.Inputs.VpnServerConfigurationPolicyGroupMemberResponse>
Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.
Priority int
Priority for VpnServerConfigurationPolicyGroup.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
P2SConnectionConfigurations This property is required. []SubResourceResponse
List of references to P2SConnectionConfigurations.
ProvisioningState This property is required. string
The provisioning state of the VpnServerConfigurationPolicyGroup resource.
Type This property is required. string
Resource type.
Id string
Resource ID.
IsDefault bool
Shows if this is a Default VpnServerConfigurationPolicyGroup or not.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
PolicyMembers []VpnServerConfigurationPolicyGroupMemberResponse
Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.
Priority int
Priority for VpnServerConfigurationPolicyGroup.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
p2SConnectionConfigurations This property is required. List<SubResourceResponse>
List of references to P2SConnectionConfigurations.
provisioningState This property is required. String
The provisioning state of the VpnServerConfigurationPolicyGroup resource.
type This property is required. String
Resource type.
id String
Resource ID.
isDefault Boolean
Shows if this is a Default VpnServerConfigurationPolicyGroup or not.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
policyMembers List<VpnServerConfigurationPolicyGroupMemberResponse>
Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.
priority Integer
Priority for VpnServerConfigurationPolicyGroup.
etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
p2SConnectionConfigurations This property is required. SubResourceResponse[]
List of references to P2SConnectionConfigurations.
provisioningState This property is required. string
The provisioning state of the VpnServerConfigurationPolicyGroup resource.
type This property is required. string
Resource type.
id string
Resource ID.
isDefault boolean
Shows if this is a Default VpnServerConfigurationPolicyGroup or not.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
policyMembers VpnServerConfigurationPolicyGroupMemberResponse[]
Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.
priority number
Priority for VpnServerConfigurationPolicyGroup.
etag This property is required. str
A unique read-only string that changes whenever the resource is updated.
p2_s_connection_configurations This property is required. Sequence[SubResourceResponse]
List of references to P2SConnectionConfigurations.
provisioning_state This property is required. str
The provisioning state of the VpnServerConfigurationPolicyGroup resource.
type This property is required. str
Resource type.
id str
Resource ID.
is_default bool
Shows if this is a Default VpnServerConfigurationPolicyGroup or not.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
policy_members Sequence[VpnServerConfigurationPolicyGroupMemberResponse]
Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.
priority int
Priority for VpnServerConfigurationPolicyGroup.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
p2SConnectionConfigurations This property is required. List<Property Map>
List of references to P2SConnectionConfigurations.
provisioningState This property is required. String
The provisioning state of the VpnServerConfigurationPolicyGroup resource.
type This property is required. String
Resource type.
id String
Resource ID.
isDefault Boolean
Shows if this is a Default VpnServerConfigurationPolicyGroup or not.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
policyMembers List<Property Map>
Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.
priority Number
Priority for VpnServerConfigurationPolicyGroup.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native