azure.mgmt.network.models.VirtualNetworkGatewayPropertiesFormat class

Constructor

VirtualNetworkGatewayPropertiesFormat(*args: Any, **kwargs: Any)

Variables

Name	Description
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.
virtual_network_gateway_migration_status	VirtualNetworkGatewayMigrationStatus The reference to the VirtualNetworkGatewayMigrationStatus which represents the status of migration.
active_active	bool ActiveActive flag.
enable_high_bandwidth_vpn_gateway	bool To enable Advanced Connectivity feature for VPN gateway.
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: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".
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".

active_active

ActiveActive flag.

active_active: bool | None

admin_state

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".

admin_state: str | _models.AdminState | None

allow_remote_vnet_traffic

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

allow_remote_vnet_traffic: bool | None

allow_virtual_wan_traffic

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

allow_virtual_wan_traffic: bool | None

auto_scale_configuration

Autoscale configuration for virutal network gateway.

auto_scale_configuration: _models.VirtualNetworkGatewayAutoScaleConfiguration | None

bgp_settings

Virtual network gateway's BGP speaker settings.

bgp_settings: _models.BgpSettings | None

custom_routes

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

custom_routes: _models.AddressSpace | None

disable_ip_sec_replay_protection

disableIPSecReplayProtection flag.

disable_ip_sec_replay_protection: bool | None

enable_bgp

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

enable_bgp: bool | None

enable_bgp_route_translation_for_nat

EnableBgpRouteTranslationForNat flag.

enable_bgp_route_translation_for_nat: bool | None

enable_dns_forwarding

Whether dns forwarding is enabled or not.

enable_dns_forwarding: bool | None

enable_high_bandwidth_vpn_gateway

To enable Advanced Connectivity feature for VPN gateway.

enable_high_bandwidth_vpn_gateway: bool | None

enable_private_ip_address

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

enable_private_ip_address: bool | None

gateway_default_site

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.

gateway_default_site: _models.SubResource | None

gateway_type

"Vpn", "ExpressRoute", and "LocalGateway".

gateway_type: str | _models.VirtualNetworkGatewayType | None

inbound_dns_forwarding_endpoint

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

inbound_dns_forwarding_endpoint: str | None

ip_configurations

IP configurations for virtual network gateway.

ip_configurations: list['_models.VirtualNetworkGatewayIPConfiguration'] | None

nat_rules

NatRules for virtual network gateway.

nat_rules: list['_models.VirtualNetworkGatewayNatRule'] | None

provisioning_state

"Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".

provisioning_state: str | _models.ProvisioningState | None

resiliency_model

Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed. Known values are: "SingleHomed" and "MultiHomed".

resiliency_model: str | _models.ResiliencyModel | None

resource_guid

The resource GUID property of the virtual network gateway resource.

resource_guid: str | None

sku

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

sku: _models.VirtualNetworkGatewaySku | None

v_net_extended_location_resource_id

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

v_net_extended_location_resource_id: str | None

virtual_network_gateway_migration_status

The reference to the VirtualNetworkGatewayMigrationStatus which represents the status of migration.

virtual_network_gateway_migration_status: _models.VirtualNetworkGatewayMigrationStatus | None

virtual_network_gateway_policy_groups

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

virtual_network_gateway_policy_groups: list['_models.VirtualNetworkGatewayPolicyGroup'] | None

vpn_client_configuration

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

vpn_client_configuration: _models.VpnClientConfiguration | None

vpn_gateway_generation

The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. Known values are: "None", "Generation1", and "Generation2".

vpn_gateway_generation: str | _models.VpnGatewayGeneration | None

vpn_type

"PolicyBased" and "RouteBased".

vpn_type: str | _models.VpnType | None