Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getVpnClientConnectionHealth?api-version=2023-09-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
resourceGroupName
|
path |
True
|
string
|
The name of the resource group.
|
|
subscriptionId
|
path |
True
|
string
|
The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
|
|
virtualNetworkGatewayName
|
path |
True
|
string
|
The name of the virtual network gateway.
|
|
api-version
|
query |
True
|
string
|
Client API version.
|
Responses
| Name |
Type |
Description |
|
200 OK
|
VpnClientConnectionHealthDetailListResult
|
List of VPN client connection health details.
|
|
202 Accepted
|
|
Accepted and the operation will complete asynchronously.
|
|
Other Status Codes
|
CloudError
|
Error response describing why the operation failed.
|
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
impersonate your user account
|
Examples
GetVirtualNetworkGatewayVpnclientConnectionHealth
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/p2s-vnet-test/providers/Microsoft.Network/virtualNetworkGateways/vpnp2sgw/getVpnClientConnectionHealth?api-version=2023-09-01
from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-network
# USAGE
python virtual_network_gateway_get_vpnclient_connection_health.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = NetworkManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.virtual_network_gateways.begin_get_vpnclient_connection_health(
resource_group_name="p2s-vnet-test",
virtual_network_gateway_name="vpnp2sgw",
).result()
print(response)
# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armnetwork_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json
func ExampleVirtualNetworkGatewaysClient_BeginGetVpnclientConnectionHealth() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewVirtualNetworkGatewaysClient().BeginGetVpnclientConnectionHealth(ctx, "p2s-vnet-test", "vpnp2sgw", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.VPNClientConnectionHealthDetailListResult = armnetwork.VPNClientConnectionHealthDetailListResult{
// Value: []*armnetwork.VPNClientConnectionHealthDetail{
// {
// EgressBytesTransferred: to.Ptr[int64](33420),
// EgressPacketsTransferred: to.Ptr[int64](557),
// IngressBytesTransferred: to.Ptr[int64](33420),
// IngressPacketsTransferred: to.Ptr[int64](557),
// MaxBandwidth: to.Ptr[int64](240000000),
// MaxPacketsPerSecond: to.Ptr[int64](4),
// PrivateIPAddress: to.Ptr("192.168.210.2"),
// PublicIPAddress: to.Ptr("167.220.2.232:45522"),
// VPNConnectionDuration: to.Ptr[int64](900),
// VPNConnectionID: to.Ptr("IKEv2_1e1cfe59-5c7c-4315-a876-b11fbfdfeed4"),
// VPNConnectionTime: to.Ptr("2019-05-02T22:26:22"),
// VPNUserName: to.Ptr("gwp2schildcert"),
// },
// {
// EgressBytesTransferred: to.Ptr[int64](23420),
// EgressPacketsTransferred: to.Ptr[int64](357),
// IngressBytesTransferred: to.Ptr[int64](23420),
// IngressPacketsTransferred: to.Ptr[int64](357),
// MaxBandwidth: to.Ptr[int64](220000000),
// MaxPacketsPerSecond: to.Ptr[int64](4),
// PrivateIPAddress: to.Ptr("192.168.210.1"),
// PublicIPAddress: to.Ptr("167.220.2.232:45213"),
// VPNConnectionDuration: to.Ptr[int64](800),
// VPNConnectionID: to.Ptr("IKEv2_571cfe59-2c7d-1415-e813-c51fbfdfea16"),
// VPNConnectionTime: to.Ptr("2019-05-01T21:06:12"),
// VPNUserName: to.Ptr("gwp2schildcert"),
// }},
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.
*
* @summary Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json
*/
async function getVirtualNetworkGatewayVpnclientConnectionHealth() {
const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "p2s-vnet-test";
const virtualNetworkGatewayName = "vpnp2sgw";
const credential = new DefaultAzureCredential();
const client = new NetworkManagementClient(credential, subscriptionId);
const result = await client.virtualNetworkGateways.beginGetVpnclientConnectionHealthAndWait(
resourceGroupName,
virtualNetworkGatewayName,
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json
// this example is just showing the usage of "VirtualNetworkGateways_GetVpnclientConnectionHealth" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this VirtualNetworkGatewayResource created on azure
// for more information of creating VirtualNetworkGatewayResource, please refer to the document of VirtualNetworkGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "p2s-vnet-test";
string virtualNetworkGatewayName = "vpnp2sgw";
ResourceIdentifier virtualNetworkGatewayResourceId = VirtualNetworkGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualNetworkGatewayName);
VirtualNetworkGatewayResource virtualNetworkGateway = client.GetVirtualNetworkGatewayResource(virtualNetworkGatewayResourceId);
// invoke the operation
ArmOperation<VpnClientConnectionHealthDetailListResult> lro = await virtualNetworkGateway.GetVpnclientConnectionHealthAsync(WaitUntil.Completed);
VpnClientConnectionHealthDetailListResult result = lro.Value;
Console.WriteLine($"Succeeded: {result}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"value": [
{
"vpnConnectionId": "IKEv2_1e1cfe59-5c7c-4315-a876-b11fbfdfeed4",
"vpnConnectionDuration": 900,
"vpnConnectionTime": "2019-05-02T22:26:22",
"publicIpAddress": "167.220.2.232:45522",
"privateIpAddress": "192.168.210.2",
"vpnUserName": "gwp2schildcert",
"maxBandwidth": 240000000,
"egressPacketsTransferred": 557,
"egressBytesTransferred": 33420,
"ingressPacketsTransferred": 557,
"ingressBytesTransferred": 33420,
"maxPacketsPerSecond": 4
},
{
"vpnConnectionId": "IKEv2_571cfe59-2c7d-1415-e813-c51fbfdfea16",
"vpnConnectionDuration": 800,
"vpnConnectionTime": "2019-05-01T21:06:12",
"publicIpAddress": "167.220.2.232:45213",
"privateIpAddress": "192.168.210.1",
"vpnUserName": "gwp2schildcert",
"maxBandwidth": 220000000,
"egressPacketsTransferred": 357,
"egressBytesTransferred": 23420,
"ingressPacketsTransferred": 357,
"ingressBytesTransferred": 23420,
"maxPacketsPerSecond": 4
}
]
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2023-09-01
Definitions
CloudError
An error response from the service.
CloudErrorBody
An error response from the service.
| Name |
Type |
Description |
|
code
|
string
|
An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
|
|
details
|
CloudErrorBody[]
|
A list of additional details about the error.
|
|
message
|
string
|
A message describing the error, intended to be suitable for display in a user interface.
|
|
target
|
string
|
The target of the particular error. For example, the name of the property in error.
|
VpnClientConnectionHealthDetail
VPN client connection health detail.
| Name |
Type |
Description |
|
egressBytesTransferred
|
integer
|
The egress bytes per second.
|
|
egressPacketsTransferred
|
integer
|
The egress packets per second.
|
|
ingressBytesTransferred
|
integer
|
The ingress bytes per second.
|
|
ingressPacketsTransferred
|
integer
|
The ingress packets per second.
|
|
maxBandwidth
|
integer
|
The max band width.
|
|
maxPacketsPerSecond
|
integer
|
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
|
integer
|
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.
|
VpnClientConnectionHealthDetailListResult
List of virtual network gateway vpn client connection health.