VirtualNetworkGatewayInner Class

Package:

com.azure.resourcemanager.network.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-network:2.37.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.network.fluent.models.VirtualNetworkGatewayInner

public final class VirtualNetworkGatewayInner
extends Resource

A common class for general resource information.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Boolean	active() Get the active property: ActiveActive flag.
AdminState	adminState() Get the adminState property: Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet.
Boolean	allowRemoteVnetTraffic() Get the allowRemoteVnetTraffic property: Configure this gateway to accept traffic from other Azure Virtual Networks.
Boolean	allowVirtualWanTraffic() Get the allowVirtualWanTraffic property: Configures this gateway to accept traffic from remote Virtual WAN networks.
VirtualNetworkGatewayAutoScaleConfiguration	autoScaleConfiguration() Get the autoScaleConfiguration property: Autoscale configuration for virutal network gateway.
BgpSettings	bgpSettings() Get the bgpSettings property: Virtual network gateway's BGP speaker settings.
AddressSpace	customRoutes() Get the customRoutes property: The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
Boolean	disableIpSecReplayProtection() Get the disableIpSecReplayProtection property: disableIPSecReplayProtection flag.
Boolean	enableBgp() Get the enableBgp property: Whether BGP is enabled for this virtual network gateway or not.
Boolean	enableBgpRouteTranslationForNat() Get the enableBgpRouteTranslationForNat property: EnableBgpRouteTranslationForNat flag.
Boolean	enableDnsForwarding() Get the enableDnsForwarding property: Whether dns forwarding is enabled or not.
Boolean	enablePrivateIpAddress() Get the enablePrivateIpAddress property: Whether private IP needs to be enabled on this gateway for connections or not.
String	etag() Get the etag property: A unique read-only string that changes whenever the resource is updated.
ExtendedLocation	extendedLocation() Get the extendedLocation property: The extended location of type local virtual network gateway.
SubResource	gatewayDefaultSite() Get the gatewayDefaultSite property: The reference to the LocalNetworkGateway resource which represents local network site having default routes.
VirtualNetworkGatewayType	gatewayType() Get the gatewayType property: The type of this virtual network gateway.
String	id() Get the id property: Resource ID.
String	inboundDnsForwardingEndpoint() Get the inboundDnsForwardingEndpoint property: The IP address allocated by the gateway to which dns requests can be sent.
List<VirtualNetworkGatewayIpConfigurationInner>	ipConfigurations() Get the ipConfigurations property: IP configurations for virtual network gateway.
List<VirtualNetworkGatewayNatRuleInner>	natRules() Get the natRules property: NatRules for virtual network gateway.
ProvisioningState	provisioningState() Get the provisioningState property: The provisioning state of the virtual network gateway resource.
String	resourceGuid() Get the resourceGuid property: The resource GUID property of the virtual network gateway resource.
VirtualNetworkGatewaySku	sku() Get the sku property: The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
String	vNetExtendedLocationResourceId() Get the vNetExtendedLocationResourceId property: Customer vnet resource id.
void	validate() Validates the instance.
List<VirtualNetworkGatewayPolicyGroup>	virtualNetworkGatewayPolicyGroups() Get the virtualNetworkGatewayPolicyGroups property: The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.
VpnClientConfiguration	vpnClientConfiguration() Get the vpnClientConfiguration property: The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
VpnGatewayGeneration	vpnGatewayGeneration() Get the vpnGatewayGeneration property: The generation for this VirtualNetworkGateway.
VpnType	vpnType() Get the vpnType property: The type of this virtual network gateway.
VirtualNetworkGatewayInner	withActive(Boolean active) Set the active property: ActiveActive flag.
VirtualNetworkGatewayInner	withAdminState(AdminState adminState) Set the adminState property: Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet.
VirtualNetworkGatewayInner	withAllowRemoteVnetTraffic(Boolean allowRemoteVnetTraffic) Set the allowRemoteVnetTraffic property: Configure this gateway to accept traffic from other Azure Virtual Networks.
VirtualNetworkGatewayInner	withAllowVirtualWanTraffic(Boolean allowVirtualWanTraffic) Set the allowVirtualWanTraffic property: Configures this gateway to accept traffic from remote Virtual WAN networks.
VirtualNetworkGatewayInner	withAutoScaleConfiguration(VirtualNetworkGatewayAutoScaleConfiguration autoScaleConfiguration) Set the autoScaleConfiguration property: Autoscale configuration for virutal network gateway.
VirtualNetworkGatewayInner	withBgpSettings(BgpSettings bgpSettings) Set the bgpSettings property: Virtual network gateway's BGP speaker settings.
VirtualNetworkGatewayInner	withCustomRoutes(AddressSpace customRoutes) Set the customRoutes property: The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
VirtualNetworkGatewayInner	withDisableIpSecReplayProtection(Boolean disableIpSecReplayProtection) Set the disableIpSecReplayProtection property: disableIPSecReplayProtection flag.
VirtualNetworkGatewayInner	withEnableBgp(Boolean enableBgp) Set the enableBgp property: Whether BGP is enabled for this virtual network gateway or not.
VirtualNetworkGatewayInner	withEnableBgpRouteTranslationForNat(Boolean enableBgpRouteTranslationForNat) Set the enableBgpRouteTranslationForNat property: EnableBgpRouteTranslationForNat flag.
VirtualNetworkGatewayInner	withEnableDnsForwarding(Boolean enableDnsForwarding) Set the enableDnsForwarding property: Whether dns forwarding is enabled or not.
VirtualNetworkGatewayInner	withEnablePrivateIpAddress(Boolean enablePrivateIpAddress) Set the enablePrivateIpAddress property: Whether private IP needs to be enabled on this gateway for connections or not.
VirtualNetworkGatewayInner	withExtendedLocation(ExtendedLocation extendedLocation) Set the extendedLocation property: The extended location of type local virtual network gateway.
VirtualNetworkGatewayInner	withGatewayDefaultSite(SubResource gatewayDefaultSite) Set the gatewayDefaultSite property: The reference to the LocalNetworkGateway resource which represents local network site having default routes.
VirtualNetworkGatewayInner	withGatewayType(VirtualNetworkGatewayType gatewayType) Set the gatewayType property: The type of this virtual network gateway.
VirtualNetworkGatewayInner	withId(String id) Set the id property: Resource ID.
VirtualNetworkGatewayInner	withIpConfigurations(List<VirtualNetworkGatewayIpConfigurationInner> ipConfigurations) Set the ipConfigurations property: IP configurations for virtual network gateway.
VirtualNetworkGatewayInner	withLocation(String location)
VirtualNetworkGatewayInner	withNatRules(List<VirtualNetworkGatewayNatRuleInner> natRules) Set the natRules property: NatRules for virtual network gateway.
VirtualNetworkGatewayInner	withSku(VirtualNetworkGatewaySku sku) Set the sku property: The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
VirtualNetworkGatewayInner	withTags(Map<String,String> tags)
VirtualNetworkGatewayInner	withVNetExtendedLocationResourceId(String vNetExtendedLocationResourceId) Set the vNetExtendedLocationResourceId property: Customer vnet resource id.
VirtualNetworkGatewayInner	withVirtualNetworkGatewayPolicyGroups(List<VirtualNetworkGatewayPolicyGroup> virtualNetworkGatewayPolicyGroups) Set the virtualNetworkGatewayPolicyGroups property: The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.
VirtualNetworkGatewayInner	withVpnClientConfiguration(VpnClientConfiguration vpnClientConfiguration) Set the vpnClientConfiguration property: The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
VirtualNetworkGatewayInner	withVpnGatewayGeneration(VpnGatewayGeneration vpnGatewayGeneration) Set the vpnGatewayGeneration property: The generation for this VirtualNetworkGateway.
VirtualNetworkGatewayInner	withVpnType(VpnType vpnType) Set the vpnType property: The type of this virtual network gateway.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

