VirtualNetworkPeeringInner (Azure SDK for Java Reference Documentation)

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

public class VirtualNetworkPeeringInner
extends com.azure.core.management.SubResource

Peerings in a virtual network resource.

Constructor Summary

Constructors
Constructor and Description

VirtualNetworkPeeringInner()

Constructors
Constructor and Description
`VirtualNetworkPeeringInner()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`String`	`etag()` Get the etag property: A unique read-only string that changes whenever the resource is updated.
`String`	`name()` Get the name property: The name of the resource that is unique within a resource group.
`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.
`com.azure.core.management.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.
`String`	`resourceGuid()` Get the resourceGuid property: The resourceGuid property of the Virtual Network peering resource.
`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`	`withId(String id)`
`VirtualNetworkPeeringInner`	`withName(String name)` Set the name property: The name of the resource that is unique within a resource group.
`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`	`withRemoteVirtualNetwork(com.azure.core.management.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 class com.azure.core.management.SubResource
id

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VirtualNetworkPeeringInner
```
public VirtualNetworkPeeringInner()
```
- Method Detail
  - 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.
  - 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.
  - etag
```
public String etag()
```
    Get the etag property: A unique read-only string that changes whenever the resource is updated.
    
    Returns:
    
    the etag value.
  - type
```
public String type()
```
    Get the type property: Resource type.
    
    Returns:
    
    the type value.
  - withType
```
public VirtualNetworkPeeringInner withType(String type)
```
    Set the type property: Resource type.
    
    Parameters:
    
    type - the type value to set.
    
    Returns:
    
    the VirtualNetworkPeeringInner object itself.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - remoteVirtualNetwork
```
public com.azure.core.management.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.
  - withRemoteVirtualNetwork
```
public VirtualNetworkPeeringInner withRemoteVirtualNetwork(com.azure.core.management.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.
  - remoteAddressSpace
```
public AddressSpace remoteAddressSpace()
```
    Get the remoteAddressSpace property: The reference to the address space peered with the remote virtual network.
    
    Returns:
    
    the remoteAddressSpace value.
  - 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.
  - remoteVirtualNetworkAddressSpace
```
public AddressSpace remoteVirtualNetworkAddressSpace()
```
    Get the remoteVirtualNetworkAddressSpace property: The reference to the current address space of the remote virtual network.
    
    Returns:
    
    the remoteVirtualNetworkAddressSpace value.
  - 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.
  - remoteBgpCommunities
```
public VirtualNetworkBgpCommunities remoteBgpCommunities()
```
    Get the remoteBgpCommunities property: The reference to the remote virtual network's Bgp Communities.
    
    Returns:
    
    the remoteBgpCommunities value.
  - 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.
  - peeringState
```
public VirtualNetworkPeeringState peeringState()
```
    Get the peeringState property: The status of the virtual network peering.
    
    Returns:
    
    the peeringState value.
  - 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.
  - peeringSyncLevel
```
public VirtualNetworkPeeringLevel peeringSyncLevel()
```
    Get the peeringSyncLevel property: The peering sync status of the virtual network peering.
    
    Returns:
    
    the peeringSyncLevel value.
  - 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.
  - provisioningState
```
public ProvisioningState provisioningState()
```
    Get the provisioningState property: The provisioning state of the virtual network peering resource.
    
    Returns:
    
    the provisioningState 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.
  - 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.
  - resourceGuid
```
public String resourceGuid()
```
    Get the resourceGuid property: The resourceGuid property of the Virtual Network peering resource.
    
    Returns:
    
    the resourceGuid value.
  - withId
```
public VirtualNetworkPeeringInner withId(String id)
```
    Overrides:
    
    withId in class com.azure.core.management.SubResource
  - validate
```
public void validate()
```
    Validates the instance.
    
    Throws:
    
    IllegalArgumentException - thrown if the instance is not valid.

Class VirtualNetworkPeeringInner

Constructor Summary

Method Summary

Methods inherited from class com.azure.core.management.SubResource

Methods inherited from class java.lang.Object

Constructor Detail

VirtualNetworkPeeringInner

Method Detail

name

withName

etag

type

withType

allowVirtualNetworkAccess

withAllowVirtualNetworkAccess

allowForwardedTraffic

withAllowForwardedTraffic

allowGatewayTransit

withAllowGatewayTransit

useRemoteGateways

withUseRemoteGateways

remoteVirtualNetwork

withRemoteVirtualNetwork

remoteAddressSpace

withRemoteAddressSpace

remoteVirtualNetworkAddressSpace

withRemoteVirtualNetworkAddressSpace

remoteBgpCommunities

withRemoteBgpCommunities

peeringState

withPeeringState

peeringSyncLevel

withPeeringSyncLevel

provisioningState

doNotVerifyRemoteGateways

withDoNotVerifyRemoteGateways

resourceGuid

withId

validate