VirtualNetworkPeeringPropertiesFormat interface

Properties of the virtual network peering.

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.

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.

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.

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

resourceGuid

The resourceGuid property of the Virtual Network peering resource.

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.

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

localAddressSpace

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

localAddressSpace?: AddressSpace

Property Value

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

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.

provisioningState?: string

Property Value

string

remoteAddressSpace

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

remoteAddressSpace?: AddressSpace

Property Value

remoteBgpCommunities

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

remoteBgpCommunities?: VirtualNetworkBgpCommunities

Property Value

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

remoteVirtualNetworkAddressSpace

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

remoteVirtualNetworkAddressSpace?: AddressSpace

Property Value

remoteVirtualNetworkEncryption

The reference to the remote virtual network's encryption

remoteVirtualNetworkEncryption?: VirtualNetworkEncryption

Property Value

resourceGuid

The resourceGuid property of the Virtual Network peering resource.

resourceGuid?: 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