VirtualNetworkGatewayPropertiesFormatOutput interface

Package:

@azure-rest/arm-network

VirtualNetworkGateway properties.

Properties

activeActive	ActiveActive flag.
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.
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.
inboundDnsForwardingEndpoint	The IP address allocated by the gateway to which dns requests can be sent.
ipConfigurations	IP configurations for virtual network gateway.
natRules	NatRules for virtual network gateway.
provisioningState	The provisioning state of the virtual network gateway resource.
resourceGuid	The resource GUID property of the virtual network gateway resource.
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.

Property Details

activeActive

ActiveActive flag.

activeActive?: boolean

Property Value

boolean

bgpSettings

Virtual network gateway's BGP speaker settings.

bgpSettings?: BgpSettingsOutput

Property Value

BgpSettingsOutput

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

Property Value

AddressSpaceOutput

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

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

Property Value

SubResourceOutput

gatewayType

The type of this virtual network gateway.

gatewayType?: "Vpn" | "ExpressRoute" | "LocalGateway"

Property Value

"Vpn" | "ExpressRoute" | "LocalGateway"

inboundDnsForwardingEndpoint

The IP address allocated by the gateway to which dns requests can be sent.

inboundDnsForwardingEndpoint?: string

Property Value

string

ipConfigurations

IP configurations for virtual network gateway.

ipConfigurations?: VirtualNetworkGatewayIPConfigurationOutput[]

Property Value

VirtualNetworkGatewayIPConfigurationOutput[]

natRules

NatRules for virtual network gateway.

natRules?: VirtualNetworkGatewayNatRuleOutput[]

Property Value

VirtualNetworkGatewayNatRuleOutput[]

provisioningState

The provisioning state of the virtual network gateway resource.

provisioningState?: "Succeeded" | "Updating" | "Deleting" | "Failed"

Property Value

"Succeeded" | "Updating" | "Deleting" | "Failed"

resourceGuid

The resource GUID property of the virtual network gateway resource.

resourceGuid?: string

Property Value

string

sku

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

sku?: VirtualNetworkGatewaySkuOutput

Property Value

VirtualNetworkGatewaySkuOutput

virtualNetworkGatewayPolicyGroups

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

virtualNetworkGatewayPolicyGroups?: VirtualNetworkGatewayPolicyGroupOutput[]

Property Value

VirtualNetworkGatewayPolicyGroupOutput[]

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

Property Value

VpnClientConfigurationOutput

vpnGatewayGeneration

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

vpnGatewayGeneration?: "None" | "Generation1" | "Generation2"

Property Value

"None" | "Generation1" | "Generation2"

vpnType

The type of this virtual network gateway.

vpnType?: "PolicyBased" | "RouteBased"

Property Value

"PolicyBased" | "RouteBased"