P2SVpnGateways 2 - Reset

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=2022-01-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

Request successful. The operation reset the primary of the P2SVpnGateway.

202 Accepted

Accepted and the operation will complete asynchronously.

Other Status Codes

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

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

Sample Response

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

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.

SubResource

Reference to another subresource.

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

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

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

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

List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to.

properties.provisioningState

The provisioning state of the P2SConnectionConfiguration resource.

properties.routingConfiguration

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

properties.vpnClientAddressPool

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

List of all p2s connection configurations of the gateway.

properties.provisioningState

The provisioning state of the P2S VPN gateway resource.

properties.virtualHub

The VirtualHub to which the gateway belongs.

properties.vpnClientConnectionHealth

All P2S VPN clients' connection health status.

properties.vpnGatewayScaleUnit
  • integer

The scale unit for this p2s vpn gateway.

properties.vpnServerConfiguration

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

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

The resource id RouteTable associated with this RoutingConfiguration.

propagatedRouteTables

The list of RouteTables to advertise the routes to.

vnetRoutes

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.

SubResource

Reference to another subresource.

Name Type Description
id
  • string

Resource ID.

VnetRoute

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

Name Type Description
bgpConnections

The list of references to HubBgpConnection objects.

staticRoutes

List of all Static Routes.

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

List of references to P2SConnectionConfigurations.

properties.policyMembers

Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.

properties.priority
  • integer

Priority for VpnServerConfigurationPolicyGroup.

properties.provisioningState

The provisioning state of the VpnServerConfigurationPolicyGroup resource.

type
  • string

Resource type.

VpnServerConfigurationPolicyGroupMember

VpnServerConfiguration PolicyGroup member

Name Type Description
attributeType

The Vpn Policy member attribute type.

attributeValue
  • string

The value of Attribute used for this VpnServerConfigurationPolicyGroupMember.

name
  • string

Name of the VpnServerConfigurationPolicyGroupMember.