Package com.azure.resourcemanager.network.fluent.models

Class VirtualNetworkGatewayInner

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.core.management.Resource
com.azure.resourcemanager.network.fluent.models.VirtualNetworkGatewayInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
public final class VirtualNetworkGatewayInner extends com.azure.core.management.Resource
A common class for general resource information.

  • Constructor Details

    • VirtualNetworkGatewayInner

      public VirtualNetworkGatewayInner()
      Creates an instance of VirtualNetworkGatewayInner class.

  • Method Details

    • extendedLocation

      public ExtendedLocation extendedLocation()
      Get the extendedLocation property: The extended location of type local virtual network gateway.
      Returns:
      the extendedLocation value.

    • 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.

    • etag

      public String etag()
      Get the etag property: A unique read-only string that changes whenever the resource is updated.
      Returns:
      the etag value.

    • identity

      public ManagedServiceIdentity identity()
      Get the identity property: The identity of the virtual network gateway, if configured.
      Returns:
      the identity value.

    • withIdentity

      public VirtualNetworkGatewayInner withIdentity(ManagedServiceIdentity identity)
      Set the identity property: The identity of the virtual network gateway, if configured.
      Parameters:
      identity - the identity value to set.
      Returns:
      the VirtualNetworkGatewayInner object itself.

    • id

      public String id()
      Get the id property: Resource ID.
      Overrides:
      id in class com.azure.core.management.ProxyResource
      Returns:
      the id value.

    • withId

      public VirtualNetworkGatewayInner withId(String id)
      Set the id property: Resource ID.
      Parameters:
      id - the id value to set.
      Returns:
      the VirtualNetworkGatewayInner object itself.

    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class com.azure.core.management.ProxyResource
      Returns:
      the type value.

    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class com.azure.core.management.ProxyResource
      Returns:
      the name value.

    • withLocation

      public VirtualNetworkGatewayInner withLocation(String location)
      Overrides:
      withLocation in class com.azure.core.management.Resource

    • withTags

      public VirtualNetworkGatewayInner withTags(Map<String,String> tags)
      Overrides:
      withTags in class com.azure.core.management.Resource

    • autoScaleConfiguration

      public VirtualNetworkGatewayAutoScaleConfiguration autoScaleConfiguration()
      Get the autoScaleConfiguration property: Autoscale configuration for virutal network gateway.
      Returns:
      the autoScaleConfiguration value.

    • 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.

    • ipConfigurations

      public List<VirtualNetworkGatewayIpConfigurationInner> ipConfigurations()
      Get the ipConfigurations property: IP configurations for virtual network gateway.
      Returns:
      the ipConfigurations value.

    • withIpConfigurations

      public VirtualNetworkGatewayInner withIpConfigurations(List<VirtualNetworkGatewayIpConfigurationInner> ipConfigurations)
      Set the ipConfigurations property: IP configurations for virtual network gateway.
      Parameters:
      ipConfigurations - the ipConfigurations value to set.
      Returns:
      the VirtualNetworkGatewayInner object itself.

    • gatewayType

      public VirtualNetworkGatewayType gatewayType()
      Get the gatewayType property: The type of this virtual network gateway.
      Returns:
      the gatewayType value.

    • 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.

    • vpnType

      public VpnType vpnType()
      Get the vpnType property: The type of this virtual network gateway.
      Returns:
      the vpnType value.

    • 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.

    • 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.

    • 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.

    • enableBgp

      public Boolean enableBgp()
      Get the enableBgp property: Whether BGP is enabled for this virtual network gateway or not.
      Returns:
      the enableBgp value.

    • 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.

    • 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.

    • 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.

    • active

      public Boolean active()
      Get the active property: ActiveActive flag.
      Returns:
      the active 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.

    • disableIpSecReplayProtection

      public Boolean disableIpSecReplayProtection()
      Get the disableIpSecReplayProtection property: disableIPSecReplayProtection flag.
      Returns:
      the disableIpSecReplayProtection value.

    • withDisableIpSecReplayProtection

      public VirtualNetworkGatewayInner withDisableIpSecReplayProtection(Boolean disableIpSecReplayProtection)
      Set the disableIpSecReplayProtection property: disableIPSecReplayProtection flag.
      Parameters:
      disableIpSecReplayProtection - the disableIpSecReplayProtection value to set.
      Returns:
      the VirtualNetworkGatewayInner object itself.

    • gatewayDefaultSite

      public com.azure.core.management.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.

    • withGatewayDefaultSite

      public VirtualNetworkGatewayInner withGatewayDefaultSite(com.azure.core.management.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.

    • 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.

    • 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.

    • vpnClientConfiguration

      public VpnClientConfiguration vpnClientConfiguration()
      Get the vpnClientConfiguration property: The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
      Returns:
      the vpnClientConfiguration value.

    • 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.

    • virtualNetworkGatewayPolicyGroups

      public List<VirtualNetworkGatewayPolicyGroup> virtualNetworkGatewayPolicyGroups()
      Get the virtualNetworkGatewayPolicyGroups property: The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.
      Returns:
      the virtualNetworkGatewayPolicyGroups value.

    • withVirtualNetworkGatewayPolicyGroups

      public VirtualNetworkGatewayInner withVirtualNetworkGatewayPolicyGroups(List<VirtualNetworkGatewayPolicyGroup> 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.

    • bgpSettings

      public BgpSettings bgpSettings()
      Get the bgpSettings property: Virtual network gateway's BGP speaker settings.
      Returns:
      the bgpSettings value.

    • 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.

    • 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.

    • 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.

    • resourceGuid

      public String resourceGuid()
      Get the resourceGuid property: The resource GUID property of the virtual network gateway resource.
      Returns:
      the resourceGuid value.

    • provisioningState

      public ProvisioningState provisioningState()
      Get the provisioningState property: The provisioning state of the virtual network gateway resource.
      Returns:
      the provisioningState value.

    • enableDnsForwarding

      public Boolean enableDnsForwarding()
      Get the enableDnsForwarding property: Whether dns forwarding is enabled or not.
      Returns:
      the enableDnsForwarding value.

    • 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.

    • 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.

    • 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.

    • 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.

    • natRules

      public List<VirtualNetworkGatewayNatRuleInner> natRules()
      Get the natRules property: NatRules for virtual network gateway.
      Returns:
      the natRules value.

    • withNatRules

      public VirtualNetworkGatewayInner withNatRules(List<VirtualNetworkGatewayNatRuleInner> natRules)
      Set the natRules property: NatRules for virtual network gateway.
      Parameters:
      natRules - the natRules value to set.
      Returns:
      the VirtualNetworkGatewayInner object itself.

    • enableBgpRouteTranslationForNat

      public Boolean enableBgpRouteTranslationForNat()
      Get the enableBgpRouteTranslationForNat property: EnableBgpRouteTranslationForNat flag.
      Returns:
      the enableBgpRouteTranslationForNat value.

    • withEnableBgpRouteTranslationForNat

      public VirtualNetworkGatewayInner withEnableBgpRouteTranslationForNat(Boolean enableBgpRouteTranslationForNat)
      Set the enableBgpRouteTranslationForNat property: EnableBgpRouteTranslationForNat flag.
      Parameters:
      enableBgpRouteTranslationForNat - the enableBgpRouteTranslationForNat value to set.
      Returns:
      the VirtualNetworkGatewayInner object itself.

    • allowVirtualWanTraffic

      public Boolean allowVirtualWanTraffic()
      Get the allowVirtualWanTraffic property: Configures this gateway to accept traffic from remote Virtual WAN networks.
      Returns:
      the allowVirtualWanTraffic value.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • resiliencyModel

      public ResiliencyModel resiliencyModel()
      Get the resiliencyModel property: Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed.
      Returns:
      the resiliencyModel value.

    • withResiliencyModel

      public VirtualNetworkGatewayInner withResiliencyModel(ResiliencyModel resiliencyModel)
      Set the resiliencyModel property: Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed.
      Parameters:
      resiliencyModel - the resiliencyModel value to set.
      Returns:
      the VirtualNetworkGatewayInner object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
      Overrides:
      toJson in class com.azure.core.management.Resource
      Throws:
      IOException

    • fromJson

      public static VirtualNetworkGatewayInner fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of VirtualNetworkGatewayInner from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of VirtualNetworkGatewayInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the VirtualNetworkGatewayInner.