VpnGateway interface

Package:

@azure/arm-network

VpnGateway Resource.

Extends

Resource

Properties

bgpSettings	Local network gateway's BGP speaker settings.
connections	List of all vpn connections to the gateway.
enableBgpRouteTranslationForNat	Enable BGP routes translation for NAT on this VpnGateway.
etag	A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
ipConfigurations	List of all IPs configured on the gateway. NOTE: This property will not be serialized. It can only be populated by the server.
isRoutingPreferenceInternet	Enable Routing Preference property for the Public IP Interface of the VpnGateway.
natRules	List of all the nat Rules associated with the gateway.
provisioningState	The provisioning state of the VPN gateway resource. NOTE: This property will not be serialized. It can only be populated by the server.
virtualHub	The VirtualHub to which the gateway belongs.
vpnGatewayScaleUnit	The scale unit for this vpn gateway.

Inherited Properties

id	Resource ID.
location	Resource location.
name	Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

bgpSettings

Local network gateway's BGP speaker settings.

bgpSettings?: BgpSettings

Property Value

BgpSettings

connections

List of all vpn connections to the gateway.

connections?: VpnConnection[]

Property Value

VpnConnection[]

enableBgpRouteTranslationForNat

Enable BGP routes translation for NAT on this VpnGateway.

enableBgpRouteTranslationForNat?: boolean

Property Value

boolean

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

ipConfigurations

List of all IPs configured on the gateway. NOTE: This property will not be serialized. It can only be populated by the server.

ipConfigurations?: VpnGatewayIpConfiguration[]

Property Value

VpnGatewayIpConfiguration[]

isRoutingPreferenceInternet

Enable Routing Preference property for the Public IP Interface of the VpnGateway.

isRoutingPreferenceInternet?: boolean

Property Value

boolean

natRules

List of all the nat Rules associated with the gateway.

natRules?: VpnGatewayNatRule[]

Property Value

VpnGatewayNatRule[]

provisioningState

The provisioning state of the VPN gateway resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

virtualHub

The VirtualHub to which the gateway belongs.

virtualHub?: SubResource

Property Value

SubResource

vpnGatewayScaleUnit

The scale unit for this vpn gateway.

vpnGatewayScaleUnit?: number

Property Value

number

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location.

location?: string

Property Value

string

Inherited From Resource.location

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type