Share via


Get Virtual Network Gateway Shared Key

 

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 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

GET

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

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).

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

<?xml version="1.0" encoding="utf-8"?>
<SharedKey xmlns="https://schemas.microsoft.com/windowsazure">
  <Value>sharedkey</Value>
</SharedKey>

The following table describes the elements in the response body.

Response Element

Description

Value

Specifies the shared key used by the gateway to authenticate connections to sites on a virtual network.