Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Network]: get virtualnetwork gateway vpn connection health #5883

Merged
merged 2 commits into from
May 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"parameters": {
"resourceGroupName": "p2s-vnet-test",
"api-version": "2019-04-01",
"subscriptionId": "subid",
"virtualNetworkGatewayName" : "vpnp2sgw"
},
"responses": {
"200": {
"body": {
"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
}
]
}
},
"202": {
}
}
}

Original file line number Diff line number Diff line change
Expand Up @@ -1572,6 +1572,55 @@
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getVpnClientConnectionHealth": {
"post": {
"tags": [
"VirtualNetworkGateways"
],
"operationId": "VirtualNetworkGateways_GetVpnclientConnectionHealth",
"description": "Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.",
"parameters": [
{
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group."
},
{
"name": "virtualNetworkGatewayName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the virtual network gateway."
},
{
"$ref": "./network.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./network.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "List of VPN client connection health details.",
"schema": {
"$ref": "#/definitions/VpnClientConnectionHealthDetailListResult"
}
},
"202": {
"description": "Accepted and the operation will complete asynchronously."
}
},
"x-ms-examples": {
"GetVirtualNetworkGatewayVpnclientConnectionHealth": { "$ref": "./examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json" }
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -2775,6 +2824,90 @@
"name": "VirtualNetworkGatewayConnectionType",
"modelAsString": true
}
},
"VpnClientConnectionHealthDetailListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/VpnClientConnectionHealthDetail"
},
"description": "List of vpn client connection health"
}
},
"description": "List of virtual network gateway vpn client connection health"
},
"VpnClientConnectionHealthDetail": {
"properties": {
"vpnConnectionId": {
"type": "string",
"readOnly": true,
"description": "The vpn client Id"
},
"vpnConnectionDuration": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The duration time of a connected vpn client "
},
"vpnConnectionTime": {
"type": "string",
"readOnly": true,
"description": "The start time of a connected vpn client"
},
"publicIpAddress": {
"type": "string",
"readOnly": true,
"description": "The public Ip of a connected vpn client"
},
"privateIpAddress": {
"type": "string",
"readOnly": true,
"description": "The assigned private Ip of a connected vpn client"
},
"vpnUserName": {
"type": "string",
"readOnly": true,
"description": "The user name of a connected vpn client"
},
"maxBandwidth": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The max band width"
},
"egressPacketsTransferred": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The egress packets per second"
},
"egressBytesTransferred": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The egress bytes per second"
},
"ingressPacketsTransferred": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ingress packets per second"
},
"ingressBytesTransferred": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ingress bytes per second"
},
"maxPacketsPerSecond": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The max packets transferred per second"
}
},
"description": "VPN client connection health detail"
}
}
}