Virtual Network Gateway Connections - Reset Connection

Resets the virtual network gateway connection specified.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/resetconnection?api-version=2023-09-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 name of the virtual network gateway Connection.

api-version
query True

string

Client API version.

Responses

Name Type Description
202 Accepted

Accepted and the operation will complete asynchronously.

Other Status Codes

ErrorResponse

The operation resetconnection could not be completed.

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

ResetVirtualNetworkGatewayConnection

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/conn1/resetconnection?api-version=2023-09-01

Sample Response

Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2023-09-01

Definitions

Name Description
ErrorDetails

Common error details representation.

ErrorResponse

The error object.

ErrorDetails

Common error details representation.

Name Type Description
code

string

Error code.

message

string

Error message.

target

string

Error target.

ErrorResponse

The error object.

Name Type Description
error

ErrorDetails

Error
The error details object.