Get Virtual Network Gateway Shared Key
Updated: June 7, 2012
The Get Virtual Network Gateway Shared Key operation returns the shared key used by the virtual network gateway to authenticate connections with individual sites on a virtual network.
Request
The Get Virtual Network Gateway Shared Key request may be constructed as follows. Replace <subscription-id> with the name of your 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 | 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 201 (Created). 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"?> <SharedKey xmlns="http://schemas.microsoft.com/windowsazure"> <Value>sharedkey</Value> </SharedKey>
The following table describes the key elements in the response body:
| Response Element | Description |
|---|---|
|
Value |
Contains the shared key used by the gateway to authenticate connections to sites on a virtual network. |
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