Set Virtual Network Gateway Shared Key
The Set Virtual Network Gateway Shared Key operation configures the shared key that is used by the virtual network gateway to authenticate connections with individual sites on a virtual network.
Request
The Set Virtual Network Gateway Shared Key request is specified as follows. Replace <subscription-id> with the subscription ID, <virtual-network-name> with the name of the virtual network associated with the virtual network gateway, and <local-network-site-name> with the name of the local network site associated with the shared key.
Method |
Request URI |
|---|---|
POST |
https://management.core.windows.net/<subscription-id>/services/networking/<virtual-network-name>/gateway/connection/<local-network-site-name>/sharedkey |
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"?>
<SharedKey xmlns="https://schemas.microsoft.com/windowsazure">
<Value>shared-key</Value>
</SharedKey>
The following table describes the elements in the response body.
Element |
Description |
|---|---|
Value |
Required. Specifies the shared key used by the gateway to authenticate connections to sites on a virtual network. The value must be an alphanumeric string (a-zA-Z0-9) up to 128 characters long. |
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"?>
<GatewayOperationAsyncResponse xmlns="https://schemas.microsoft.com/windowsazure">
<ID>operation-id</ID>
</GatewayOperationAsyncResponse>
The following table describes the elements in the response body:
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. |