VirtualNetworkPeering interface

Package:

@azure/arm-network

Peerings in a virtual network resource.

Extends

SubResource

Properties

allowForwardedTraffic	Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
allowGatewayTransit	If gateway links can be used in remote virtual networking to link to this virtual network.
allowVirtualNetworkAccess	Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
doNotVerifyRemoteGateways	If we need to verify the provisioning state of the remote gateway.
enableOnlyIPv6Peering	Whether only Ipv6 address space is peered for subnet peering.
etag	A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.
localAddressSpace	The local address space of the local virtual network that is peered.
localSubnetNames	List of local subnet names that are subnet peered with remote virtual network.
localVirtualNetworkAddressSpace	The current local address space of the local virtual network that is peered.
name	The name of the resource that is unique within a resource group. This name can be used to access the resource.
peerCompleteVnets	Whether complete virtual network address space is peered.
peeringState	The status of the virtual network peering.
peeringSyncLevel	The peering sync status of the virtual network peering.
provisioningState	The provisioning state of the virtual network peering resource. NOTE: This property will not be serialized. It can only be populated by the server.
remoteAddressSpace	The reference to the address space peered with the remote virtual network.
remoteBgpCommunities	The reference to the remote virtual network's Bgp Communities.
remoteSubnetNames	List of remote subnet names from remote virtual network that are subnet peered.
remoteVirtualNetwork	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).
remoteVirtualNetworkAddressSpace	The reference to the current address space of the remote virtual network.
remoteVirtualNetworkEncryption	The reference to the remote virtual network's encryption NOTE: This property will not be serialized. It can only be populated by the server.
resourceGuid	The resourceGuid property of the Virtual Network peering resource. NOTE: This property will not be serialized. It can only be populated by the server.
type	Resource type.
useRemoteGateways	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.

Inherited Properties

id	Resource ID.

Property Details

allowForwardedTraffic

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

allowForwardedTraffic?: boolean

Property Value

boolean

allowGatewayTransit

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

allowGatewayTransit?: boolean

Property Value

boolean

allowVirtualNetworkAccess

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

allowVirtualNetworkAccess?: boolean

Property Value

boolean

doNotVerifyRemoteGateways

If we need to verify the provisioning state of the remote gateway.

doNotVerifyRemoteGateways?: boolean

Property Value

boolean

enableOnlyIPv6Peering

Whether only Ipv6 address space is peered for subnet peering.

enableOnlyIPv6Peering?: boolean

Property Value

boolean

etag

A unique read-only string that changes whenever the resource is updated. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

localAddressSpace

The local address space of the local virtual network that is peered.

localAddressSpace?: AddressSpace

Property Value

AddressSpace

localSubnetNames

List of local subnet names that are subnet peered with remote virtual network.

localSubnetNames?: string[]

Property Value

string[]

localVirtualNetworkAddressSpace

The current local address space of the local virtual network that is peered.

localVirtualNetworkAddressSpace?: AddressSpace

Property Value

AddressSpace

name

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

name?: string

Property Value

string

peerCompleteVnets

Whether complete virtual network address space is peered.

peerCompleteVnets?: boolean

Property Value

boolean

peeringState

The status of the virtual network peering.

peeringState?: string

Property Value

string

peeringSyncLevel

The peering sync status of the virtual network peering.

peeringSyncLevel?: string

Property Value

string

provisioningState

The provisioning state of the virtual network peering resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

remoteAddressSpace

The reference to the address space peered with the remote virtual network.

remoteAddressSpace?: AddressSpace

Property Value

AddressSpace

remoteBgpCommunities

The reference to the remote virtual network's Bgp Communities.

remoteBgpCommunities?: VirtualNetworkBgpCommunities

Property Value

VirtualNetworkBgpCommunities

remoteSubnetNames

List of remote subnet names from remote virtual network that are subnet peered.

remoteSubnetNames?: string[]

Property Value

string[]

remoteVirtualNetwork

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

remoteVirtualNetwork?: SubResource

Property Value

SubResource

remoteVirtualNetworkAddressSpace

The reference to the current address space of the remote virtual network.

remoteVirtualNetworkAddressSpace?: AddressSpace

Property Value

AddressSpace

remoteVirtualNetworkEncryption

The reference to the remote virtual network's encryption NOTE: This property will not be serialized. It can only be populated by the server.

remoteVirtualNetworkEncryption?: VirtualNetworkEncryption

Property Value

VirtualNetworkEncryption

resourceGuid

The resourceGuid property of the Virtual Network peering resource. NOTE: This property will not be serialized. It can only be populated by the server.

resourceGuid?: string

Property Value

string

type

Resource type.

type?: string

Property Value

string

useRemoteGateways

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.

useRemoteGateways?: boolean

Property Value

boolean

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From SubResource.id