Share via

VirtualNetworkGateway interface

  • Reference
Package:
@azure/arm-network

A common class for general resource information.

Extends
Resource

Properties

active

ActiveActive flag.
adminState

Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet
allowRemoteVnetTraffic

Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN.
allowVirtualWanTraffic

Configures this gateway to accept traffic from remote Virtual WAN networks.
autoScaleConfiguration

Autoscale configuration for virutal network gateway
bgpSettings

Virtual network gateway's BGP speaker settings.
customRoutes

The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
disableIPSecReplayProtection

disableIPSecReplayProtection flag.
enableBgp

Whether BGP is enabled for this virtual network gateway or not.
enableBgpRouteTranslationForNat

EnableBgpRouteTranslationForNat flag.
enableDnsForwarding

Whether dns forwarding is enabled or not.
enablePrivateIpAddress

Whether private IP needs to be enabled on this gateway for connections or not.
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.
extendedLocation

The extended location of type local virtual network gateway.
gatewayDefaultSite

The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.
gatewayType

The type of this virtual network gateway.
identity

The identity of the virtual network gateway, if configured.
inboundDnsForwardingEndpoint

The IP address allocated by the gateway to which dns requests can be sent. NOTE: This property will not be serialized. It can only be populated by the server.
ipConfigurations

IP configurations for virtual network gateway.
natRules

NatRules for virtual network gateway.
provisioningState

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

Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed
resourceGuid

The resource GUID property of the virtual network gateway resource. NOTE: This property will not be serialized. It can only be populated by the server.
sku

The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
virtualNetworkGatewayPolicyGroups

The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.
vNetExtendedLocationResourceId

Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.
vpnClientConfiguration

The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
vpnGatewayGeneration

The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.
vpnType

The type of this virtual network 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

active

ActiveActive flag.

active?: boolean

Property Value

boolean

adminState

Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet

adminState?: string

Property Value

string

allowRemoteVnetTraffic

Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN.

allowRemoteVnetTraffic?: boolean

Property Value

boolean

allowVirtualWanTraffic

Configures this gateway to accept traffic from remote Virtual WAN networks.

allowVirtualWanTraffic?: boolean

Property Value

boolean

autoScaleConfiguration

Autoscale configuration for virutal network gateway

autoScaleConfiguration?: VirtualNetworkGatewayAutoScaleConfiguration

Property Value

VirtualNetworkGatewayAutoScaleConfiguration

bgpSettings

Virtual network gateway's BGP speaker settings.

bgpSettings?: BgpSettings

Property Value

BgpSettings

customRoutes

The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.

customRoutes?: AddressSpace

Property Value

AddressSpace

disableIPSecReplayProtection

disableIPSecReplayProtection flag.

disableIPSecReplayProtection?: boolean

Property Value

boolean

enableBgp

Whether BGP is enabled for this virtual network gateway or not.

enableBgp?: boolean

Property Value

boolean

enableBgpRouteTranslationForNat

EnableBgpRouteTranslationForNat flag.

enableBgpRouteTranslationForNat?: boolean

Property Value

boolean

enableDnsForwarding

Whether dns forwarding is enabled or not.

enableDnsForwarding?: boolean

Property Value

boolean

enablePrivateIpAddress

Whether private IP needs to be enabled on this gateway for connections or not.

enablePrivateIpAddress?: 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

extendedLocation

The extended location of type local virtual network gateway.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

gatewayDefaultSite

The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.

gatewayDefaultSite?: SubResource

Property Value

SubResource

gatewayType

The type of this virtual network gateway.

gatewayType?: string

Property Value

string

identity

The identity of the virtual network gateway, if configured.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

inboundDnsForwardingEndpoint

The IP address allocated by the gateway to which dns requests can be sent. NOTE: This property will not be serialized. It can only be populated by the server.

inboundDnsForwardingEndpoint?: string

Property Value

string

ipConfigurations

IP configurations for virtual network gateway.

ipConfigurations?: VirtualNetworkGatewayIPConfiguration[]

Property Value

VirtualNetworkGatewayIPConfiguration[]

natRules

NatRules for virtual network gateway.

natRules?: VirtualNetworkGatewayNatRule[]

Property Value

VirtualNetworkGatewayNatRule[]

provisioningState

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

provisioningState?: string

Property Value

string

resiliencyModel

Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed

resiliencyModel?: string

Property Value

string

resourceGuid

The resource GUID property of the virtual network gateway resource. NOTE: This property will not be serialized. It can only be populated by the server.

resourceGuid?: string

Property Value

string

sku

The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.

sku?: VirtualNetworkGatewaySku

Property Value

VirtualNetworkGatewaySku

virtualNetworkGatewayPolicyGroups

The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.

virtualNetworkGatewayPolicyGroups?: VirtualNetworkGatewayPolicyGroup[]

Property Value

VirtualNetworkGatewayPolicyGroup[]

vNetExtendedLocationResourceId

Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.

vNetExtendedLocationResourceId?: string

Property Value

string

vpnClientConfiguration

The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.

vpnClientConfiguration?: VpnClientConfiguration

Property Value

VpnClientConfiguration

vpnGatewayGeneration

The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.

vpnGatewayGeneration?: string

Property Value

string

vpnType

The type of this virtual network gateway.

vpnType?: string

Property Value

string

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