VirtualNetworkPeering Class

Reference

Peerings in a virtual network resource.

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

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

VirtualNetworkPeering

Constructor

VirtualNetworkPeering(*, id: str | None = None, name: str | None = None, type: str | None = None, allow_virtual_network_access: bool | None = None, allow_forwarded_traffic: bool | None = None, allow_gateway_transit: bool | None = None, use_remote_gateways: bool | None = None, remote_virtual_network: _models.SubResource | None = None, local_address_space: _models.AddressSpace | None = None, local_virtual_network_address_space: _models.AddressSpace | None = None, remote_address_space: _models.AddressSpace | None = None, remote_virtual_network_address_space: _models.AddressSpace | None = None, remote_bgp_communities: _models.VirtualNetworkBgpCommunities | None = None, peering_state: str | _models.VirtualNetworkPeeringState | None = None, peering_sync_level: str | _models.VirtualNetworkPeeringLevel | None = None, do_not_verify_remote_gateways: bool | None = None, peer_complete_vnets: bool | None = None, enable_only_i_pv6_peering: bool | None = None, local_subnet_names: List[str] | None = None, remote_subnet_names: List[str] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
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.
type	str Resource type.
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 to 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).
local_address_space	AddressSpace The local address space of the local virtual network that is peered.
local_virtual_network_address_space	AddressSpace The current local address space of the local virtual network that is peered.
remote_address_space	AddressSpace The reference to the address space peered with the remote virtual network.
remote_virtual_network_address_space	AddressSpace The reference to the current address space of the remote virtual network.
remote_bgp_communities	VirtualNetworkBgpCommunities The reference to the remote virtual network's Bgp Communities.
peering_state	str or VirtualNetworkPeeringState The status of the virtual network peering. Known values are: "Initiated", "Connected", and "Disconnected".
peering_sync_level	str or VirtualNetworkPeeringLevel The peering sync status of the virtual network peering. Known values are: "FullyInSync", "RemoteNotInSync", "LocalNotInSync", and "LocalAndRemoteNotInSync".
do_not_verify_remote_gateways	bool If we need to verify the provisioning state of the remote gateway.
peer_complete_vnets	bool Whether complete virtual network address space is peered.
enable_only_i_pv6_peering	bool Whether only Ipv6 address space is peered for subnet peering.
local_subnet_names	list[str] List of local subnet names that are subnet peered with remote virtual network.
remote_subnet_names	list[str] List of remote subnet names from remote virtual network that are subnet peered.

Variables

Name	Description
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.
type	str Resource type.
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 to 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).
local_address_space	AddressSpace The local address space of the local virtual network that is peered.
local_virtual_network_address_space	AddressSpace The current local address space of the local virtual network that is peered.
remote_address_space	AddressSpace The reference to the address space peered with the remote virtual network.
remote_virtual_network_address_space	AddressSpace The reference to the current address space of the remote virtual network.
remote_bgp_communities	VirtualNetworkBgpCommunities The reference to the remote virtual network's Bgp Communities.
remote_virtual_network_encryption	VirtualNetworkEncryption The reference to the remote virtual network's encryption.
peering_state	str or VirtualNetworkPeeringState The status of the virtual network peering. Known values are: "Initiated", "Connected", and "Disconnected".
peering_sync_level	str or VirtualNetworkPeeringLevel The peering sync status of the virtual network peering. Known values are: "FullyInSync", "RemoteNotInSync", "LocalNotInSync", and "LocalAndRemoteNotInSync".
provisioning_state	str or ProvisioningState The provisioning state of the virtual network peering resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".
do_not_verify_remote_gateways	bool If we need to verify the provisioning state of the remote gateway.
resource_guid	str The resourceGuid property of the Virtual Network peering resource.
peer_complete_vnets	bool Whether complete virtual network address space is peered.
enable_only_i_pv6_peering	bool Whether only Ipv6 address space is peered for subnet peering.
local_subnet_names	list[str] List of local subnet names that are subnet peered with remote virtual network.
remote_subnet_names	list[str] List of remote subnet names from remote virtual network that are subnet peered.

Share via

VirtualNetworkPeering Class

Constructor

Keyword-Only Parameters

Variables

Additional resources