com.microsoft.azure.management.network

Interface VirtualNetworkGateway

All Superinterfaces:

GroupableResource<com.microsoft.azure.management.network.implementation.NetworkManager,com.microsoft.azure.management.network.implementation.VirtualNetworkGatewayInner>, HasId, HasInner<com.microsoft.azure.management.network.implementation.VirtualNetworkGatewayInner>, HasManager<com.microsoft.azure.management.network.implementation.NetworkManager>, HasName, HasResourceGroup, Indexable, Refreshable<VirtualNetworkGateway>, Resource, Updatable<VirtualNetworkGateway.Update>, UpdatableWithTags<VirtualNetworkGateway>

@Beta(value=V1_3_0)
public interface VirtualNetworkGateway
extends GroupableResource<com.microsoft.azure.management.network.implementation.NetworkManager,com.microsoft.azure.management.network.implementation.VirtualNetworkGatewayInner>, Refreshable<VirtualNetworkGateway>, Updatable<VirtualNetworkGateway.Update>, UpdatableWithTags<VirtualNetworkGateway>

Entry point for Virtual Network Gateway management API in Azure.

Nested Class Summary

Nested Classes

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

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

Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T>

Nested classes/interfaces inherited from interface com.microsoft.azure.management.network.model.UpdatableWithTags

UpdatableWithTags.UpdateWithTags<T>

Method Summary

Modifier and Type	Method and Description
boolean	activeActive()
BgpSettings	bgpSettings()
VirtualNetworkGatewayConnections	connections()
String	gatewayDefaultSiteResourceId()
VirtualNetworkGatewayType	gatewayType()
String	generateVpnProfile() Generates VPN profile for P2S client of the virtual network gateway in the specified resource group.
rx.Observable<String>	generateVpnProfileAsync() Generates asynchronously VPN profile for P2S client of the virtual network gateway in the specified resource group.
Collection<VirtualNetworkGatewayIPConfiguration>	ipConfigurations()
boolean	isBgpEnabled()
PagedList<VirtualNetworkGatewayConnection>	listConnections()
rx.Observable<VirtualNetworkGatewayConnection>	listConnectionsAsync() Get all the connections associated with this virtual network gateway asynchronously.
void	reset() Resets the primary of the virtual network gateway.
rx.Completable	resetAsync() Resets the primary of the virtual network gateway asynchronously.
VirtualNetworkGatewaySku	sku()
VpnClientConfiguration	vpnClientConfiguration()
VpnType	vpnType()

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

region, regionName, tags, type

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable

key

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

id

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

name

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

resourceGroupName

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

manager

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner

inner

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Refreshable

refresh, refreshAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Updatable

update

Methods inherited from interface com.microsoft.azure.management.network.model.UpdatableWithTags

updateTags

Method Detail

reset

void reset()

Resets the primary of the virtual network gateway.

resetAsync

rx.Completable resetAsync()

Resets the primary of the virtual network gateway asynchronously.

Returns:

a representation of the deferred computation of this call

listConnections

PagedList<VirtualNetworkGatewayConnection> listConnections()

Returns:

all the connections associated with this virtual network gateway

listConnectionsAsync

rx.Observable<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

rx.Observable<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

VirtualNetworkGatewayConnections connections()

Returns:

the entry point to virtual network gateway connections management API for this virtual network gateway

gatewayType

VirtualNetworkGatewayType gatewayType()

Returns:

the gatewayType value

vpnType

VpnType vpnType()

Returns:

the type of this virtual network gateway

isBgpEnabled

boolean isBgpEnabled()

Returns:

whether BGP is enabled for this virtual network gateway or not

activeActive

boolean activeActive()

Returns:

activeActive flag

gatewayDefaultSiteResourceId

String gatewayDefaultSiteResourceId()

Returns:

the resource id of the LocalNetworkGateway resource which represents local network site having default routes

sku

VirtualNetworkGatewaySku sku()

Returns:

the SKU of this virtual network gateway

vpnClientConfiguration

VpnClientConfiguration vpnClientConfiguration()

Returns:

the reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations

bgpSettings

BgpSettings bgpSettings()

Returns:

virtual network gateway's BGP speaker settings

ipConfigurations

Collection<VirtualNetworkGatewayIPConfiguration> ipConfigurations()

Returns:

IP configurations for virtual network gateway