Interface VirtualNetworkGateway

All Superinterfaces:
com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<NetworkManager, VirtualNetworkGatewayInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasId, com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<VirtualNetworkGatewayInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager<NetworkManager>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasName, com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup, com.azure.resourcemanager.resources.fluentcore.model.Indexable, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<VirtualNetworkGateway>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource, com.azure.resourcemanager.resources.fluentcore.model.Updatable<VirtualNetworkGateway.Update>, UpdatableWithTags<VirtualNetworkGateway>

public interface VirtualNetworkGateway extends com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<NetworkManager, VirtualNetworkGatewayInner>, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<VirtualNetworkGateway>, com.azure.resourcemanager.resources.fluentcore.model.Updatable<VirtualNetworkGateway.Update>, UpdatableWithTags<VirtualNetworkGateway>
Entry point for Virtual Network Gateway management API in Azure.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    The entirety of the virtual network gateway definition.
    static interface 
    Grouping of virtual network gateway definition stages.
    static interface 
    The template for a virtual network gateway update operation, containing all the settings that can be modified.
    static interface 
    Grouping of virtual network gateway update stages.

    Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

    Nested classes/interfaces inherited from interface UpdatableWithTags

    UpdatableWithTags.UpdateWithTags<T>
  • Field Summary

    Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    DUMMY
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Checks whether active is active for this virtual network gateway or not.
    Gets virtual network gateway's BGP speaker settings.
    Gets the entry point to virtual network gateway connections management API for this virtual network gateway.
    Gets the resource ID of the LocalNetworkGateway resource which represents local network site having default routes
    Gets the gatewayType value.
    Generates VPN profile for P2S client of the virtual network gateway in the specified resource group.
    Generates asynchronously VPN profile for P2S client of the virtual network gateway in the specified resource group.
    Gets IP configurations for virtual network gateway.
    boolean
    Checks whether BGP is enabled for this virtual network gateway or not.
    com.azure.core.http.rest.PagedIterable<VirtualNetworkGatewayConnection>
    Gets all the connections associated with this virtual network gateway.
    com.azure.core.http.rest.PagedFlux<VirtualNetworkGatewayConnection>
    Get all the connections associated with this virtual network gateway asynchronously.
    void
    Resets the primary of the virtual network gateway.
    Resets the primary of the virtual network gateway asynchronously.
    sku()
    Gets the SKU of this virtual network gateway.
    Gets the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
    Gets the type of this virtual network gateway.

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

    id

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

    innerModel

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

    manager

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

    name

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup

    resourceGroupName

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

    key

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

    refresh, refreshAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    region, regionName, tags, type

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

    update

    Methods inherited from interface UpdatableWithTags

    updateTags
  • Method Details

    • reset

      void reset()
      Resets the primary of the virtual network gateway.
    • resetAsync

      Mono<Void> resetAsync()
      Resets the primary of the virtual network gateway asynchronously.
      Returns:
      a representation of the deferred computation of this call
    • listConnections

      com.azure.core.http.rest.PagedIterable<VirtualNetworkGatewayConnection> listConnections()
      Gets all the connections associated with this virtual network gateway.
      Returns:
      all the connections associated with this virtual network gateway
    • listConnectionsAsync

      com.azure.core.http.rest.PagedFlux<VirtualNetworkGatewayConnection> listConnectionsAsync()
      Get all the connections associated with this virtual network gateway asynchronously.
      Returns:
      all the connections associated with this virtual network gateway
    • generateVpnProfile

      String generateVpnProfile()
      Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.
      Returns:
      String object if successful
    • generateVpnProfileAsync

      Mono<String> generateVpnProfileAsync()
      Generates asynchronously VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.
      Returns:
      String object if successful
    • connections

      Gets the entry point to virtual network gateway connections management API for this virtual network gateway.
      Returns:
      the entry point to virtual network gateway connections management API for this virtual network gateway
    • gatewayType

      Gets the gatewayType value.
      Returns:
      the gatewayType value
    • vpnType

      VpnType vpnType()
      Gets the type of this virtual network gateway.
      Returns:
      the type of this virtual network gateway
    • isBgpEnabled

      boolean isBgpEnabled()
      Checks whether BGP is enabled for this virtual network gateway or not.
      Returns:
      whether BGP is enabled for this virtual network gateway or not
    • activeActive

      boolean activeActive()
      Checks whether active is active for this virtual network gateway or not.
      Returns:
      activeActive flag
    • gatewayDefaultSiteResourceId

      String gatewayDefaultSiteResourceId()
      Gets the resource ID of the LocalNetworkGateway resource which represents local network site having default routes
      Returns:
      the resource ID of the LocalNetworkGateway resource which represents local network site having default routes
    • sku

      Gets the SKU of this virtual network gateway.
      Returns:
      the SKU of this virtual network gateway
    • vpnClientConfiguration

      VpnClientConfiguration vpnClientConfiguration()
      Gets the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
      Returns:
      the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations
    • bgpSettings

      BgpSettings bgpSettings()
      Gets virtual network gateway's BGP speaker settings.
      Returns:
      virtual network gateway's BGP speaker settings
    • ipConfigurations

      Gets IP configurations for virtual network gateway.
      Returns:
      IP configurations for virtual network gateway