1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getVirtualNetworkGatewayVpnclientConnectionHealth
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

azure-native.network.getVirtualNetworkGatewayVpnclientConnectionHealth

Explore with Pulumi AI

azure-native logo
Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

    Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group. API Version: 2020-11-01.

    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>
    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]
    func GetVirtualNetworkGatewayVpnclientConnectionHealth(ctx *Context, args *GetVirtualNetworkGatewayVpnclientConnectionHealthArgs, opts ...InvokeOption) (*GetVirtualNetworkGatewayVpnclientConnectionHealthResult, error)
    func GetVirtualNetworkGatewayVpnclientConnectionHealthOutput(ctx *Context, args *GetVirtualNetworkGatewayVpnclientConnectionHealthOutputArgs, opts ...InvokeOption) GetVirtualNetworkGatewayVpnclientConnectionHealthResultOutput

    > 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)
    }
    public static CompletableFuture<GetVirtualNetworkGatewayVpnclientConnectionHealthResult> getVirtualNetworkGatewayVpnclientConnectionHealth(GetVirtualNetworkGatewayVpnclientConnectionHealthArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:network:getVirtualNetworkGatewayVpnclientConnectionHealth
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string

    The name of the resource group.

    VirtualNetworkGatewayName string

    The name of the virtual network gateway.

    ResourceGroupName string

    The name of the resource group.

    VirtualNetworkGatewayName string

    The name of the virtual network gateway.

    resourceGroupName String

    The name of the resource group.

    virtualNetworkGatewayName String

    The name of the virtual network gateway.

    resourceGroupName string

    The name of the resource group.

    virtualNetworkGatewayName string

    The name of the virtual network gateway.

    resource_group_name str

    The name of the resource group.

    virtual_network_gateway_name str

    The name of the virtual network gateway.

    resourceGroupName String

    The name of the resource group.

    virtualNetworkGatewayName 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 double

    The egress bytes per second.

    EgressPacketsTransferred double

    The egress packets per second.

    IngressBytesTransferred double

    The ingress bytes per second.

    IngressPacketsTransferred double

    The ingress packets per second.

    MaxBandwidth double

    The max band width.

    MaxPacketsPerSecond double

    The max packets transferred per second.

    PrivateIpAddress string

    The assigned private Ip of a connected vpn client.

    PublicIpAddress string

    The public Ip of a connected vpn client.

    VpnConnectionDuration double

    The duration time of a connected vpn client.

    VpnConnectionId string

    The vpn client Id.

    VpnConnectionTime string

    The start time of a connected vpn client.

    VpnUserName string

    The user name of a connected vpn client.

    EgressBytesTransferred float64

    The egress bytes per second.

    EgressPacketsTransferred float64

    The egress packets per second.

    IngressBytesTransferred float64

    The ingress bytes per second.

    IngressPacketsTransferred float64

    The ingress packets per second.

    MaxBandwidth float64

    The max band width.

    MaxPacketsPerSecond float64

    The max packets transferred per second.

    PrivateIpAddress string

    The assigned private Ip of a connected vpn client.

    PublicIpAddress string

    The public Ip of a connected vpn client.

    VpnConnectionDuration float64

    The duration time of a connected vpn client.

    VpnConnectionId string

    The vpn client Id.

    VpnConnectionTime string

    The start time of a connected vpn client.

    VpnUserName string

    The user name of a connected vpn client.

    egressBytesTransferred Double

    The egress bytes per second.

    egressPacketsTransferred Double

    The egress packets per second.

    ingressBytesTransferred Double

    The ingress bytes per second.

    ingressPacketsTransferred Double

    The ingress packets per second.

    maxBandwidth Double

    The max band width.

    maxPacketsPerSecond Double

    The max packets transferred per second.

    privateIpAddress String

    The assigned private Ip of a connected vpn client.

    publicIpAddress String

    The public Ip of a connected vpn client.

    vpnConnectionDuration Double

    The duration time of a connected vpn client.

    vpnConnectionId String

    The vpn client Id.

    vpnConnectionTime String

    The start time of a connected vpn client.

    vpnUserName String

    The user name of a connected vpn client.

    egressBytesTransferred number

    The egress bytes per second.

    egressPacketsTransferred number

    The egress packets per second.

    ingressBytesTransferred number

    The ingress bytes per second.

    ingressPacketsTransferred number

    The ingress packets per second.

    maxBandwidth number

    The max band width.

    maxPacketsPerSecond number

    The max packets transferred per second.

    privateIpAddress string

    The assigned private Ip of a connected vpn client.

    publicIpAddress string

    The public Ip of a connected vpn client.

    vpnConnectionDuration number

    The duration time of a connected vpn client.

    vpnConnectionId string

    The vpn client Id.

    vpnConnectionTime string

    The start time of a connected vpn client.

    vpnUserName string

    The user name of a connected vpn client.

    egress_bytes_transferred float

    The egress bytes per second.

    egress_packets_transferred float

    The egress packets per second.

    ingress_bytes_transferred float

    The ingress bytes per second.

    ingress_packets_transferred float

    The ingress packets per second.

    max_bandwidth float

    The max band width.

    max_packets_per_second float

    The max packets transferred per second.

    private_ip_address str

    The assigned private Ip of a connected vpn client.

    public_ip_address str

    The public Ip of a connected vpn client.

    vpn_connection_duration float

    The duration time of a connected vpn client.

    vpn_connection_id str

    The vpn client Id.

    vpn_connection_time str

    The start time of a connected vpn client.

    vpn_user_name str

    The user name of a connected vpn client.

    egressBytesTransferred Number

    The egress bytes per second.

    egressPacketsTransferred Number

    The egress packets per second.

    ingressBytesTransferred Number

    The ingress bytes per second.

    ingressPacketsTransferred Number

    The ingress packets per second.

    maxBandwidth Number

    The max band width.

    maxPacketsPerSecond Number

    The max packets transferred per second.

    privateIpAddress String

    The assigned private Ip of a connected vpn client.

    publicIpAddress String

    The public Ip of a connected vpn client.

    vpnConnectionDuration Number

    The duration time of a connected vpn client.

    vpnConnectionId String

    The vpn client Id.

    vpnConnectionTime String

    The start time of a connected vpn client.

    vpnUserName String

    The user name of a connected vpn client.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi