Connect to, Disconnect from, or Test your Connection to a Local Network
The Connect to, Disconnect from, or Test your Connection to a Local Network operation enables you to connect to, disconnect from, or test your connection to a local network site, access the connection resource that represents the local network, and specify Connect, Disconnect or Test to perform the desired operation.
Request
The Connect to, Disconnect from, or Test your Connection to a Local Network request may be specified as follows. Replace <subscription-id> with the subscription ID, <virtual-network-name> with the name of the virtual network associated with the gateway, and <local-network-site-name> with the name of the site to connect to.
Method |
Request URI |
|---|---|
PUT |
https://management.core.windows.net/<subscription-id>/services/networking/<virtual-network-name>/gateway/connection/<local-network-site-name> |
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
The format of the request body is as follows:
<?xml version="1.0" encoding="utf-8"?>
<UpdateConnection xmlns="https://schemas.microsoft.com/windowsazure">
<Operation>operation</Operation>
<IPAddress>ip-address</IPAddress>
</UpdateConnection>
The following table describes the elements in the request body:
Request Elements |
Description |
|---|---|
Operation |
Required. Specifies the operation to perform on the connection. Can be set to Connect, Disconnect or Test to connect to a local network, disconnect from a local network, or test the gateway’s connection to a local network site. |
IPAddress |
Required if operation is set to Test; otherwise not used. Specifies the IP address of the target local network site with which the gateway will test connectivity. |
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). If another operation of the same type, Connect, Disconnect, or Test, is already in progress on the subscription, virtual network, and local network site, this operation returns status code 409 (Conflict).
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"?>
<GatewayOperationAsyncResponse xmlns="https://schemas.microsoft.com/windowsazure">
<ID>operation-id</ID>
</GatewayOperationAsyncResponse>
The following table describes the elements in the response body:
Response Element |
Description |
|---|---|
ID |
Uniquely identifies the operation. To get more information about the status of an operation, such as whether it is still executing or complete, you can call Get Virtual Network Gateway Operation Status with the operation ID. |