Virtual Network Gateway

This table represents the Virtual Network Gateway resource from Microsoft Azure.

azure.virtual_network_gateway

Fields

TitleIDTypeData TypeDescription
_keycorestring
active_activecoreboolActiveActive flag.
admin_statecorestringProperty to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet
allow_remote_vnet_trafficcoreboolConfigure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN.
allow_virtual_wan_trafficcoreboolConfigures this gateway to accept traffic from remote Virtual WAN networks.
auto_scale_configurationcorejsonAutoscale configuration for virutal network gateway
bgp_settingscorejsonVirtual network gateway's BGP speaker settings.
custom_routescorejsonThe reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
disable_ip_sec_replay_protectioncorebooldisableIPSecReplayProtection flag.
enable_bgpcoreboolWhether BGP is enabled for this virtual network gateway or not.
enable_bgp_route_translation_for_natcoreboolEnableBgpRouteTranslationForNat flag.
enable_dns_forwardingcoreboolWhether dns forwarding is enabled or not.
enable_private_ip_addresscoreboolWhether private IP needs to be enabled on this gateway for connections or not.
etagcorestringA unique read-only string that changes whenever the resource is updated.
extended_locationcorejsonThe extended location of type local virtual network gateway.
gateway_default_sitecorejsonThe reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.
gateway_typecorestringThe type of this virtual network gateway.
idcorestringResource ID.
inbound_dns_forwarding_endpointcorestringThe IP address allocated by the gateway to which dns requests can be sent.
ip_configurationscorejsonIP configurations for virtual network gateway.
locationcorestringResource location.
namecorestringResource name.
nat_rulescorejsonNatRules for virtual network gateway.
provisioning_statecorestringThe provisioning state of the virtual network gateway resource.
resource_groupcorestring
resource_guidcorestringThe resource GUID property of the virtual network gateway resource.
skucorejsonThe reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
subscription_idcorestring
subscription_namecorestring
tagscorehstore
typecorestringResource type.
v_net_extended_location_resource_idcorestringCustomer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.
virtual_network_gateway_policy_groupscorejsonThe reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.
vpn_client_configurationcorejsonThe reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
vpn_gateway_generationcorestringThe generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.
vpn_typecorestringThe type of this virtual network gateway.