Virtual Network Gateways - Get Vpnclient Connection Health

Referenz

Dienst:: Network Gateway

API-Version:: 2023-11-01

Rufen Sie die Integritätsdetails der VPN-Clientverbindung pro P2S-Clientverbindung des virtuellen Netzwerkgateways in der angegebenen Ressourcengruppe ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
virtualNetworkGatewayName	path	True	string	Der Name des virtuellen Netzwerkgateways.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	VpnClientConnectionHealthDetailListResult	Liste der Integritätsdetails der VPN-Clientverbindung.
202 Accepted		Angenommen und der Vorgang wird asynchron abgeschlossen.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

GetVirtualNetworkGatewayVpnclientConnectionHealth

Beispielanforderung

POST https://management.azure.com/subscriptions/subid/resourceGroups/p2s-vnet-test/providers/Microsoft.Network/virtualNetworkGateways/vpnp2sgw/getVpnClientConnectionHealth?api-version=2023-11-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-11-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/f4c6c8697c59f966db0d1e36b62df3af3bca9065/specification/network/resource-manager/Microsoft.Network/stable/2023-11-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-11-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

Beispiel für eine Antwort

Statuscode:: 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
    }
  ]
}

Statuscode:: 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-11-01

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Diensts.
CloudErrorBody	Eine Fehlerantwort des Diensts.
VpnClientConnectionHealthDetail	Details zur VPN-Clientverbindung.
VpnClientConnectionHealthDetailListResult	Liste der Vpn-Clientverbindungsstatus des virtuellen Netzwerkgateways.

CloudError

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Cloudfehlertext.

CloudErrorBody

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

VpnClientConnectionHealthDetail

Details zur VPN-Clientverbindung.

Name	Typ	Beschreibung
egressBytesTransferred	integer	Die Ausgangsbytes pro Sekunde.
egressPacketsTransferred	integer	Die Ausgangspakete pro Sekunde.
ingressBytesTransferred	integer	Die Eingangsbytes pro Sekunde.
ingressPacketsTransferred	integer	Die Eingehenden Pakete pro Sekunde.
maxBandwidth	integer	Die maximale Bandbreite.
maxPacketsPerSecond	integer	Die maximalen Pakete, die pro Sekunde übertragen werden.
privateIpAddress	string	Die zugewiesene private IP eines verbundenen VPN-Clients.
publicIpAddress	string	Die öffentliche IP eines verbundenen VPN-Clients.
vpnConnectionDuration	integer	Die Dauer eines verbundenen VPN-Clients.
vpnConnectionId	string	Die VPN-Client-ID.
vpnConnectionTime	string	Die Startzeit eines verbundenen VPN-Clients.
vpnUserName	string	Der Benutzername eines verbundenen VPN-Clients.

VpnClientConnectionHealthDetailListResult

Liste der Vpn-Clientverbindungsstatus des virtuellen Netzwerkgateways.

Name	Typ	Beschreibung
value	VpnClientConnectionHealthDetail[]	Liste der Vpn-Clientverbindungsintegrität.

Freigeben über

Virtual Network Gateways - Get Vpnclient Connection Health

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

GetVirtualNetworkGatewayVpnclientConnectionHealth

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudError

CloudErrorBody

VpnClientConnectionHealthDetail

VpnClientConnectionHealthDetailListResult

Zusätzliche Ressourcen