Virtual Network Gateways - Get Vpnclient Connection Health

Service:

Network Gateway

API Version:

2023-09-01

取得指定資源群組中虛擬網路網關的每個 P2S 用戶端連線 VPN 用戶端連線健康情況詳細數據。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getVpnClientConnectionHealth?api-version=2023-09-01

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
virtualNetworkGatewayName	path	True	string	虛擬網路閘道的名稱。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	VpnClientConnectionHealthDetailListResult	VPN 用戶端連線健康情況詳細數據的清單。
202 Accepted		已接受，且作業會以異步方式完成。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

GetVirtualNetworkGatewayVpnclientConnectionHealth

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/p2s-vnet-test/providers/Microsoft.Network/virtualNetworkGateways/vpnp2sgw/getVpnClientConnectionHealth?api-version=2023-09-01

Python

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

Go

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

JavaScript

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

dotnet

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

Status code:

200

{
  "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
    }
  ]
}

Status code:

202

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

定義

名稱	Description
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
VpnClientConnectionHealthDetail	VPN 用戶端連線健康情況詳細數據。
VpnClientConnectionHealthDetailListResult	虛擬網路閘道 vpn 用戶端連線健康情況的清單。

CloudError

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	雲端錯誤本文。

CloudErrorBody

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程式碼不變，且要以程式設計方式使用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。 例如，錯誤中屬性的名稱。

VpnClientConnectionHealthDetail

VPN 用戶端連線健康情況詳細數據。

名稱	類型	Description
egressBytesTransferred	integer	每秒的輸出位元組數。
egressPacketsTransferred	integer	每秒輸出封包數。
ingressBytesTransferred	integer	每秒輸入位元組數。
ingressPacketsTransferred	integer	每秒輸入封包數。
maxBandwidth	integer	最大頻寬。
maxPacketsPerSecond	integer	每秒傳輸的最大封包數。
privateIpAddress	string	已連線 VPN 用戶端的指派私人 Ip。
publicIpAddress	string	已連線 VPN 用戶端的公用 Ip。
vpnConnectionDuration	integer	已連線 VPN 用戶端的持續時間。
vpnConnectionId	string	vpn 用戶端標識碼。
vpnConnectionTime	string	線上 VPN 用戶端的開始時間。
vpnUserName	string	線上 VPN 用戶端的用戶名稱。

VpnClientConnectionHealthDetailListResult

虛擬網路閘道 vpn 用戶端連線健康情況的清單。

名稱	類型	Description
value	VpnClientConnectionHealthDetail[]	VPN 用戶端連線健康情況的清單。