Ottenere i dettagli sull'integrità della connessione client VPN per connessione client P2S del gateway di rete virtuale nel gruppo di risorse specificato.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getVpnClientConnectionHealth?api-version=2023-09-01
Parametri dell'URI
| Nome |
In |
Necessario |
Tipo |
Descrizione |
|
resourceGroupName
|
path |
True
|
string
|
Nome del gruppo di risorse.
|
|
subscriptionId
|
path |
True
|
string
|
Credenziali della sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
|
|
virtualNetworkGatewayName
|
path |
True
|
string
|
Nome del gateway di rete virtuale.
|
|
api-version
|
query |
True
|
string
|
Versione API client.
|
Risposte
| Nome |
Tipo |
Descrizione |
|
200 OK
|
VpnClientConnectionHealthDetailListResult
|
Elenco dei dettagli sull'integrità della connessione client VPN.
|
|
202 Accepted
|
|
Accettata e l'operazione verrà completata in modo asincrono.
|
|
Other Status Codes
|
CloudError
|
Risposta di errore che descrive perché l'operazione non è riuscita.
|
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Nome |
Descrizione |
|
user_impersonation
|
rappresentare l'account utente
|
Esempio
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
Definizioni
CloudError
Risposta di errore dal servizio.
| Nome |
Tipo |
Descrizione |
|
error
|
CloudErrorBody
|
Corpo dell'errore cloud.
|
CloudErrorBody
Risposta di errore dal servizio.
| Nome |
Tipo |
Descrizione |
|
code
|
string
|
Identificatore dell'errore. I codici sono invarianti e devono essere usati a livello di codice.
|
|
details
|
CloudErrorBody[]
|
Elenco di dettagli aggiuntivi sull'errore.
|
|
message
|
string
|
Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
|
|
target
|
string
|
Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in caso di errore.
|
VpnClientConnectionHealthDetail
Dettagli sull'integrità della connessione client VPN.
| Nome |
Tipo |
Descrizione |
|
egressBytesTransferred
|
integer
|
Byte in uscita al secondo.
|
|
egressPacketsTransferred
|
integer
|
Pacchetti in uscita al secondo.
|
|
ingressBytesTransferred
|
integer
|
Byte in ingresso al secondo.
|
|
ingressPacketsTransferred
|
integer
|
Pacchetti in ingresso al secondo.
|
|
maxBandwidth
|
integer
|
Larghezza massima della banda.
|
|
maxPacketsPerSecond
|
integer
|
I pacchetti massimi trasferiti al secondo.
|
|
privateIpAddress
|
string
|
Ip privato assegnato di un client VPN connesso.
|
|
publicIpAddress
|
string
|
Ip pubblico di un client VPN connesso.
|
|
vpnConnectionDuration
|
integer
|
Tempo di durata di un client VPN connesso.
|
|
vpnConnectionId
|
string
|
ID client VPN.
|
|
vpnConnectionTime
|
string
|
Ora di inizio di un client VPN connesso.
|
|
vpnUserName
|
string
|
Nome utente di un client VPN connesso.
|
VpnClientConnectionHealthDetailListResult
Elenco dell'integrità della connessione client vpn del gateway di rete virtuale.
| Nome |
Tipo |
Descrizione |
|
value
|
VpnClientConnectionHealthDetail[]
|
Elenco dell'integrità della connessione client VPN.
|