P2SVpnGateways 2 - Reset

Service:

Virtual WAN

API Version:

2023-05-01

Resets the primary of the p2s vpn gateway in the specified resource group.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/reset?api-version=2023-05-01

URI Parameters

Name	In	Required	Type	Description
gatewayName	path	True	string	The name of the gateway.
resourceGroupName	path	True	string	The resource group name of the P2SVpnGateway.
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.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	P2SVpnGateway	Request successful. The operation reset the primary of the P2SVpnGateway.
202 Accepted		Accepted and the operation will complete asynchronously.
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

ResetP2SVpnGateway

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2svpnGateways/p2sVpnGateway1/reset?api-version=2023-05-01

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python p2_svpn_gateway_reset.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.p2_svpn_gateways.begin_reset(
        resource_group_name="rg1",
        gateway_name="p2sVpnGateway1",
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/P2SVpnGatewayReset.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/80c21c17b4a7aa57f637ee594f7cfd653255a7e0/specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/P2SVpnGatewayReset.json
func ExampleP2SVPNGatewaysClient_BeginReset() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewP2SVPNGatewaysClient().BeginReset(ctx, "rg1", "p2sVpnGateway1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.P2SVPNGateway = armnetwork.P2SVPNGateway{
	// 	Name: to.Ptr("p2sVpnGateway1"),
	// 	Type: to.Ptr("Microsoft.Network/p2sVpnGateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1"),
	// 	Location: to.Ptr("West US"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.P2SVPNGatewayProperties{
	// 		CustomDNSServers: []*string{
	// 			to.Ptr("3.3.3.3")},
	// 			IsRoutingPreferenceInternet: to.Ptr(false),
	// 			P2SConnectionConfigurations: []*armnetwork.P2SConnectionConfiguration{
	// 				{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1"),
	// 					Name: to.Ptr("P2SConnectionConfig1"),
	// 					Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 					Properties: &armnetwork.P2SConnectionConfigurationProperties{
	// 						ConfigurationPolicyGroupAssociations: []*armnetwork.SubResource{
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1"),
	// 						}},
	// 						EnableInternetSecurity: to.Ptr(false),
	// 						PreviousConfigurationPolicyGroupAssociations: []*armnetwork.VPNServerConfigurationPolicyGroup{
	// 							{
	// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1"),
	// 								Name: to.Ptr("policyGroup1"),
	// 								Properties: &armnetwork.VPNServerConfigurationPolicyGroupProperties{
	// 									IsDefault: to.Ptr(true),
	// 									PolicyMembers: []*armnetwork.VPNServerConfigurationPolicyGroupMember{
	// 										{
	// 											Name: to.Ptr("policy1"),
	// 											AttributeType: to.Ptr(armnetwork.VPNPolicyMemberAttributeTypeRadiusAzureGroupID),
	// 											AttributeValue: to.Ptr("6ad1bd08"),
	// 									}},
	// 									Priority: to.Ptr[int32](0),
	// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 								},
	// 						}},
	// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 						VPNClientAddressPool: &armnetwork.AddressSpace{
	// 							AddressPrefixes: []*string{
	// 								to.Ptr("101.3.0.0/16")},
	// 							},
	// 						},
	// 				}},
	// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				VirtualHub: &armnetwork.SubResource{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"),
	// 				},
	// 				VPNClientConnectionHealth: &armnetwork.VPNClientConnectionHealth{
	// 					AllocatedIPAddresses: []*string{
	// 						to.Ptr("1.1.1.1"),
	// 						to.Ptr("2.2.2.2")},
	// 						TotalEgressBytesTransferred: to.Ptr[int64](3000),
	// 						TotalIngressBytesTransferred: to.Ptr[int64](2000),
	// 						VPNClientConnectionsCount: to.Ptr[int32](2),
	// 					},
	// 					VPNGatewayScaleUnit: to.Ptr[int32](1),
	// 					VPNServerConfiguration: &armnetwork.SubResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1"),
	// 					},
	// 				},
	// 			}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Resets the primary of the p2s vpn gateway in the specified resource group.
 *
 * @summary Resets the primary of the p2s vpn gateway in the specified resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/P2SVpnGatewayReset.json
 */
async function resetP2SVpnGateway() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "p2sVpnGateway1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.p2SVpnGateways.beginResetAndWait(resourceGroupName, gatewayName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-05-01/examples/P2SVpnGatewayReset.json
// this example is just showing the usage of "P2SVpnGateways_Reset" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this P2SVpnGatewayResource created on azure
// for more information of creating P2SVpnGatewayResource, please refer to the document of P2SVpnGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string gatewayName = "p2sVpnGateway1";
ResourceIdentifier p2sVpnGatewayResourceId = P2SVpnGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, gatewayName);
P2SVpnGatewayResource p2sVpnGateway = client.GetP2SVpnGatewayResource(p2sVpnGatewayResourceId);

// invoke the operation
ArmOperation<P2SVpnGatewayResource> lro = await p2sVpnGateway.ResetAsync(WaitUntil.Completed);
P2SVpnGatewayResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
P2SVpnGatewayData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

202

Status code:

200

{
  "name": "p2sVpnGateway1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "type": "Microsoft.Network/p2sVpnGateways",
  "properties": {
    "provisioningState": "Succeeded",
    "virtualHub": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1"
    },
    "vpnServerConfiguration": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1"
    },
    "p2SConnectionConfigurations": [
      {
        "name": "P2SConnectionConfig1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "properties": {
          "provisioningState": "Succeeded",
          "vpnClientAddressPool": {
            "addressPrefixes": [
              "101.3.0.0/16"
            ]
          },
          "configurationPolicyGroupAssociations": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1"
            }
          ],
          "previousConfigurationPolicyGroupAssociations": [
            {
              "name": "policyGroup1",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1",
              "properties": {
                "provisioningState": "Succeeded",
                "isDefault": true,
                "priority": 0,
                "policyMembers": [
                  {
                    "name": "policy1",
                    "attributeType": "RadiusAzureGroupId",
                    "attributeValue": "6ad1bd08"
                  }
                ]
              }
            }
          ],
          "enableInternetSecurity": false
        }
      }
    ],
    "vpnGatewayScaleUnit": 1,
    "customDnsServers": [
      "3.3.3.3"
    ],
    "vpnClientConnectionHealth": {
      "vpnClientConnectionsCount": 2,
      "allocatedIpAddresses": [
        "1.1.1.1",
        "2.2.2.2"
      ],
      "totalIngressBytesTransferred": 2000,
      "totalEgressBytesTransferred": 3000
    },
    "isRoutingPreferenceInternet": false
  }
}

