3.1.5.17 VirtualGateways
The VirtualGateways resource describes the gateway used for cross-premises connectivity from the virtual network. The virtualGateway is a logical entity that runs on multiple gateways in the GatewayPools resource.
The Network Controller can create only one instance of the VirtualGateways resource per subscription. Clients or client tenants can then connect to it.
It is invoked through the following URI.
-
https://<url>/networking/v1/VirtualGateways/{resourceId}
url: The address or name of the REST server of the Network Controller.
resourceId: the identifier for the specific resource within the resource type. See section 2.2.3.4 for more details.
Note The server MAY support additional versions, v1 or later, in the URI.
The following HTTP methods can be performed on this resource.
|
HTTP method |
Section |
Description |
|---|---|---|
|
PUT |
Create a new VirtualGateways resource or update an existing VirtualGateways resource. |
|
|
GET |
Get one VirtualGateways resource. |
|
|
GET ALL |
List all VirtualGateways resources in the Network Controller. |
|
|
DELETE |
Delete a VirtualGateways resource. |
The following property elements are valid.
|
Element name |
Type |
Description |
|---|---|---|
|
etag |
Read-only |
Specified in Common JSON Elements, section 2.2.2. |
|
provisioningState |
Read-only |
Specified in Common JSON Elements, section 2.2.2. |
|
gatewaySubnets |
Required Read/write |
Indicates collection of references to IPv4/IPv6 subnet of the VSID/gateway subnet that includes the gateway. |
|
networkConnections |
Optional Read/write |
Indicates list of network connections that are configured for this VirtualGateways resource. See section 3.1.5.17.4 for full details on this element. |
|
vpnConfiguration.IPv4AddressPrefixes |
Read/write |
Indicates collection of IPv4 address pools from which VPN clients are assigned addresses. |
|
vpnConfiguration.IPv4AddressPrefixes |
Read/write |
Indicates IPv4 prefix of the pool. |
|
vpnConfiguration.IPv4AddressPrefixes.start |
Read/write |
Starting IPv4 address of the pool. This is required if the start and end addresses do not form a subnet. |
|
vpnConfiguration.IPv4AddressPrefixes.end |
Read/write |
Ending IPv4 address of the pool. This is not required if the start and end addresses form a subnet. |
|
vpnConfiguration.IPv6AddressPrefixes |
Read/write |
Indicates IPv6 prefix advertised to remote access VPN clients. |
|
vpnConfiguration.capacity |
Read/write |
Aggregate bandwidth capacity of VPN Clients in Kbps. |
|
vpnConfiguration.Realm |
Read/write |
Realm used to identify tenants. E.g. contoso, Woodgrove. |
|
bgpRouters |
Optional Read/write |
Indicates the BGP peering information. See section 3.1.5.17.2 for full details on this element. |
|
policyMaps |
Optional Read/write |
Indicates BGP policy maps. See section 3.1.5.17.3 for details. |
|
GatewayPools |
Required Read/write |
Indicates a collection of references to GatewayPools resources in which connections can be created. This information is populated at the time of subscription and can be changed only via the Service administrator portal. |
|
routingType |
Read-only |
Dynamic is the only support value for this field. |
|
configurationState |
Optional Read-only |
Indicates the last known running state of this virtual gateway. See specification in section 2.2.4. More details are given in the section for the GET operation section 3.1.5.17.1.2. |