VirtualNetworkPeering Class

Peerings in a virtual network resource.

Inheritance

azure.mgmt.network.v2019_06_01.models._models_py3.SubResource

VirtualNetworkPeering

Constructor

VirtualNetworkPeering(*, id: typing.Union[str, NoneType] = None, name: typing.Union[str, NoneType] = None, etag: typing.Union[str, NoneType] = None, allow_virtual_network_access: typing.Union[bool, NoneType] = None, allow_forwarded_traffic: typing.Union[bool, NoneType] = None, allow_gateway_transit: typing.Union[bool, NoneType] = None, use_remote_gateways: typing.Union[bool, NoneType] = None, remote_virtual_network: typing.Union[_ForwardRef('SubResource'), NoneType] = None, remote_address_space: typing.Union[_ForwardRef('AddressSpace'), NoneType] = None, peering_state: typing.Union[str, _ForwardRef('VirtualNetworkPeeringState'), NoneType] = None, provisioning_state: typing.Union[str, NoneType] = None, **kwargs)

Parameters

id

str

Resource ID.

name

str

The name of the resource that is unique within a resource group. This name can be used to access the resource.

etag

str

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

allow_virtual_network_access

bool

Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

allow_forwarded_traffic

bool

Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.

allow_gateway_transit

bool

If gateway links can be used in remote virtual networking to link to this virtual network.

use_remote_gateways

bool

If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.

remote_virtual_network

SubResource

The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create- peering).

remote_address_space

AddressSpace

The reference of the remote virtual network address space.

peering_state

str or VirtualNetworkPeeringState

The status of the virtual network peering. Possible values include: "Initiated", "Connected", "Disconnected".

provisioning_state

str

The provisioning state of the resource.