VirtualNetworkGatewayConnection Class

A common class for general resource information.

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

All required parameters must be populated in order to send to server.

Constructor

VirtualNetworkGatewayConnection(*, virtual_network_gateway1: _models.VirtualNetworkGateway, connection_type: str | _models.VirtualNetworkGatewayConnectionType, id: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, authorization_key: str | None = None, virtual_network_gateway2: _models.VirtualNetworkGateway | None = None, local_network_gateway2: _models.LocalNetworkGateway | None = None, ingress_nat_rules: List[_models.SubResource] | None = None, egress_nat_rules: List[_models.SubResource] | None = None, connection_protocol: str | _models.VirtualNetworkGatewayConnectionProtocol | None = None, routing_weight: int | None = None, dpd_timeout_seconds: int | None = None, connection_mode: str | _models.VirtualNetworkGatewayConnectionMode | None = None, tunnel_properties: List[_models.VirtualNetworkGatewayConnectionTunnelProperties] | None = None, shared_key: str | None = None, peer: _models.SubResource | None = None, enable_bgp: bool | None = None, gateway_custom_bgp_ip_addresses: List[_models.GatewayCustomBgpIpAddressIpConfiguration] | None = None, use_local_azure_ip_address: bool | None = None, use_policy_based_traffic_selectors: bool | None = None, ipsec_policies: List[_models.IpsecPolicy] | None = None, traffic_selector_policies: List[_models.TrafficSelectorPolicy] | None = None, express_route_gateway_bypass: bool | None = None, enable_private_link_fast_path: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
id	str Resource ID. Default value: None
location	str Resource location. Default value: None
tags	dict[str, str] Resource tags. Default value: None
authorization_key	str The authorizationKey. Default value: None
virtual_network_gateway1	VirtualNetworkGateway The reference to virtual network gateway resource. Required.
virtual_network_gateway2	VirtualNetworkGateway The reference to virtual network gateway resource. Default value: None
local_network_gateway2	LocalNetworkGateway The reference to local network gateway resource. Default value: None
ingress_nat_rules	list[SubResource] List of ingress NatRules. Default value: None
egress_nat_rules	list[SubResource] List of egress NatRules. Default value: None
connection_type	str or VirtualNetworkGatewayConnectionType Gateway connection type. Required. Known values are: "IPsec", "Vnet2Vnet", "ExpressRoute", and "VPNClient".
connection_protocol	str or VirtualNetworkGatewayConnectionProtocol Connection protocol used for this connection. Known values are: "IKEv2" and "IKEv1". Default value: None
routing_weight	int The routing weight. Default value: None
dpd_timeout_seconds	int The dead peer detection timeout of this connection in seconds. Default value: None
connection_mode	str or VirtualNetworkGatewayConnectionMode The connection mode for this connection. Known values are: "Default", "ResponderOnly", and "InitiatorOnly". Default value: None
tunnel_properties	list[VirtualNetworkGatewayConnectionTunnelProperties] Tunnel properties for virtual network gateway connection. Default value: None
shared_key	str The IPSec shared key. Default value: None
peer	SubResource The reference to peerings resource. Default value: None
enable_bgp	bool EnableBgp flag. Default value: None
gateway_custom_bgp_ip_addresses	list[GatewayCustomBgpIpAddressIpConfiguration] GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection. Default value: None
use_local_azure_ip_address	bool Use private local Azure IP for the connection. Default value: None
use_policy_based_traffic_selectors	bool Enable policy-based traffic selectors. Default value: None
ipsec_policies	list[IpsecPolicy] The IPSec Policies to be considered by this connection. Default value: None
traffic_selector_policies	list[TrafficSelectorPolicy] The Traffic Selector Policies to be considered by this connection. Default value: None
express_route_gateway_bypass	bool Bypass ExpressRoute Gateway for data forwarding. Default value: None
enable_private_link_fast_path	bool Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled. Default value: None

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.
etag	str A unique read-only string that changes whenever the resource is updated.
authorization_key	str The authorizationKey.
virtual_network_gateway1	VirtualNetworkGateway The reference to virtual network gateway resource. Required.
virtual_network_gateway2	VirtualNetworkGateway The reference to virtual network gateway resource.
local_network_gateway2	LocalNetworkGateway The reference to local network gateway resource.
ingress_nat_rules	list[SubResource] List of ingress NatRules.
egress_nat_rules	list[SubResource] List of egress NatRules.
connection_type	str or VirtualNetworkGatewayConnectionType Gateway connection type. Required. Known values are: "IPsec", "Vnet2Vnet", "ExpressRoute", and "VPNClient".
connection_protocol	str or VirtualNetworkGatewayConnectionProtocol Connection protocol used for this connection. Known values are: "IKEv2" and "IKEv1".
routing_weight	int The routing weight.
dpd_timeout_seconds	int The dead peer detection timeout of this connection in seconds.
connection_mode	str or VirtualNetworkGatewayConnectionMode The connection mode for this connection. Known values are: "Default", "ResponderOnly", and "InitiatorOnly".
tunnel_properties	list[VirtualNetworkGatewayConnectionTunnelProperties] Tunnel properties for virtual network gateway connection.
shared_key	str The IPSec shared key.
connection_status	str or VirtualNetworkGatewayConnectionStatus Virtual Network Gateway connection status. Known values are: "Unknown", "Connecting", "Connected", and "NotConnected".
tunnel_connection_status	list[TunnelConnectionHealth] Collection of all tunnels' connection health status.
egress_bytes_transferred	int The egress bytes transferred in this connection.
ingress_bytes_transferred	int The ingress bytes transferred in this connection.
peer	SubResource The reference to peerings resource.
enable_bgp	bool EnableBgp flag.
gateway_custom_bgp_ip_addresses	list[GatewayCustomBgpIpAddressIpConfiguration] GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.
use_local_azure_ip_address	bool Use private local Azure IP for the connection.
use_policy_based_traffic_selectors	bool Enable policy-based traffic selectors.
ipsec_policies	list[IpsecPolicy] The IPSec Policies to be considered by this connection.
traffic_selector_policies	list[TrafficSelectorPolicy] The Traffic Selector Policies to be considered by this connection.
resource_guid	str The resource GUID property of the virtual network gateway connection resource.
provisioning_state	str or ProvisioningState The provisioning state of the virtual network gateway connection resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".
express_route_gateway_bypass	bool Bypass ExpressRoute Gateway for data forwarding.
enable_private_link_fast_path	bool Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.

Feedback

Var den här sidan till hjälp?