VirtualNetworkPeeringInner Class

Package:

com.azure.resourcemanager.network.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-network:2.45.0

• java.lang.Object
• • com.azure.core.management.SubResource
  • • com.azure.resourcemanager.network.fluent.models.VirtualNetworkPeeringInner

public final class VirtualNetworkPeeringInner
extends SubResource

Peerings in a virtual network resource.

Constructor Summary

Constructor	Description
VirtualNetworkPeeringInner()	Creates an instance of VirtualNetworkPeeringInner class.

Method Summary

Modifier and Type	Method and Description
Boolean	allowForwardedTraffic() Get the allowForwardedTraffic property: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
Boolean	allowGatewayTransit() Get the allowGatewayTransit property: If gateway links can be used in remote virtual networking to link to this virtual network.
Boolean	allowVirtualNetworkAccess() Get the allowVirtualNetworkAccess property: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
Boolean	doNotVerifyRemoteGateways() Get the doNotVerifyRemoteGateways property: If we need to verify the provisioning state of the remote gateway.
Boolean	enableOnlyIPv6Peering() Get the enableOnlyIPv6Peering property: Whether only Ipv6 address space is peered for subnet peering.
String	etag() Get the etag property: A unique read-only string that changes whenever the resource is updated.
static VirtualNetworkPeeringInner	fromJson(JsonReader jsonReader) Reads an instance of VirtualNetworkPeeringInner from the JsonReader.
AddressSpace	localAddressSpace() Get the localAddressSpace property: The local address space of the local virtual network that is peered.
List<String>	localSubnetNames() Get the localSubnetNames property: List of local subnet names that are subnet peered with remote virtual network.
AddressSpace	localVirtualNetworkAddressSpace() Get the localVirtualNetworkAddressSpace property: The current local address space of the local virtual network that is peered.
String	name() Get the name property: The name of the resource that is unique within a resource group.
Boolean	peerCompleteVnets() Get the peerCompleteVnets property: Whether complete virtual network address space is peered.
VirtualNetworkPeeringState	peeringState() Get the peeringState property: The status of the virtual network peering.
VirtualNetworkPeeringLevel	peeringSyncLevel() Get the peeringSyncLevel property: The peering sync status of the virtual network peering.
ProvisioningState	provisioningState() Get the provisioningState property: The provisioning state of the virtual network peering resource.
AddressSpace	remoteAddressSpace() Get the remoteAddressSpace property: The reference to the address space peered with the remote virtual network.
VirtualNetworkBgpCommunities	remoteBgpCommunities() Get the remoteBgpCommunities property: The reference to the remote virtual network's Bgp Communities.
List<String>	remoteSubnetNames() Get the remoteSubnetNames property: List of remote subnet names from remote virtual network that are subnet peered.
SubResource	remoteVirtualNetwork() Get the remoteVirtualNetwork property: The reference to the remote virtual network.
AddressSpace	remoteVirtualNetworkAddressSpace() Get the remoteVirtualNetworkAddressSpace property: The reference to the current address space of the remote virtual network.
VirtualNetworkEncryption	remoteVirtualNetworkEncryption() Get the remoteVirtualNetworkEncryption property: The reference to the remote virtual network's encryption.
String	resourceGuid() Get the resourceGuid property: The resourceGuid property of the Virtual Network peering resource.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: Resource type.
Boolean	useRemoteGateways() Get the useRemoteGateways property: If remote gateways can be used on this virtual network.
void	validate() Validates the instance.
VirtualNetworkPeeringInner	withAllowForwardedTraffic(Boolean allowForwardedTraffic) Set the allowForwardedTraffic property: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
VirtualNetworkPeeringInner	withAllowGatewayTransit(Boolean allowGatewayTransit) Set the allowGatewayTransit property: If gateway links can be used in remote virtual networking to link to this virtual network.
VirtualNetworkPeeringInner	withAllowVirtualNetworkAccess(Boolean allowVirtualNetworkAccess) Set the allowVirtualNetworkAccess property: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
VirtualNetworkPeeringInner	withDoNotVerifyRemoteGateways(Boolean doNotVerifyRemoteGateways) Set the doNotVerifyRemoteGateways property: If we need to verify the provisioning state of the remote gateway.
VirtualNetworkPeeringInner	withEnableOnlyIPv6Peering(Boolean enableOnlyIPv6Peering) Set the enableOnlyIPv6Peering property: Whether only Ipv6 address space is peered for subnet peering.
VirtualNetworkPeeringInner	withId(String id)
VirtualNetworkPeeringInner	withLocalAddressSpace(AddressSpace localAddressSpace) Set the localAddressSpace property: The local address space of the local virtual network that is peered.
VirtualNetworkPeeringInner	withLocalSubnetNames(List<String> localSubnetNames) Set the localSubnetNames property: List of local subnet names that are subnet peered with remote virtual network.
VirtualNetworkPeeringInner	withLocalVirtualNetworkAddressSpace(AddressSpace localVirtualNetworkAddressSpace) Set the localVirtualNetworkAddressSpace property: The current local address space of the local virtual network that is peered.
VirtualNetworkPeeringInner	withName(String name) Set the name property: The name of the resource that is unique within a resource group.
VirtualNetworkPeeringInner	withPeerCompleteVnets(Boolean peerCompleteVnets) Set the peerCompleteVnets property: Whether complete virtual network address space is peered.
VirtualNetworkPeeringInner	withPeeringState(VirtualNetworkPeeringState peeringState) Set the peeringState property: The status of the virtual network peering.
VirtualNetworkPeeringInner	withPeeringSyncLevel(VirtualNetworkPeeringLevel peeringSyncLevel) Set the peeringSyncLevel property: The peering sync status of the virtual network peering.
VirtualNetworkPeeringInner	withRemoteAddressSpace(AddressSpace remoteAddressSpace) Set the remoteAddressSpace property: The reference to the address space peered with the remote virtual network.
VirtualNetworkPeeringInner	withRemoteBgpCommunities(VirtualNetworkBgpCommunities remoteBgpCommunities) Set the remoteBgpCommunities property: The reference to the remote virtual network's Bgp Communities.
VirtualNetworkPeeringInner	withRemoteSubnetNames(List<String> remoteSubnetNames) Set the remoteSubnetNames property: List of remote subnet names from remote virtual network that are subnet peered.
VirtualNetworkPeeringInner	withRemoteVirtualNetwork(SubResource remoteVirtualNetwork) Set the remoteVirtualNetwork property: The reference to the remote virtual network.
VirtualNetworkPeeringInner	withRemoteVirtualNetworkAddressSpace(AddressSpace remoteVirtualNetworkAddressSpace) Set the remoteVirtualNetworkAddressSpace property: The reference to the current address space of the remote virtual network.
VirtualNetworkPeeringInner	withType(String type) Set the type property: Resource type.
VirtualNetworkPeeringInner	withUseRemoteGateways(Boolean useRemoteGateways) Set the useRemoteGateways property: If remote gateways can be used on this virtual network.

