VirtualNetworkGatewayConnectionListEntity 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 Azure.

Inheritance
azure.mgmt.network.v2018_02_01.models._models_py3.Resource
VirtualNetworkGatewayConnectionListEntity

Constructor

VirtualNetworkGatewayConnectionListEntity(*, virtual_network_gateway1: azure.mgmt.network.v2018_02_01.models._models_py3.VirtualNetworkConnectionGatewayReference, connection_type: typing.Union[str, _ForwardRef('VirtualNetworkGatewayConnectionType')], id: typing.Union[str, NoneType] = None, location: typing.Union[str, NoneType] = None, tags: typing.Union[typing.Dict[str, str], NoneType] = None, etag: typing.Union[str, NoneType] = None, authorization_key: typing.Union[str, NoneType] = None, virtual_network_gateway2: typing.Union[_ForwardRef('VirtualNetworkConnectionGatewayReference'), NoneType] = None, local_network_gateway2: typing.Union[_ForwardRef('VirtualNetworkConnectionGatewayReference'), NoneType] = None, routing_weight: typing.Union[int, NoneType] = None, shared_key: typing.Union[str, NoneType] = None, peer: typing.Union[_ForwardRef('SubResource'), NoneType] = None, enable_bgp: typing.Union[bool, NoneType] = None, use_policy_based_traffic_selectors: typing.Union[bool, NoneType] = None, ipsec_policies: typing.Union[typing.List[_ForwardRef('IpsecPolicy')], NoneType] = None, resource_guid: typing.Union[str, NoneType] = None, **kwargs)

Parameters

id
str

Resource ID.

location
str

Resource location.

tags
dict[str, str]

A set of tags. Resource tags.

etag
str

Gets a unique read-only string that changes whenever the resource is updated.

authorization_key
str

The authorizationKey.

virtual_network_gateway1
VirtualNetworkConnectionGatewayReference

Required. The reference to virtual network gateway resource.

virtual_network_gateway2
VirtualNetworkConnectionGatewayReference

The reference to virtual network gateway resource.

local_network_gateway2
VirtualNetworkConnectionGatewayReference

The reference to local network gateway resource.

connection_type
str or VirtualNetworkGatewayConnectionType

Required. Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. Possible values include: "IPsec", "Vnet2Vnet", "ExpressRoute", "VPNClient".

routing_weight
int

The routing weight.

shared_key
str

The IPSec shared key.

peer
SubResource

The reference to peerings resource.

enable_bgp
bool

EnableBgp flag.

use_policy_based_traffic_selectors
bool

Enable policy-based traffic selectors.

ipsec_policies
list[IpsecPolicy]

The IPSec Policies to be considered by this connection.

resource_guid
str

The resource GUID property of the VirtualNetworkGatewayConnection resource.

Variables

name
str

Resource name.

type
str

Resource type.

connection_status
str or VirtualNetworkGatewayConnectionStatus

Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'. Possible values include: "Unknown", "Connecting", "Connected", "NotConnected".

tunnel_connection_status
list[TunnelConnectionHealth]

Collection of all tunnels' connection health status.

egress_bytes_transferred
<xref:long>

The egress bytes transferred in this connection.

ingress_bytes_transferred
<xref:long>

The ingress bytes transferred in this connection.

provisioning_state
str

The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.