List Connections
Updated: June 7, 2012
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 constructed as follows. Replace <subscription-id> with the name of your subscription ID, and <virtual-network-name> with the name of the virtual network associated with the gateway:
| Method | Request URI | HTTP Version |
|---|---|---|
|
GET |
|
HTTP/1.1 |
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. For more information, see Versioning for the Blob, Queue, and Table services in Windows Azure. |
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). For information about status codes, see Service Management Status and Error Codes.
Response Headers
The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
| Response Header | Description |
|---|---|
|
x-ms-request-id |
This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations. |
Response Body
The format of the response body is as follows:
<?xml version="1.0" encoding="utf-8"?>
<Connections xmlns="http://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 key elements in the response body:
| Response Element | Description |
|---|---|
|
LocalNetworkSiteName |
The name of the local network site represented by the connection. |
|
ConnectivityState |
The connection state of the site. You can set the connection state to Connected, Connecting or NotConnected. |
|
Returns the time, in Coordinated Universal Time (UTC) format at which the provisioning event occurred. UTC formats are described by ISO 8601. |
|
|
IngressBytesTransferred |
The number of bytes of data transferred in through this connection since it was started. |
|
EgressBytesTransferred |
The number of bytes of data transferred out through this connection since it was started. |
|
LastConnectionEstablished |
The date and time, in Coordinated Universal Time (UTC) when the connection was last established. UTC formats are described by ISO 8601. |
|
AllocatedIPAddresses |
If LocalNetworkSiteName is defined as VPNClientConnection, this element contains a list of IP addresses (represented as strings) that are assigned to currently connected VPN clients. For example: <AllocatedIPAddresses> <string>10.0.0.1</string> <string>10.0.0.2</string> </AllocatedIPAddresses> If LocalNetworkSiteName is not defined as VPNClientConnection, this element is not used. |
LastEvent
Returns 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. |
Authorization
Any management certificate associated with the subscription specified by <subscription-id> can be used to authenticate this operation. For additional details, see Authenticating Service Management Requests.
Remarks
None.
See Also
