VirtualNetworkGateway Class

Reference

A common class for general resource information.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance: azure.mgmt.network.models._models_py3.Resource

VirtualNetworkGateway

Constructor

VirtualNetworkGateway(*, id: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, extended_location: _models.ExtendedLocation | None = None, identity: _models.ManagedServiceIdentity | None = None, auto_scale_configuration: _models.VirtualNetworkGatewayAutoScaleConfiguration | None = None, ip_configurations: List[_models.VirtualNetworkGatewayIPConfiguration] | None = None, gateway_type: str | _models.VirtualNetworkGatewayType | None = None, vpn_type: str | _models.VpnType | None = None, vpn_gateway_generation: str | _models.VpnGatewayGeneration | None = None, enable_bgp: bool | None = None, enable_private_ip_address: bool | None = None, active: bool | None = None, disable_ip_sec_replay_protection: bool | None = None, gateway_default_site: _models.SubResource | None = None, sku: _models.VirtualNetworkGatewaySku | None = None, vpn_client_configuration: _models.VpnClientConfiguration | None = None, virtual_network_gateway_policy_groups: List[_models.VirtualNetworkGatewayPolicyGroup] | None = None, bgp_settings: _models.BgpSettings | None = None, custom_routes: _models.AddressSpace | None = None, enable_dns_forwarding: bool | None = None, v_net_extended_location_resource_id: str | None = None, nat_rules: List[_models.VirtualNetworkGatewayNatRule] | None = None, enable_bgp_route_translation_for_nat: bool | None = None, allow_virtual_wan_traffic: bool | None = None, allow_remote_vnet_traffic: bool | None = None, admin_state: str | _models.AdminState | None = None, resiliency_model: str | _models.ResiliencyModel | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
id	str Resource ID.
location	str Resource location.
tags	dict[str, str] Resource tags.
extended_location	ExtendedLocation The extended location of type local virtual network gateway.
identity	ManagedServiceIdentity The identity of the virtual network gateway, if configured.
auto_scale_configuration	VirtualNetworkGatewayAutoScaleConfiguration Autoscale configuration for virutal network gateway.
ip_configurations	list[VirtualNetworkGatewayIPConfiguration] IP configurations for virtual network gateway.
gateway_type	str or VirtualNetworkGatewayType The type of this virtual network gateway. Known values are: "Vpn", "ExpressRoute", and "LocalGateway".
vpn_type	str or VpnType The type of this virtual network gateway. Known values are: "PolicyBased" and "RouteBased".
vpn_gateway_generation	str or VpnGatewayGeneration The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. Known values are: "None", "Generation1", and "Generation2".
enable_bgp	bool Whether BGP is enabled for this virtual network gateway or not.
enable_private_ip_address	bool Whether private IP needs to be enabled on this gateway for connections or not.
active	bool ActiveActive flag.
disable_ip_sec_replay_protection	bool disableIPSecReplayProtection flag.
gateway_default_site	SubResource 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.
sku	VirtualNetworkGatewaySku The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
vpn_client_configuration	VpnClientConfiguration The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
virtual_network_gateway_policy_groups	list[VirtualNetworkGatewayPolicyGroup] The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.
bgp_settings	BgpSettings Virtual network gateway's BGP speaker settings.
custom_routes	AddressSpace The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
enable_dns_forwarding	bool Whether dns forwarding is enabled or not.
v_net_extended_location_resource_id	str Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.
nat_rules	list[VirtualNetworkGatewayNatRule] NatRules for virtual network gateway.
enable_bgp_route_translation_for_nat	bool EnableBgpRouteTranslationForNat flag.
allow_virtual_wan_traffic	bool Configures this gateway to accept traffic from remote Virtual WAN networks.
allow_remote_vnet_traffic	bool Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN.
admin_state	str or AdminState Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet. Known values are: "Enabled" and "Disabled".
resiliency_model	str or ResiliencyModel Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed. Known values are: "SingleHomed" and "MultiHomed".

Variables

Name	Description
id	str Resource ID.
name	str Resource name.
type	str Resource type.
location	str Resource location.
tags	dict[str, str] Resource tags.
extended_location	ExtendedLocation The extended location of type local virtual network gateway.
etag	str A unique read-only string that changes whenever the resource is updated.
identity	ManagedServiceIdentity The identity of the virtual network gateway, if configured.
auto_scale_configuration	VirtualNetworkGatewayAutoScaleConfiguration Autoscale configuration for virutal network gateway.
ip_configurations	list[VirtualNetworkGatewayIPConfiguration] IP configurations for virtual network gateway.
gateway_type	str or VirtualNetworkGatewayType The type of this virtual network gateway. Known values are: "Vpn", "ExpressRoute", and "LocalGateway".
vpn_type	str or VpnType The type of this virtual network gateway. Known values are: "PolicyBased" and "RouteBased".
vpn_gateway_generation	str or VpnGatewayGeneration The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. Known values are: "None", "Generation1", and "Generation2".
enable_bgp	bool Whether BGP is enabled for this virtual network gateway or not.
enable_private_ip_address	bool Whether private IP needs to be enabled on this gateway for connections or not.
active	bool ActiveActive flag.
disable_ip_sec_replay_protection	bool disableIPSecReplayProtection flag.
gateway_default_site	SubResource 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.
sku	VirtualNetworkGatewaySku The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
vpn_client_configuration	VpnClientConfiguration The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
virtual_network_gateway_policy_groups	list[VirtualNetworkGatewayPolicyGroup] The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.
bgp_settings	BgpSettings Virtual network gateway's BGP speaker settings.
custom_routes	AddressSpace The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
resource_guid	str The resource GUID property of the virtual network gateway resource.
provisioning_state	str or ProvisioningState The provisioning state of the virtual network gateway resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".
enable_dns_forwarding	bool Whether dns forwarding is enabled or not.
inbound_dns_forwarding_endpoint	str The IP address allocated by the gateway to which dns requests can be sent.
v_net_extended_location_resource_id	str Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.
nat_rules	list[VirtualNetworkGatewayNatRule] NatRules for virtual network gateway.
enable_bgp_route_translation_for_nat	bool EnableBgpRouteTranslationForNat flag.
allow_virtual_wan_traffic	bool Configures this gateway to accept traffic from remote Virtual WAN networks.
allow_remote_vnet_traffic	bool Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN.
admin_state	str or AdminState Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet. Known values are: "Enabled" and "Disabled".
resiliency_model	str or ResiliencyModel Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed. Known values are: "SingleHomed" and "MultiHomed".

Share via

VirtualNetworkGateway Class

Constructor

Keyword-Only Parameters

Variables

Additional resources