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

azure-native.network.getVirtualNetworkGatewayVpnclientConnectionHealth

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

Get VPN client connection health detail per P2S client connection of the virtual network gateway 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 getVirtualNetworkGatewayVpnclientConnectionHealth

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 getVirtualNetworkGatewayVpnclientConnectionHealth(args: GetVirtualNetworkGatewayVpnclientConnectionHealthArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkGatewayVpnclientConnectionHealthResult>
function getVirtualNetworkGatewayVpnclientConnectionHealthOutput(args: GetVirtualNetworkGatewayVpnclientConnectionHealthOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkGatewayVpnclientConnectionHealthResult>
Copy
def get_virtual_network_gateway_vpnclient_connection_health(resource_group_name: Optional[str] = None,
                                                            virtual_network_gateway_name: Optional[str] = None,
                                                            opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkGatewayVpnclientConnectionHealthResult
def get_virtual_network_gateway_vpnclient_connection_health_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                                            virtual_network_gateway_name: Optional[pulumi.Input[str]] = None,
                                                            opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkGatewayVpnclientConnectionHealthResult]
Copy
func GetVirtualNetworkGatewayVpnclientConnectionHealth(ctx *Context, args *GetVirtualNetworkGatewayVpnclientConnectionHealthArgs, opts ...InvokeOption) (*GetVirtualNetworkGatewayVpnclientConnectionHealthResult, error)
func GetVirtualNetworkGatewayVpnclientConnectionHealthOutput(ctx *Context, args *GetVirtualNetworkGatewayVpnclientConnectionHealthOutputArgs, opts ...InvokeOption) GetVirtualNetworkGatewayVpnclientConnectionHealthResultOutput
Copy

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

public static class GetVirtualNetworkGatewayVpnclientConnectionHealth 
{
    public static Task<GetVirtualNetworkGatewayVpnclientConnectionHealthResult> InvokeAsync(GetVirtualNetworkGatewayVpnclientConnectionHealthArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualNetworkGatewayVpnclientConnectionHealthResult> Invoke(GetVirtualNetworkGatewayVpnclientConnectionHealthInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVirtualNetworkGatewayVpnclientConnectionHealthResult> getVirtualNetworkGatewayVpnclientConnectionHealth(GetVirtualNetworkGatewayVpnclientConnectionHealthArgs args, InvokeOptions options)
public static Output<GetVirtualNetworkGatewayVpnclientConnectionHealthResult> getVirtualNetworkGatewayVpnclientConnectionHealth(GetVirtualNetworkGatewayVpnclientConnectionHealthArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getVirtualNetworkGatewayVpnclientConnectionHealth
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
VirtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the virtual network gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
virtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the virtual network gateway.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
virtual_network_gateway_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the virtual network gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
virtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the virtual network gateway.

getVirtualNetworkGatewayVpnclientConnectionHealth Result

The following output properties are available:

Value []VpnClientConnectionHealthDetailResponse
List of vpn client connection health.
value List<VpnClientConnectionHealthDetailResponse>
List of vpn client connection health.
value VpnClientConnectionHealthDetailResponse[]
List of vpn client connection health.
value Sequence[VpnClientConnectionHealthDetailResponse]
List of vpn client connection health.
value List<Property Map>
List of vpn client connection health.

Supporting Types

VpnClientConnectionHealthDetailResponse

EgressBytesTransferred This property is required. double
The egress bytes per second.
EgressPacketsTransferred This property is required. double
The egress packets per second.
IngressBytesTransferred This property is required. double
The ingress bytes per second.
IngressPacketsTransferred This property is required. double
The ingress packets per second.
MaxBandwidth This property is required. double
The max band width.
MaxPacketsPerSecond This property is required. double
The max packets transferred per second.
PrivateIpAddress This property is required. string
The assigned private Ip of a connected vpn client.
PublicIpAddress This property is required. string
The public Ip of a connected vpn client.
VpnConnectionDuration This property is required. double
The duration time of a connected vpn client.
VpnConnectionId This property is required. string
The vpn client Id.
VpnConnectionTime This property is required. string
The start time of a connected vpn client.
VpnUserName This property is required. string
The user name of a connected vpn client.
EgressBytesTransferred This property is required. float64
The egress bytes per second.
EgressPacketsTransferred This property is required. float64
The egress packets per second.
IngressBytesTransferred This property is required. float64
The ingress bytes per second.
IngressPacketsTransferred This property is required. float64
The ingress packets per second.
MaxBandwidth This property is required. float64
The max band width.
MaxPacketsPerSecond This property is required. float64
The max packets transferred per second.
PrivateIpAddress This property is required. string
The assigned private Ip of a connected vpn client.
PublicIpAddress This property is required. string
The public Ip of a connected vpn client.
VpnConnectionDuration This property is required. float64
The duration time of a connected vpn client.
VpnConnectionId This property is required. string
The vpn client Id.
VpnConnectionTime This property is required. string
The start time of a connected vpn client.
VpnUserName This property is required. string
The user name of a connected vpn client.
egressBytesTransferred This property is required. Double
The egress bytes per second.
egressPacketsTransferred This property is required. Double
The egress packets per second.
ingressBytesTransferred This property is required. Double
The ingress bytes per second.
ingressPacketsTransferred This property is required. Double
The ingress packets per second.
maxBandwidth This property is required. Double
The max band width.
maxPacketsPerSecond This property is required. Double
The max packets transferred per second.
privateIpAddress This property is required. String
The assigned private Ip of a connected vpn client.
publicIpAddress This property is required. String
The public Ip of a connected vpn client.
vpnConnectionDuration This property is required. Double
The duration time of a connected vpn client.
vpnConnectionId This property is required. String
The vpn client Id.
vpnConnectionTime This property is required. String
The start time of a connected vpn client.
vpnUserName This property is required. String
The user name of a connected vpn client.
egressBytesTransferred This property is required. number
The egress bytes per second.
egressPacketsTransferred This property is required. number
The egress packets per second.
ingressBytesTransferred This property is required. number
The ingress bytes per second.
ingressPacketsTransferred This property is required. number
The ingress packets per second.
maxBandwidth This property is required. number
The max band width.
maxPacketsPerSecond This property is required. number
The max packets transferred per second.
privateIpAddress This property is required. string
The assigned private Ip of a connected vpn client.
publicIpAddress This property is required. string
The public Ip of a connected vpn client.
vpnConnectionDuration This property is required. number
The duration time of a connected vpn client.
vpnConnectionId This property is required. string
The vpn client Id.
vpnConnectionTime This property is required. string
The start time of a connected vpn client.
vpnUserName This property is required. string
The user name of a connected vpn client.
egress_bytes_transferred This property is required. float
The egress bytes per second.
egress_packets_transferred This property is required. float
The egress packets per second.
ingress_bytes_transferred This property is required. float
The ingress bytes per second.
ingress_packets_transferred This property is required. float
The ingress packets per second.
max_bandwidth This property is required. float
The max band width.
max_packets_per_second This property is required. float
The max packets transferred per second.
private_ip_address This property is required. str
The assigned private Ip of a connected vpn client.
public_ip_address This property is required. str
The public Ip of a connected vpn client.
vpn_connection_duration This property is required. float
The duration time of a connected vpn client.
vpn_connection_id This property is required. str
The vpn client Id.
vpn_connection_time This property is required. str
The start time of a connected vpn client.
vpn_user_name This property is required. str
The user name of a connected vpn client.
egressBytesTransferred This property is required. Number
The egress bytes per second.
egressPacketsTransferred This property is required. Number
The egress packets per second.
ingressBytesTransferred This property is required. Number
The ingress bytes per second.
ingressPacketsTransferred This property is required. Number
The ingress packets per second.
maxBandwidth This property is required. Number
The max band width.
maxPacketsPerSecond This property is required. Number
The max packets transferred per second.
privateIpAddress This property is required. String
The assigned private Ip of a connected vpn client.
publicIpAddress This property is required. String
The public Ip of a connected vpn client.
vpnConnectionDuration This property is required. Number
The duration time of a connected vpn client.
vpnConnectionId This property is required. String
The vpn client Id.
vpnConnectionTime This property is required. String
The start time of a connected vpn client.
vpnUserName This property is required. String
The user name of a connected vpn client.

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