location tags withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VirtualNetworkGatewayInner

public VirtualNetworkGatewayInner()

Creates an instance of VirtualNetworkGatewayInner class.

Method Details

active

public Boolean active()

Get the active property: ActiveActive flag.

Returns:

the active value.

adminState

public AdminState adminState()

Get the adminState property: Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet.

Returns:

the adminState value.

allowRemoteVnetTraffic

public Boolean allowRemoteVnetTraffic()

Get the allowRemoteVnetTraffic property: Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN.

Returns:

the allowRemoteVnetTraffic value.

allowVirtualWanTraffic

public Boolean allowVirtualWanTraffic()

Get the allowVirtualWanTraffic property: Configures this gateway to accept traffic from remote Virtual WAN networks.

Returns:

the allowVirtualWanTraffic value.

autoScaleConfiguration

public VirtualNetworkGatewayAutoScaleConfiguration autoScaleConfiguration()

Get the autoScaleConfiguration property: Autoscale configuration for virutal network gateway.

Returns:

the autoScaleConfiguration value.

bgpSettings

public BgpSettings bgpSettings()

Get the bgpSettings property: Virtual network gateway's BGP speaker settings.

Returns:

the bgpSettings value.

customRoutes

public AddressSpace customRoutes()

Get the customRoutes property: The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.

