Microsoft.Network p2svpnGateways 2020-06-01

Template format

To create a Microsoft.Network/p2svpnGateways resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Network/p2svpnGateways",
  "apiVersion": "2020-06-01",
  "location": "string",
  "tags": {},
  "properties": {
    "virtualHub": {
      "id": "string"
    },
    "p2SConnectionConfigurations": [
      {
        "id": "string",
        "properties": {
          "vpnClientAddressPool": {
            "addressPrefixes": [
              "string"
            ]
          },
          "routingConfiguration": {
            "associatedRouteTable": {
              "id": "string"
            },
            "propagatedRouteTables": {
              "labels": [
                "string"
              ],
              "ids": [
                {
                  "id": "string"
                }
              ]
            },
            "vnetRoutes": {
              "staticRoutes": [
                {
                  "name": "string",
                  "addressPrefixes": [
                    "string"
                  ],
                  "nextHopIpAddress": "string"
                }
              ]
            }
          },
          "enableInternetSecurity": "boolean"
        },
        "name": "string"
      }
    ],
    "vpnGatewayScaleUnit": "integer",
    "vpnServerConfiguration": {
      "id": "string"
    },
    "customDnsServers": [
      "string"
    ]
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Network/p2svpnGateways object

Name Type Required Value
name string Yes The name of the gateway.
type enum Yes Microsoft.Network/p2svpnGateways
apiVersion enum Yes 2020-06-01
location string Yes Resource location.
tags object No Resource tags.
properties object Yes Properties of the P2SVpnGateway. - P2SVpnGatewayProperties object

P2SVpnGatewayProperties object

Name Type Required Value
virtualHub object No The VirtualHub to which the gateway belongs. - SubResource object
p2SConnectionConfigurations array No List of all p2s connection configurations of the gateway. - P2SConnectionConfiguration object
vpnGatewayScaleUnit integer No The scale unit for this p2s vpn gateway.
vpnServerConfiguration object No The VpnServerConfiguration to which the p2sVpnGateway is attached to. - SubResource object
customDnsServers array No List of all customer specified DNS servers IP addresses. - string

SubResource object

Name Type Required Value
id string No Resource ID.

P2SConnectionConfiguration object

Name Type Required Value
id string No Resource ID.
properties object No Properties of the P2S connection configuration. - P2SConnectionConfigurationProperties object
name string No The name of the resource that is unique within a resource group. This name can be used to access the resource.

P2SConnectionConfigurationProperties object

Name Type Required Value
vpnClientAddressPool object No The reference to the address space resource which represents Address space for P2S VpnClient. - AddressSpace object
routingConfiguration object No The Routing Configuration indicating the associated and propagated route tables on this connection. - RoutingConfiguration object
enableInternetSecurity boolean No Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.

AddressSpace object

Name Type Required Value
addressPrefixes array No A list of address blocks reserved for this virtual network in CIDR notation. - string

RoutingConfiguration object

Name Type Required Value
associatedRouteTable object No The resource id RouteTable associated with this RoutingConfiguration. - SubResource object
propagatedRouteTables object No The list of RouteTables to advertise the routes to. - PropagatedRouteTable object
vnetRoutes object No List of routes that control routing from VirtualHub into a virtual network connection. - VnetRoute object

PropagatedRouteTable object

Name Type Required Value
labels array No The list of labels. - string
ids array No The list of resource ids of all the RouteTables. - SubResource object

VnetRoute object

Name Type Required Value
staticRoutes array No List of all Static Routes. - StaticRoute object

StaticRoute object

Name Type Required Value
name string No The name of the StaticRoute that is unique within a VnetRoute.
addressPrefixes array No List of all address prefixes. - string
nextHopIpAddress string No The ip address of the next hop.