VpnConnectionInner (Azure SDK for Java Reference Documentation)

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

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

VpnConnection Resource.

Constructor Summary

Constructors
Constructor and Description

VpnConnectionInner()

Constructors
Constructor and Description
`VpnConnectionInner()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`connectionBandwidth()` Get the connectionBandwidth property: Expected bandwidth in MBPS.
`VpnConnectionStatus`	`connectionStatus()` Get the connectionStatus property: The connection status.
`Integer`	`dpdTimeoutSeconds()` Get the dpdTimeoutSeconds property: The dead peer detection timeout for a vpn connection in seconds.
`Long`	`egressBytesTransferred()` Get the egressBytesTransferred property: Egress bytes transferred.
`Boolean`	`enableBgp()` Get the enableBgp property: EnableBgp flag.
`Boolean`	`enableInternetSecurity()` Get the enableInternetSecurity property: Enable internet security.
`Boolean`	`enableRateLimiting()` Get the enableRateLimiting property: EnableBgp flag.
`String`	`etag()` Get the etag property: A unique read-only string that changes whenever the resource is updated.
`Long`	`ingressBytesTransferred()` Get the ingressBytesTransferred property: Ingress bytes transferred.
`List<IpsecPolicy>`	`ipsecPolicies()` Get the ipsecPolicies property: The IPSec Policies to be considered by this connection.
`String`	`name()` Get the name property: The name of the resource that is unique within a resource group.
`ProvisioningState`	`provisioningState()` Get the provisioningState property: The provisioning state of the VPN connection resource.
`com.azure.core.management.SubResource`	`remoteVpnSite()` Get the remoteVpnSite property: Id of the connected vpn site.
`RoutingConfiguration`	`routingConfiguration()` Get the routingConfiguration property: The Routing Configuration indicating the associated and propagated route tables on this connection.
`Integer`	`routingWeight()` Get the routingWeight property: Routing weight for vpn connection.
`String`	`sharedKey()` Get the sharedKey property: SharedKey for the vpn connection.
`Boolean`	`useLocalAzureIpAddress()` Get the useLocalAzureIpAddress property: Use local azure ip to initiate connection.
`Boolean`	`usePolicyBasedTrafficSelectors()` Get the usePolicyBasedTrafficSelectors property: Enable policy-based traffic selectors.
`void`	`validate()` Validates the instance.
`VirtualNetworkGatewayConnectionProtocol`	`vpnConnectionProtocolType()` Get the vpnConnectionProtocolType property: Connection protocol used for this connection.
`List<VpnSiteLinkConnectionInner>`	`vpnLinkConnections()` Get the vpnLinkConnections property: List of all vpn site link connections to the gateway.
`VpnConnectionInner`	`withConnectionBandwidth(Integer connectionBandwidth)` Set the connectionBandwidth property: Expected bandwidth in MBPS.
`VpnConnectionInner`	`withDpdTimeoutSeconds(Integer dpdTimeoutSeconds)` Set the dpdTimeoutSeconds property: The dead peer detection timeout for a vpn connection in seconds.
`VpnConnectionInner`	`withEnableBgp(Boolean enableBgp)` Set the enableBgp property: EnableBgp flag.
`VpnConnectionInner`	`withEnableInternetSecurity(Boolean enableInternetSecurity)` Set the enableInternetSecurity property: Enable internet security.
`VpnConnectionInner`	`withEnableRateLimiting(Boolean enableRateLimiting)` Set the enableRateLimiting property: EnableBgp flag.
`VpnConnectionInner`	`withIpsecPolicies(List<IpsecPolicy> ipsecPolicies)` Set the ipsecPolicies property: The IPSec Policies to be considered by this connection.
`VpnConnectionInner`	`withName(String name)` Set the name property: The name of the resource that is unique within a resource group.
`VpnConnectionInner`	`withRemoteVpnSite(com.azure.core.management.SubResource remoteVpnSite)` Set the remoteVpnSite property: Id of the connected vpn site.
`VpnConnectionInner`	`withRoutingConfiguration(RoutingConfiguration routingConfiguration)` Set the routingConfiguration property: The Routing Configuration indicating the associated and propagated route tables on this connection.
`VpnConnectionInner`	`withRoutingWeight(Integer routingWeight)` Set the routingWeight property: Routing weight for vpn connection.
`VpnConnectionInner`	`withSharedKey(String sharedKey)` Set the sharedKey property: SharedKey for the vpn connection.
`VpnConnectionInner`	`withUseLocalAzureIpAddress(Boolean useLocalAzureIpAddress)` Set the useLocalAzureIpAddress property: Use local azure ip to initiate connection.
`VpnConnectionInner`	`withUsePolicyBasedTrafficSelectors(Boolean usePolicyBasedTrafficSelectors)` Set the usePolicyBasedTrafficSelectors property: Enable policy-based traffic selectors.
`VpnConnectionInner`	`withVpnConnectionProtocolType(VirtualNetworkGatewayConnectionProtocol vpnConnectionProtocolType)` Set the vpnConnectionProtocolType property: Connection protocol used for this connection.
`VpnConnectionInner`	`withVpnLinkConnections(List<VpnSiteLinkConnectionInner> vpnLinkConnections)` Set the vpnLinkConnections property: List of all vpn site link connections to the gateway.

Methods inherited from class com.azure.core.management.SubResource
id, withId

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

- Constructor Detail
  - VpnConnectionInner
```
public VpnConnectionInner()
```
- 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 VpnConnectionInner 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 VpnConnectionInner 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.
  - remoteVpnSite
```
public com.azure.core.management.SubResource remoteVpnSite()
```
    Get the remoteVpnSite property: Id of the connected vpn site.
    
    Returns:
    
    the remoteVpnSite value.
  - withRemoteVpnSite
```
public VpnConnectionInner withRemoteVpnSite(com.azure.core.management.SubResource remoteVpnSite)
```
    Set the remoteVpnSite property: Id of the connected vpn site.
    
    Parameters:
    
    remoteVpnSite - the remoteVpnSite value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - routingWeight
```
public Integer routingWeight()
```
    Get the routingWeight property: Routing weight for vpn connection.
    
    Returns:
    
    the routingWeight value.
  - withRoutingWeight
```
public VpnConnectionInner withRoutingWeight(Integer routingWeight)
```
    Set the routingWeight property: Routing weight for vpn connection.
    
    Parameters:
    
    routingWeight - the routingWeight value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - dpdTimeoutSeconds
```
public Integer dpdTimeoutSeconds()
```
    Get the dpdTimeoutSeconds property: The dead peer detection timeout for a vpn connection in seconds.
    
    Returns:
    
    the dpdTimeoutSeconds value.
  - withDpdTimeoutSeconds
```
public VpnConnectionInner withDpdTimeoutSeconds(Integer dpdTimeoutSeconds)
```
    Set the dpdTimeoutSeconds property: The dead peer detection timeout for a vpn connection in seconds.
    
    Parameters:
    
    dpdTimeoutSeconds - the dpdTimeoutSeconds value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - connectionStatus
```
public VpnConnectionStatus connectionStatus()
```
    Get the connectionStatus property: The connection status.
    
    Returns:
    
    the connectionStatus value.
  - vpnConnectionProtocolType
```
public VirtualNetworkGatewayConnectionProtocol vpnConnectionProtocolType()
```
    Get the vpnConnectionProtocolType property: Connection protocol used for this connection.
    
    Returns:
    
    the vpnConnectionProtocolType value.
  - withVpnConnectionProtocolType
```
public VpnConnectionInner withVpnConnectionProtocolType(VirtualNetworkGatewayConnectionProtocol vpnConnectionProtocolType)
```
    Set the vpnConnectionProtocolType property: Connection protocol used for this connection.
    
    Parameters:
    
    vpnConnectionProtocolType - the vpnConnectionProtocolType value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - ingressBytesTransferred
```
public Long ingressBytesTransferred()
```
    Get the ingressBytesTransferred property: Ingress bytes transferred.
    
    Returns:
    
    the ingressBytesTransferred value.
  - egressBytesTransferred
```
public Long egressBytesTransferred()
```
    Get the egressBytesTransferred property: Egress bytes transferred.
    
    Returns:
    
    the egressBytesTransferred value.
  - connectionBandwidth
```
public Integer connectionBandwidth()
```
    Get the connectionBandwidth property: Expected bandwidth in MBPS.
    
    Returns:
    
    the connectionBandwidth value.
  - withConnectionBandwidth
```
public VpnConnectionInner withConnectionBandwidth(Integer connectionBandwidth)
```
    Set the connectionBandwidth property: Expected bandwidth in MBPS.
    
    Parameters:
    
    connectionBandwidth - the connectionBandwidth value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - sharedKey
```
public String sharedKey()
```
    Get the sharedKey property: SharedKey for the vpn connection.
    
    Returns:
    
    the sharedKey value.
  - withSharedKey
```
public VpnConnectionInner withSharedKey(String sharedKey)
```
    Set the sharedKey property: SharedKey for the vpn connection.
    
    Parameters:
    
    sharedKey - the sharedKey value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - enableBgp
```
public Boolean enableBgp()
```
    Get the enableBgp property: EnableBgp flag.
    
    Returns:
    
    the enableBgp value.
  - withEnableBgp
```
public VpnConnectionInner withEnableBgp(Boolean enableBgp)
```
    Set the enableBgp property: EnableBgp flag.
    
    Parameters:
    
    enableBgp - the enableBgp value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - usePolicyBasedTrafficSelectors
```
public Boolean usePolicyBasedTrafficSelectors()
```
    Get the usePolicyBasedTrafficSelectors property: Enable policy-based traffic selectors.
    
    Returns:
    
    the usePolicyBasedTrafficSelectors value.
  - withUsePolicyBasedTrafficSelectors
```
public VpnConnectionInner withUsePolicyBasedTrafficSelectors(Boolean usePolicyBasedTrafficSelectors)
```
    Set the usePolicyBasedTrafficSelectors property: Enable policy-based traffic selectors.
    
    Parameters:
    
    usePolicyBasedTrafficSelectors - the usePolicyBasedTrafficSelectors value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - ipsecPolicies
```
public List<IpsecPolicy> ipsecPolicies()
```
    Get the ipsecPolicies property: The IPSec Policies to be considered by this connection.
    
    Returns:
    
    the ipsecPolicies value.
  - withIpsecPolicies
```
public VpnConnectionInner withIpsecPolicies(List<IpsecPolicy> ipsecPolicies)
```
    Set the ipsecPolicies property: The IPSec Policies to be considered by this connection.
    
    Parameters:
    
    ipsecPolicies - the ipsecPolicies value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - enableRateLimiting
```
public Boolean enableRateLimiting()
```
    Get the enableRateLimiting property: EnableBgp flag.
    
    Returns:
    
    the enableRateLimiting value.
  - withEnableRateLimiting
```
public VpnConnectionInner withEnableRateLimiting(Boolean enableRateLimiting)
```
    Set the enableRateLimiting property: EnableBgp flag.
    
    Parameters:
    
    enableRateLimiting - the enableRateLimiting value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - enableInternetSecurity
```
public Boolean enableInternetSecurity()
```
    Get the enableInternetSecurity property: Enable internet security.
    
    Returns:
    
    the enableInternetSecurity value.
  - withEnableInternetSecurity
```
public VpnConnectionInner withEnableInternetSecurity(Boolean enableInternetSecurity)
```
    Set the enableInternetSecurity property: Enable internet security.
    
    Parameters:
    
    enableInternetSecurity - the enableInternetSecurity value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - useLocalAzureIpAddress
```
public Boolean useLocalAzureIpAddress()
```
    Get the useLocalAzureIpAddress property: Use local azure ip to initiate connection.
    
    Returns:
    
    the useLocalAzureIpAddress value.
  - withUseLocalAzureIpAddress
```
public VpnConnectionInner withUseLocalAzureIpAddress(Boolean useLocalAzureIpAddress)
```
    Set the useLocalAzureIpAddress property: Use local azure ip to initiate connection.
    
    Parameters:
    
    useLocalAzureIpAddress - the useLocalAzureIpAddress value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - provisioningState
```
public ProvisioningState provisioningState()
```
    Get the provisioningState property: The provisioning state of the VPN connection resource.
    
    Returns:
    
    the provisioningState value.
  - vpnLinkConnections
```
public List<VpnSiteLinkConnectionInner> vpnLinkConnections()
```
    Get the vpnLinkConnections property: List of all vpn site link connections to the gateway.
    
    Returns:
    
    the vpnLinkConnections value.
  - withVpnLinkConnections
```
public VpnConnectionInner withVpnLinkConnections(List<VpnSiteLinkConnectionInner> vpnLinkConnections)
```
    Set the vpnLinkConnections property: List of all vpn site link connections to the gateway.
    
    Parameters:
    
    vpnLinkConnections - the vpnLinkConnections value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - routingConfiguration
```
public RoutingConfiguration routingConfiguration()
```
    Get the routingConfiguration property: The Routing Configuration indicating the associated and propagated route tables on this connection.
    
    Returns:
    
    the routingConfiguration value.
  - withRoutingConfiguration
```
public VpnConnectionInner withRoutingConfiguration(RoutingConfiguration routingConfiguration)
```
    Set the routingConfiguration property: The Routing Configuration indicating the associated and propagated route tables on this connection.
    
    Parameters:
    
    routingConfiguration - the routingConfiguration value to set.
    
    Returns:
    
    the VpnConnectionInner object itself.
  - validate
```
public void validate()
```
    Validates the instance.
    
    Throws:
    
    IllegalArgumentException - thrown if the instance is not valid.

Class VpnConnectionInner

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

VpnConnectionInner

Method Detail

name

withName

etag

remoteVpnSite

withRemoteVpnSite

routingWeight

withRoutingWeight

dpdTimeoutSeconds

withDpdTimeoutSeconds

connectionStatus

vpnConnectionProtocolType

withVpnConnectionProtocolType

ingressBytesTransferred

egressBytesTransferred

connectionBandwidth

withConnectionBandwidth

sharedKey

withSharedKey

enableBgp

withEnableBgp

usePolicyBasedTrafficSelectors

withUsePolicyBasedTrafficSelectors

ipsecPolicies

withIpsecPolicies

enableRateLimiting

withEnableRateLimiting

enableInternetSecurity

withEnableInternetSecurity

useLocalAzureIpAddress

withUseLocalAzureIpAddress

provisioningState

vpnLinkConnections

withVpnLinkConnections

routingConfiguration

withRoutingConfiguration

validate