VirtualNetworkPeering Class

Definition

Peerings in a virtual network resource.

[Microsoft.Rest.Serialization.JsonTransformation]
public class VirtualNetworkPeering : Microsoft.Azure.Management.Network.Models.SubResource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type VirtualNetworkPeering = class
    inherit SubResource
Public Class VirtualNetworkPeering
Inherits SubResource
Inheritance
System.Object
VirtualNetworkPeering
Attributes

Constructors

VirtualNetworkPeering()

Initializes a new instance of the VirtualNetworkPeering class.

VirtualNetworkPeering(String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, SubResource, AddressSpace, AddressSpace, VirtualNetworkBgpCommunities, String, String, String, Nullable<Boolean>, String, String, String, String)

Initializes a new instance of the VirtualNetworkPeering class.

Properties

AllowForwardedTraffic

Gets or sets whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.

AllowGatewayTransit

Gets or sets if gateway links can be used in remote virtual networking to link to this virtual network.

AllowVirtualNetworkAccess

Gets or sets whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

DoNotVerifyRemoteGateways

Gets or sets if we need to verify the provisioning state of the remote gateway.

Etag

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

Id

Gets or sets resource ID.

(Inherited from SubResource)
Name

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

PeeringState

Gets or sets the status of the virtual network peering. Possible values include: 'Initiated', 'Connected', 'Disconnected'

PeeringSyncLevel

Gets or sets the peering sync status of the virtual network peering. Possible values include: 'FullyInSync', 'RemoteNotInSync', 'LocalNotInSync', 'LocalAndRemoteNotInSync'

ProvisioningState

Gets the provisioning state of the virtual network peering resource. Possible values include: 'Succeeded', 'Updating', 'Deleting', 'Failed'

RemoteAddressSpace

Gets or sets the reference to the address space peered with the remote virtual network.

RemoteBgpCommunities

Gets or sets the reference to the remote virtual network's Bgp Communities.

RemoteVirtualNetwork

Gets or sets 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

Gets or sets the reference to the current address space of the remote virtual network.

ResourceGuid

Gets the resourceGuid property of the Virtual Network peering resource.

Type

Gets or sets resource type.

UseRemoteGateways

Gets or sets 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.

Methods

Validate()

Validate the object.

Applies to