NetworkPeering.UpdateStages.WithGatewayUse Interface

public static interface NetworkPeering.UpdateStages.WithGatewayUse

The stage of a network peering update allowing to control the gateway use by or on the remote network.

Method Summary

Modifier and Type Method and Description
abstract Update withGatewayUseByRemoteNetworkAllowed()

Allows the remote network to use this network's gateway (a.k.a.

abstract Update withGatewayUseByRemoteNetworkStarted()

Allows and starts the use of this network's gateway by the remote network (a.k.a.

abstract Update withGatewayUseOnRemoteNetworkStarted()

Starts the use of the remote network's gateway.

abstract Update withoutAnyGatewayUse()

Disables any gateway use by this network and the remote one.

abstract Update withoutGatewayUseByRemoteNetwork()

Stops and disallows the use of this network's gateway by the remote network.

abstract Update withoutGatewayUseOnRemoteNetwork()

Stops this network's use of the remote network's gateway.

Method Details

withGatewayUseByRemoteNetworkAllowed

public abstract NetworkPeering.Update withGatewayUseByRemoteNetworkAllowed()

Allows the remote network to use this network's gateway (a.k.a. gateway transit), but does not start the use of the gateway by the remote network.

If this network is currently configured to use the remote network's gateway, that use will be automatically disabled, as these two settings cannot be used together.

Returns:

the next stage of the update

withGatewayUseByRemoteNetworkStarted

public abstract NetworkPeering.Update withGatewayUseByRemoteNetworkStarted()

Allows and starts the use of this network's gateway by the remote network (a.k.a. gateway transit).

If the remote network is not in the same subscription as this network, then gateway use by the remote gateway will only be allowed on this network, but not started. The matching peering on the remote network must be modified explicitly to start it.

If this network is currently configured to use the remote network's gateway, that use will be automatically disabled, as these two settings cannot be used together.

Before gateway use by a remote network can be started, a working gateway must already be in place within this network.

Returns:

the next stage of the update

withGatewayUseOnRemoteNetworkStarted

public abstract NetworkPeering.Update withGatewayUseOnRemoteNetworkStarted()

Starts the use of the remote network's gateway.

If the remote network is in the same subscription, remote gateway use by this network (a.k.a. gateway transit) will also be automatically allowed on the remote network's side. Otherwise, this network will only be configured to use the remote gateway, but the matching peering on the remote network must still be additionally modified explicitly to allow gateway use by this network.

If this network is currently configured to allow the remote network to use its gateway, that use will be automatically disabled, as these two settings cannot be used together.

Before gateway use on a remote network can be started, a working gateway must already be in place within the remote network.

Returns:

the next stage of the update

withoutAnyGatewayUse

public abstract NetworkPeering.Update withoutAnyGatewayUse()

Disables any gateway use by this network and the remote one.

This will have effect on the remote network only if the remote network is in the same subscription as this network. Otherwise, only this network's use of the remote network's gateway will be stopped, but the use of this network's gateway by the remote network will only be disallowed. You will have to update the remote network's peering explicitly to properly stop its use of this network's gateway.

Returns:

the next stage of the update

withoutGatewayUseByRemoteNetwork

public abstract NetworkPeering.Update withoutGatewayUseByRemoteNetwork()

Stops and disallows the use of this network's gateway by the remote network.

If the remote network is not in the same subscription, then the use of that network's gateway by this network will be stopped but not disallowed by the remote network. The matching peering on the remote network must still be explicitly updated to also disallow such use.

Returns:

the next stage of the update

withoutGatewayUseOnRemoteNetwork

public abstract NetworkPeering.Update withoutGatewayUseOnRemoteNetwork()

Stops this network's use of the remote network's gateway.

Returns:

the next stage of the definition.

Applies to