Reset Virtual Network Gateway Shared Key
Updated: December 10, 2013
The Reset Virtual Network Gateway Shared Key operation generates a new shared key with a specified character length.
The Reset 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 gateway, and
<local-network-site-name> with the name of the local network site associated with the shared key.
|Method||Request URI||HTTP Version|
The following table describes the request headers.
Required. Specifies the version of the operation to use for this request. The value for this header should be set to
The format of the request body is as follows:
<?xml version="1.0" encoding="utf-8"?> <ResetSharedKey xmlns="http://schemas.microsoft.com/windowsazure"> <KeyLength>key-length</KeyLength> </ResetSharedKey>
The following table describes the elements in the request body:
Optional. Specifies the number of characters in the shared key. The key length must be between 1 and 128 characters.
The response includes an HTTP status code, a response body, and a set of response headers.
A successful operation returns status code 202 (Accept). If another Reset Virtual Network Gateway Shared Key operation is already in progress on the subscription, virtual network and local network site, returns status code of 409 (Conflict). For information about status codes, see Service Management Status and Error Codes.
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.
This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations.
The format of the response body is as follows:
<?xml version="1.0" encoding="utf-8"?> <GatewayOperationAsyncResponse xmlns="http://schemas.microsoft.com/windowsazure"> <ID>operation-id</ID> </GatewayOperationAsyncResponse>
The following table describes the elements in the response body:
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.
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.
A virtual network gateway shared key is required to authenticate connections between the gateway and local VPN devices.