Methods inherited from SubResource

fromJson id toJson withId

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VirtualNetworkPeeringInner

public VirtualNetworkPeeringInner()

Creates an instance of VirtualNetworkPeeringInner class.

Method Details

allowForwardedTraffic

public Boolean allowForwardedTraffic()

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

Returns:

the allowForwardedTraffic value.

allowGatewayTransit

public Boolean allowGatewayTransit()

Get the allowGatewayTransit property: If gateway links can be used in remote virtual networking to link to this virtual network.

Returns:

the allowGatewayTransit value.

allowVirtualNetworkAccess

public Boolean allowVirtualNetworkAccess()

Get the allowVirtualNetworkAccess property: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

Returns:

the allowVirtualNetworkAccess value.

doNotVerifyRemoteGateways

public Boolean doNotVerifyRemoteGateways()

Get the doNotVerifyRemoteGateways property: If we need to verify the provisioning state of the remote gateway.

Returns:

the doNotVerifyRemoteGateways value.

enableOnlyIPv6Peering

public Boolean enableOnlyIPv6Peering()

Get the enableOnlyIPv6Peering property: Whether only Ipv6 address space is peered for subnet peering.

Returns:

the enableOnlyIPv6Peering value.

etag

public String etag()

Get the etag property: A unique read-only string that changes whenever the resource is updated.

Returns:

the etag value.

fromJson

public static VirtualNetworkPeeringInner fromJson(JsonReader jsonReader)

Reads an instance of VirtualNetworkPeeringInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of VirtualNetworkPeeringInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the VirtualNetworkPeeringInner.

localAddressSpace

