Share via


VirtualNetworkPeering Class

Definition

VirtualNetworkPeering.

public class VirtualNetworkPeering : Azure.Provisioning.Primitives.ProvisionableResource
type VirtualNetworkPeering = class
    inherit ProvisionableResource
Public Class VirtualNetworkPeering
Inherits ProvisionableResource
Inheritance

Constructors

Name Description
VirtualNetworkPeering(String, String)

Creates a new VirtualNetworkPeering.

Properties

Name Description
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.

AreCompleteVnetsPeered

Whether complete virtual network address space is peered.

BicepIdentifier

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

(Inherited from NamedProvisionableConstruct)
DependsOn

Declares explicit dependencies on other resources.

(Inherited from ProvisionableResource)
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.

Id

Resource ID.

IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from ProvisionableResource)
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

Gets or sets the Name.

Parent

Gets or sets a reference to the parent VirtualNetwork.

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.

RemoteVirtualNetworkAddressSpace

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

RemoteVirtualNetworkEncryption

The reference to the remote virtual network's encryption.

RemoteVirtualNetworkId

Gets or sets Id.

ResourceGuid

The resourceGuid property of the Virtual Network peering resource.

ResourceType

Gets the type of the resource.

(Inherited from ProvisionableResource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from ProvisionableResource)
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.

Methods

Name Description
AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Build(ProvisioningBuildOptions)

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

(Inherited from ProvisionableResource)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableResource)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], T, Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of VirtualNetworkPeering.

DefineResource<T>(String, String[], Boolean, Boolean, T) (Inherited from ProvisionableResource)
FromExisting(String, String)

Creates a reference to an existing VirtualNetworkPeering.

GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableResource)

Explicit Interface Implementations

Name Description
IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Extension Methods

Name Description
ToBicepExpression(IBicepValue)

Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy.

Applies to