List Connections
The List Connections operation returns a list of the local network connections that can be accessed through the gateway.
Request
The List Connections request may be specified as follows. Replace <subscription-id> with the subscription ID and <virtual-network-name> with the name of the virtual network associated with the gateway.
Method |
Request URI |
---|---|
GET |
https://management.core.windows.net/<subscription-id>/services/networking/<virtual-network-name>/gateway/connections |
URI Parameters
None.
Request Headers
The following table describes the request headers.
Request Header |
Description |
---|---|
x-ms-version |
Required. Specifies the version of the operation to use for this request. The value for this header should be set to 2012-03-01 or higher. |
Request Body
None.
Response
The response includes an HTTP status code, a response body, and a set of response headers.
Status Code
A successful operation returns status code 200 (OK).
Response Headers
The response for this operation includes the following headers. The response may also include additional standard HTTP headers.
Response Header |
Description |
---|---|
x-ms-request-id |
A value that uniquely identifies a request made against the management service. |
Response Body
The format of the response body is as follows:
<?xml version="1.0" encoding="utf-8"?>
<Connections xmlns="https://schemas.microsoft.com/windowsazure">
<Connection>
<LocalNetworkSiteName>name</LocalNetworkSiteName>
<ConnectivityState>connection-state</ConnectivityState >
<LastEvent>
<Timestamp>connect-event-time</Timestamp>
<Id>connect-event-id</Id>
<Message>connect-event-message</Message>
<Data>connect-event-data</Data>
</LastEvent>
<IngressBytesTransferred>data-in-transferred</IngressBytesTransferred >
<EgressBytesTransferred>data-out-transferred</EgressBytesTransferred>
<LastConnectionEstablished>last-cn-estab</LastConnectionEstablished>
<AllocatedIPAddresses>allocated-ip-addresses</AllocatedIPAddresses>
</Connection>
</Connections>
The following table describes the elements in the response body.
Response Element |
Description |
---|---|
LocalNetworkSiteName |
Specifies the name of the local network site represented by the connection. |
ConnectivityState |
Specifies the connection state of the site. Possible values are:
|
LastEvent |
Specifies the time, in Coordinated Universal Time (UTC) format at which the provisioning event occurred. |
IngressBytesTransferred |
Specifies the number of bytes of data transferred in through this connection since it was started. |
EgressBytesTransferred |
Specifies the number of bytes of data transferred out through this connection since it was started. |
LastConnectionEstablished |
Specifies the date and time, in Coordinated Universal Time (UTC) when the connection was last established. |
AllocatedIPAddresses |
If LocalNetworkSiteName is defined as VPNClientConnection, this element specifies a list of IP addresses (represented as strings) that are assigned to currently connected VPN clients. For example:
If LocalNetworkSiteName is not defined as VPNClientConnection, this element is not used. |
LastEvent
Specifies the time, in Coordinated Universal Time (UTC) format at which the provisioning event occurred.
Element |
Description |
---|---|
Timestamp |
Specifies that the event occurred. |
Id |
Specifies the ID that represents the event. |
Message |
Specifies a message that describes the event. |
Data |
Specifies data related to the event. |