Definitions

Name	Description
AddressSpace	AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
P2SConnectionConfiguration	P2SConnectionConfiguration Resource.
P2SVpnGateway	P2SVpnGateway Resource.
PropagatedRouteTable	The list of RouteTables to advertise the routes to.
ProvisioningState	The current provisioning state.
RoutingConfiguration	Routing Configuration indicating the associated and propagated route tables for this connection.
StaticRoute	List of all Static Routes.
StaticRoutesConfig	Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection.
SubResource	Reference to another subresource.
VnetLocalRouteOverrideCriteria	Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke vnet.
VnetRoute	List of routes that control routing from VirtualHub into a virtual network connection.
VpnClientConnectionHealth	VpnClientConnectionHealth properties.
VpnPolicyMemberAttributeType	The Vpn Policy member attribute type.
VpnServerConfigurationPolicyGroup	VpnServerConfigurationPolicyGroup Resource.
VpnServerConfigurationPolicyGroupMember	VpnServerConfiguration PolicyGroup member

AddressSpace

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

Name	Type	Description
addressPrefixes	string[]	A list of address blocks reserved for this virtual network in CIDR notation.

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.

P2SConnectionConfiguration

P2SConnectionConfiguration Resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.configurationPolicyGroupAssociations	SubResource[]	List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to.
properties.enableInternetSecurity	boolean	Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.
properties.previousConfigurationPolicyGroupAssociations	VpnServerConfigurationPolicyGroup[]	List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to.
properties.provisioningState	ProvisioningState	The provisioning state of the P2SConnectionConfiguration resource.
properties.routingConfiguration	RoutingConfiguration	The Routing Configuration indicating the associated and propagated route tables on this connection.
properties.vpnClientAddressPool	AddressSpace	The reference to the address space resource which represents Address space for P2S VpnClient.