public AddressSpace localAddressSpace()

Get the localAddressSpace property: The local address space of the local virtual network that is peered.

Returns:

the localAddressSpace value.

localSubnetNames

public List localSubnetNames()

Get the localSubnetNames property: List of local subnet names that are subnet peered with remote virtual network.

Returns:

the localSubnetNames value.

localVirtualNetworkAddressSpace

public AddressSpace localVirtualNetworkAddressSpace()

Get the localVirtualNetworkAddressSpace property: The current local address space of the local virtual network that is peered.

Returns:

the localVirtualNetworkAddressSpace value.

name

public String name()

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

Returns:

the name value.

peerCompleteVnets

public Boolean peerCompleteVnets()

Get the peerCompleteVnets property: Whether complete virtual network address space is peered.

Returns:

the peerCompleteVnets value.

peeringState

public VirtualNetworkPeeringState peeringState()

Get the peeringState property: The status of the virtual network peering.

Returns:

the peeringState value.

peeringSyncLevel

public VirtualNetworkPeeringLevel peeringSyncLevel()

Get the peeringSyncLevel property: The peering sync status of the virtual network peering.

Returns:

the peeringSyncLevel value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the virtual network peering resource.

Returns:

the provisioningState value.

remoteAddressSpace

public AddressSpace remoteAddressSpace()

Get the remoteAddressSpace property: The reference to the address space peered with the remote virtual network.

Returns:

the remoteAddressSpace value.

remoteBgpCommunities

public VirtualNetworkBgpCommunities remoteBgpCommunities()

Get the remoteBgpCommunities property: The reference to the remote virtual network's Bgp Communities.

Returns:

the remoteBgpCommunities value.

remoteSubnetNames

public List remoteSubnetNames()

Get the remoteSubnetNames property: List of remote subnet names from remote virtual network that are subnet peered.

Returns:

the remoteSubnetNames value.

remoteVirtualNetwork

public SubResource remoteVirtualNetwork()

Get the remoteVirtualNetwork property: 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).

Returns:

the remoteVirtualNetwork value.

remoteVirtualNetworkAddressSpace

public AddressSpace remoteVirtualNetworkAddressSpace()

Get the remoteVirtualNetworkAddressSpace property: The reference to the current address space of the remote virtual network.

Returns:

the remoteVirtualNetworkAddressSpace value.

remoteVirtualNetworkEncryption

public VirtualNetworkEncryption remoteVirtualNetworkEncryption()

Get the remoteVirtualNetworkEncryption property: The reference to the remote virtual network's encryption.

Returns:

the remoteVirtualNetworkEncryption value.

resourceGuid

public String resourceGuid()

Get the resourceGuid property: The resourceGuid property of the Virtual Network peering resource.

Returns:

the resourceGuid value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

VirtualNetworkPeeringInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: Resource type.

Returns:

the type value.

useRemoteGateways

public Boolean useRemoteGateways()

Get the useRemoteGateways property: 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.

Returns:

the useRemoteGateways value.

validate

public void validate()

Validates the instance.

withAllowForwardedTraffic

public VirtualNetworkPeeringInner withAllowForwardedTraffic(Boolean allowForwardedTraffic)

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

Parameters:

allowForwardedTraffic - the allowForwardedTraffic value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withAllowGatewayTransit

public VirtualNetworkPeeringInner withAllowGatewayTransit(Boolean allowGatewayTransit)

Set the allowGatewayTransit property: If gateway links can be used in remote virtual networking to link to this virtual network.

Parameters:

allowGatewayTransit - the allowGatewayTransit value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withAllowVirtualNetworkAccess

public VirtualNetworkPeeringInner withAllowVirtualNetworkAccess(Boolean allowVirtualNetworkAccess)

Set the allowVirtualNetworkAccess property: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.

Parameters:

allowVirtualNetworkAccess - the allowVirtualNetworkAccess value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withDoNotVerifyRemoteGateways

public VirtualNetworkPeeringInner withDoNotVerifyRemoteGateways(Boolean doNotVerifyRemoteGateways)

Set the doNotVerifyRemoteGateways property: If we need to verify the provisioning state of the remote gateway.

Parameters:

doNotVerifyRemoteGateways - the doNotVerifyRemoteGateways value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withEnableOnlyIPv6Peering

public VirtualNetworkPeeringInner withEnableOnlyIPv6Peering(Boolean enableOnlyIPv6Peering)

