Share via

VirtualNetworkPeering interface

  • Reference
Package:
@azure/arm-network-profile-2020-09-01-hybrid

Peerings in a virtual network resource.

Extends
SubResource

Properties

allowForwardedTraffic

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

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

Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space.
etag

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

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

The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.
provisioningState

The provisioning state of the resource.
remoteAddressSpace

The reference of the remote virtual network address space.
remoteVirtualNetwork

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).
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 remote virtual network will be allowed/disallowed.

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 linked virtual network space would be able to access all the VMs in local Virtual network space.

allowVirtualNetworkAccess?: boolean

Property Value

boolean

etag

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

etag?: string

Property Value

string

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

peeringState

The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.

peeringState?: string

Property Value

string

provisioningState

The provisioning state of the resource.

provisioningState?: string

Property Value

string

remoteAddressSpace

The reference of the remote virtual network address space.

remoteAddressSpace?: AddressSpace

Property Value

AddressSpace

remoteVirtualNetwork

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

remoteVirtualNetwork?: SubResource

Property Value

SubResource

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