Returns:

the customRoutes value.

disableIpSecReplayProtection

public Boolean disableIpSecReplayProtection()

Get the disableIpSecReplayProtection property: disableIPSecReplayProtection flag.

Returns:

the disableIpSecReplayProtection value.

enableBgp

public Boolean enableBgp()

Get the enableBgp property: Whether BGP is enabled for this virtual network gateway or not.

Returns:

the enableBgp value.

enableBgpRouteTranslationForNat

public Boolean enableBgpRouteTranslationForNat()

Get the enableBgpRouteTranslationForNat property: EnableBgpRouteTranslationForNat flag.

Returns:

the enableBgpRouteTranslationForNat value.

enableDnsForwarding

public Boolean enableDnsForwarding()

Get the enableDnsForwarding property: Whether dns forwarding is enabled or not.

Returns:

the enableDnsForwarding value.

enablePrivateIpAddress

public Boolean enablePrivateIpAddress()

Get the enablePrivateIpAddress property: Whether private IP needs to be enabled on this gateway for connections or not.

Returns:

the enablePrivateIpAddress 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.

extendedLocation

public ExtendedLocation extendedLocation()

Get the extendedLocation property: The extended location of type local virtual network gateway.

Returns:

the extendedLocation value.

gatewayDefaultSite

public SubResource gatewayDefaultSite()

Get the gatewayDefaultSite property: The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.

Returns:

the gatewayDefaultSite value.

gatewayType

public VirtualNetworkGatewayType gatewayType()

Get the gatewayType property: The type of this virtual network gateway.

Returns:

the gatewayType value.

id

public String id()

Get the id property: Resource ID.

Overrides:

VirtualNetworkGatewayInner.id()

Returns:

the id value.

inboundDnsForwardingEndpoint

public String inboundDnsForwardingEndpoint()

Get the inboundDnsForwardingEndpoint property: The IP address allocated by the gateway to which dns requests can be sent.

Returns:

the inboundDnsForwardingEndpoint value.

ipConfigurations

public List ipConfigurations()

Get the ipConfigurations property: IP configurations for virtual network gateway.

Returns:

the ipConfigurations value.

natRules

public List natRules()

Get the natRules property: NatRules for virtual network gateway.

Returns:

the natRules value.

provisioningState

public ProvisioningState provisioningState()

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

Returns:

the provisioningState value.

resourceGuid

public String resourceGuid()

Get the resourceGuid property: The resource GUID property of the virtual network gateway resource.

Returns:

the resourceGuid value.

sku

public VirtualNetworkGatewaySku sku()

Get the sku property: The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.

Returns:

the sku value.

vNetExtendedLocationResourceId

public String vNetExtendedLocationResourceId()

Get the vNetExtendedLocationResourceId property: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.

Returns:

the vNetExtendedLocationResourceId value.

validate

public void validate()

Validates the instance.

virtualNetworkGatewayPolicyGroups

public List virtualNetworkGatewayPolicyGroups()

Get the virtualNetworkGatewayPolicyGroups property: The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.

Returns:

the virtualNetworkGatewayPolicyGroups value.

vpnClientConfiguration

public VpnClientConfiguration vpnClientConfiguration()

Get the vpnClientConfiguration property: The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.

Returns:

the vpnClientConfiguration value.

vpnGatewayGeneration

public VpnGatewayGeneration vpnGatewayGeneration()

Get the vpnGatewayGeneration property: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.

Returns:

the vpnGatewayGeneration value.

vpnType

public VpnType vpnType()

Get the vpnType property: The type of this virtual network gateway.

Returns:

the vpnType value.

withActive

public VirtualNetworkGatewayInner withActive(Boolean active)

Set the active property: ActiveActive flag.

Parameters:

active - the active value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withAdminState

public VirtualNetworkGatewayInner withAdminState(AdminState adminState)

Set the adminState property: Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet.

Parameters:

adminState - the adminState value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withAllowRemoteVnetTraffic

public VirtualNetworkGatewayInner withAllowRemoteVnetTraffic(Boolean allowRemoteVnetTraffic)

Set the allowRemoteVnetTraffic property: Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN.

Parameters:

allowRemoteVnetTraffic - the allowRemoteVnetTraffic value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withAllowVirtualWanTraffic

public VirtualNetworkGatewayInner withAllowVirtualWanTraffic(Boolean allowVirtualWanTraffic)

Set the allowVirtualWanTraffic property: Configures this gateway to accept traffic from remote Virtual WAN networks.

Parameters:

allowVirtualWanTraffic - the allowVirtualWanTraffic value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withAutoScaleConfiguration

public VirtualNetworkGatewayInner withAutoScaleConfiguration(VirtualNetworkGatewayAutoScaleConfiguration autoScaleConfiguration)

Set the autoScaleConfiguration property: Autoscale configuration for virutal network gateway.

Parameters:

autoScaleConfiguration - the autoScaleConfiguration value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withBgpSettings

public VirtualNetworkGatewayInner withBgpSettings(BgpSettings bgpSettings)

Set the bgpSettings property: Virtual network gateway's BGP speaker settings.

Parameters:

bgpSettings - the bgpSettings value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withCustomRoutes

public VirtualNetworkGatewayInner withCustomRoutes(AddressSpace customRoutes)

Set the customRoutes property: The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.

Parameters:

customRoutes - the customRoutes value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withDisableIpSecReplayProtection

public VirtualNetworkGatewayInner withDisableIpSecReplayProtection(Boolean disableIpSecReplayProtection)

Set the disableIpSecReplayProtection property: disableIPSecReplayProtection flag.

Parameters:

disableIpSecReplayProtection - the disableIpSecReplayProtection value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withEnableBgp

public VirtualNetworkGatewayInner withEnableBgp(Boolean enableBgp)

Set the enableBgp property: Whether BGP is enabled for this virtual network gateway or not.

Parameters:

enableBgp - the enableBgp value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withEnableBgpRouteTranslationForNat

public VirtualNetworkGatewayInner withEnableBgpRouteTranslationForNat(Boolean enableBgpRouteTranslationForNat)

Set the enableBgpRouteTranslationForNat property: EnableBgpRouteTranslationForNat flag.

Parameters:

enableBgpRouteTranslationForNat - the enableBgpRouteTranslationForNat value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withEnableDnsForwarding

public VirtualNetworkGatewayInner withEnableDnsForwarding(Boolean enableDnsForwarding)