Set the enableOnlyIPv6Peering property: Whether only Ipv6 address space is peered for subnet peering.

Parameters:

enableOnlyIPv6Peering - the enableOnlyIPv6Peering value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withId

public VirtualNetworkPeeringInner withId(String id)

Overrides:

VirtualNetworkPeeringInner.withId(String id)

Parameters:

id

withLocalAddressSpace

public VirtualNetworkPeeringInner withLocalAddressSpace(AddressSpace localAddressSpace)

Set the localAddressSpace property: The local address space of the local virtual network that is peered.

Parameters:

localAddressSpace - the localAddressSpace value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withLocalSubnetNames

public VirtualNetworkPeeringInner withLocalSubnetNames(List localSubnetNames)

Set the localSubnetNames property: List of local subnet names that are subnet peered with remote virtual network.

Parameters:

localSubnetNames - the localSubnetNames value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withLocalVirtualNetworkAddressSpace

public VirtualNetworkPeeringInner withLocalVirtualNetworkAddressSpace(AddressSpace localVirtualNetworkAddressSpace)

Set the localVirtualNetworkAddressSpace property: The current local address space of the local virtual network that is peered.

Parameters:

localVirtualNetworkAddressSpace - the localVirtualNetworkAddressSpace value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withName

public VirtualNetworkPeeringInner withName(String name)

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

Parameters:

name - the name value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withPeerCompleteVnets

public VirtualNetworkPeeringInner withPeerCompleteVnets(Boolean peerCompleteVnets)

Set the peerCompleteVnets property: Whether complete virtual network address space is peered.

Parameters:

peerCompleteVnets - the peerCompleteVnets value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withPeeringState

public VirtualNetworkPeeringInner withPeeringState(VirtualNetworkPeeringState peeringState)

Set the peeringState property: The status of the virtual network peering.

Parameters:

peeringState - the peeringState value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withPeeringSyncLevel

public VirtualNetworkPeeringInner withPeeringSyncLevel(VirtualNetworkPeeringLevel peeringSyncLevel)

Set the peeringSyncLevel property: The peering sync status of the virtual network peering.

Parameters:

peeringSyncLevel - the peeringSyncLevel value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withRemoteAddressSpace

public VirtualNetworkPeeringInner withRemoteAddressSpace(AddressSpace remoteAddressSpace)

Set the remoteAddressSpace property: The reference to the address space peered with the remote virtual network.

Parameters:

remoteAddressSpace - the remoteAddressSpace value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withRemoteBgpCommunities

public VirtualNetworkPeeringInner withRemoteBgpCommunities(VirtualNetworkBgpCommunities remoteBgpCommunities)

Set the remoteBgpCommunities property: The reference to the remote virtual network's Bgp Communities.

Parameters:

remoteBgpCommunities - the remoteBgpCommunities value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withRemoteSubnetNames

public VirtualNetworkPeeringInner withRemoteSubnetNames(List remoteSubnetNames)

Set the remoteSubnetNames property: List of remote subnet names from remote virtual network that are subnet peered.

Parameters:

remoteSubnetNames - the remoteSubnetNames value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withRemoteVirtualNetwork

public VirtualNetworkPeeringInner withRemoteVirtualNetwork(SubResource remoteVirtualNetwork)

Set the remoteVirtualNetwork property: 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).

Parameters:

remoteVirtualNetwork - the remoteVirtualNetwork value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withRemoteVirtualNetworkAddressSpace

public VirtualNetworkPeeringInner withRemoteVirtualNetworkAddressSpace(AddressSpace remoteVirtualNetworkAddressSpace)

Set the remoteVirtualNetworkAddressSpace property: The reference to the current address space of the remote virtual network.

Parameters:

remoteVirtualNetworkAddressSpace - the remoteVirtualNetworkAddressSpace value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withType

public VirtualNetworkPeeringInner withType(String type)

Set the type property: Resource type.

Parameters:

type - the type value to set.

Returns:

the VirtualNetworkPeeringInner object itself.

withUseRemoteGateways

public VirtualNetworkPeeringInner withUseRemoteGateways(Boolean useRemoteGateways)

Set the useRemoteGateways property: 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.

Parameters:

useRemoteGateways - the useRemoteGateways value to set.

Returns:

the VirtualNetworkPeeringInner object itself.