你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Virtual Network Gateway Connections - Reset Shared Key

The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey/reset?api-version=2024-01-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

virtualNetworkGatewayConnectionName
path True

string

The virtual network gateway connection reset shared key Name.

api-version
query True

string

Client API version.

Request Body

Name Required Type Description
keyLength True

integer

The virtual network connection reset shared key length, should between 1 and 128.

Responses

Name Type Description
200 OK

ConnectionResetSharedKey

Request successful. The operation sets the virtual network gateway connection shared key.

202 Accepted

Request successful. The operation sets the virtual network gateway connection shared key.

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ResetVirtualNetworkGatewayConnectionSharedKey

Sample request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/conn1/sharedkey/reset?api-version=2024-01-01

{
  "keyLength": 128
}

Sample response

{
  "keyLength": 128
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-01-01

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

ConnectionResetSharedKey

The virtual network connection reset shared key.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

ConnectionResetSharedKey

The virtual network connection reset shared key.

Name Type Description
keyLength

integer

The virtual network connection reset shared key length, should between 1 and 128.