P2SVpnGateway

P2SVpnGateway Resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.customDnsServers	string[]	List of all customer specified DNS servers IP addresses.
properties.isRoutingPreferenceInternet	boolean	Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
properties.p2SConnectionConfigurations	P2SConnectionConfiguration[]	List of all p2s connection configurations of the gateway.
properties.provisioningState	ProvisioningState	The provisioning state of the P2S VPN gateway resource.
properties.virtualHub	SubResource	The VirtualHub to which the gateway belongs.
properties.vpnClientConnectionHealth	VpnClientConnectionHealth	All P2S VPN clients' connection health status.
properties.vpnGatewayScaleUnit	integer	The scale unit for this p2s vpn gateway.
properties.vpnServerConfiguration	SubResource	The VpnServerConfiguration to which the p2sVpnGateway is attached to.
tags	object	Resource tags.
type	string	Resource type.

PropagatedRouteTable

The list of RouteTables to advertise the routes to.

Name	Type	Description
ids	SubResource[]	The list of resource ids of all the RouteTables.
labels	string[]	The list of labels.

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

RoutingConfiguration

Routing Configuration indicating the associated and propagated route tables for this connection.

Name	Type	Description
associatedRouteTable	SubResource	The resource id RouteTable associated with this RoutingConfiguration.
inboundRouteMap	SubResource	The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes.
outboundRouteMap	SubResource	The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes.
propagatedRouteTables	PropagatedRouteTable	The list of RouteTables to advertise the routes to.
vnetRoutes	VnetRoute	List of routes that control routing from VirtualHub into a virtual network connection.

StaticRoute

List of all Static Routes.

Name	Type	Description
addressPrefixes	string[]	List of all address prefixes.
name	string	The name of the StaticRoute that is unique within a VnetRoute.
nextHopIpAddress	string	The ip address of the next hop.

StaticRoutesConfig

Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection.

Name	Type	Description
propagateStaticRoutes	boolean	Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.

SubResource

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.

VnetLocalRouteOverrideCriteria

Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke vnet.

Name	Type	Description
Contains	string
Equal	string

VnetRoute

List of routes that control routing from VirtualHub into a virtual network connection.

Name	Type	Description
bgpConnections	SubResource[]	The list of references to HubBgpConnection objects.
staticRoutes	StaticRoute[]	List of all Static Routes.
staticRoutesConfig	StaticRoutesConfig	Configuration for static routes on this HubVnetConnection.

VpnClientConnectionHealth

VpnClientConnectionHealth properties.

Name	Type	Description
allocatedIpAddresses	string[]	List of allocated ip addresses to the connected p2s vpn clients.
totalEgressBytesTransferred	integer	Total of the Egress Bytes Transferred in this connection.
totalIngressBytesTransferred	integer	Total of the Ingress Bytes Transferred in this P2S Vpn connection.
vpnClientConnectionsCount	integer	The total of p2s vpn clients connected at this time to this P2SVpnGateway.

VpnPolicyMemberAttributeType

The Vpn Policy member attribute type.

Name	Type	Description
AADGroupId	string
CertificateGroupId	string
RadiusAzureGroupId	string

VpnServerConfigurationPolicyGroup

VpnServerConfigurationPolicyGroup Resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.isDefault	boolean	Shows if this is a Default VpnServerConfigurationPolicyGroup or not.
properties.p2SConnectionConfigurations	SubResource[]	List of references to P2SConnectionConfigurations.
properties.policyMembers	VpnServerConfigurationPolicyGroupMember[]	Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.
properties.priority	integer	Priority for VpnServerConfigurationPolicyGroup.
properties.provisioningState	ProvisioningState	The provisioning state of the VpnServerConfigurationPolicyGroup resource.
type	string	Resource type.

VpnServerConfigurationPolicyGroupMember

VpnServerConfiguration PolicyGroup member

Name	Type	Description
attributeType	VpnPolicyMemberAttributeType	The Vpn Policy member attribute type.
attributeValue	string	The value of Attribute used for this VpnServerConfigurationPolicyGroupMember.
name	string	Name of the VpnServerConfigurationPolicyGroupMember.