Set the enableDnsForwarding property: Whether dns forwarding is enabled or not.

Parameters:

enableDnsForwarding - the enableDnsForwarding value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withEnablePrivateIpAddress

public VirtualNetworkGatewayInner withEnablePrivateIpAddress(Boolean enablePrivateIpAddress)

Set the enablePrivateIpAddress property: Whether private IP needs to be enabled on this gateway for connections or not.

Parameters:

enablePrivateIpAddress - the enablePrivateIpAddress value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withExtendedLocation

public VirtualNetworkGatewayInner withExtendedLocation(ExtendedLocation extendedLocation)

Set the extendedLocation property: The extended location of type local virtual network gateway.

Parameters:

extendedLocation - the extendedLocation value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withGatewayDefaultSite

public VirtualNetworkGatewayInner withGatewayDefaultSite(SubResource gatewayDefaultSite)

Set the gatewayDefaultSite property: The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.

Parameters:

gatewayDefaultSite - the gatewayDefaultSite value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withGatewayType

public VirtualNetworkGatewayInner withGatewayType(VirtualNetworkGatewayType gatewayType)

Set the gatewayType property: The type of this virtual network gateway.

Parameters:

gatewayType - the gatewayType value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withId

public VirtualNetworkGatewayInner withId(String id)

Set the id property: Resource ID.

Parameters:

id - the id value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withIpConfigurations

public VirtualNetworkGatewayInner withIpConfigurations(List ipConfigurations)

Set the ipConfigurations property: IP configurations for virtual network gateway.

Parameters:

ipConfigurations - the ipConfigurations value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withLocation

public VirtualNetworkGatewayInner withLocation(String location)

Overrides:

VirtualNetworkGatewayInner.withLocation(String location)

Parameters:

location

withNatRules

public VirtualNetworkGatewayInner withNatRules(List natRules)

Set the natRules property: NatRules for virtual network gateway.

Parameters:

natRules - the natRules value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withSku

public VirtualNetworkGatewayInner withSku(VirtualNetworkGatewaySku sku)

Set the sku property: The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.

Parameters:

sku - the sku value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withTags

public VirtualNetworkGatewayInner withTags(Map tags)

Overrides:

VirtualNetworkGatewayInner.withTags(Map<String,String> tags)

Parameters:

tags

withVNetExtendedLocationResourceId

public VirtualNetworkGatewayInner withVNetExtendedLocationResourceId(String vNetExtendedLocationResourceId)

Set the vNetExtendedLocationResourceId property: Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.

Parameters:

vNetExtendedLocationResourceId - the vNetExtendedLocationResourceId value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withVirtualNetworkGatewayPolicyGroups

public VirtualNetworkGatewayInner withVirtualNetworkGatewayPolicyGroups(List virtualNetworkGatewayPolicyGroups)

Set the virtualNetworkGatewayPolicyGroups property: The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.

Parameters:

virtualNetworkGatewayPolicyGroups - the virtualNetworkGatewayPolicyGroups value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withVpnClientConfiguration

public VirtualNetworkGatewayInner withVpnClientConfiguration(VpnClientConfiguration vpnClientConfiguration)

Set the vpnClientConfiguration property: The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.

Parameters:

vpnClientConfiguration - the vpnClientConfiguration value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withVpnGatewayGeneration

public VirtualNetworkGatewayInner withVpnGatewayGeneration(VpnGatewayGeneration vpnGatewayGeneration)

Set the vpnGatewayGeneration property: The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.

Parameters:

vpnGatewayGeneration - the vpnGatewayGeneration value to set.

Returns:

the VirtualNetworkGatewayInner object itself.

withVpnType

public VirtualNetworkGatewayInner withVpnType(VpnType vpnType)

Set the vpnType property: The type of this virtual network gateway.

Parameters:

vpnType - the vpnType value to set.

Returns:

the VirtualNetworkGatewayInner object itself.