com.microsoft.azure.management.network.LoadBalancerBackend Maven / Gradle / Ivy
Show all versions of azure-mgmt-network Show documentation
/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*/
package com.microsoft.azure.management.network;
import java.util.Collection;
import java.util.Set;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.network.implementation.BackendAddressPoolInner;
import com.microsoft.azure.management.network.model.HasBackendNics;
import com.microsoft.azure.management.network.model.HasLoadBalancingRules;
import com.microsoft.azure.management.network.model.HasNetworkInterfaces;
import com.microsoft.azure.management.resources.fluentcore.arm.models.ChildResource;
import com.microsoft.azure.management.resources.fluentcore.model.Attachable;
import com.microsoft.azure.management.resources.fluentcore.model.Settable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
/**
* A client-side representation of a load balancer backend address pool.
*/
@Fluent()
public interface LoadBalancerBackend extends
HasInner,
ChildResource,
HasLoadBalancingRules,
HasBackendNics {
/**
* @return a list of the resource IDs of the virtual machines associated with this backend
*/
Set getVirtualMachineIds();
/**
* Grouping of load balancer backend definition stages.
*/
interface DefinitionStages {
/**
* The first stage of a load balancer backend definition.
* @param the stage of the parent definition to return to after attaching this definition
*/
interface Blank extends WithAttach {
}
/**
* The stage of a load balancer backend definition allowing to select a set of virtual machines to load balance
* the network traffic among.
* @param the next stage of the definition
*/
interface WithVirtualMachine {
/**
* Adds the specified set of virtual machines, assuming they are from the same
* availability set, to this backend address pool.
*
* This will add references to the primary IP configurations of the primary network interfaces of
* the provided set of virtual machines.
*
* If the virtual machines are not in the same availability set, they will not be associated with this back end.
*
* Only those virtual machines will be associated with the load balancer that already have an existing
* network interface. Virtual machines without a network interface will be skipped.
* @param vms existing virtual machines
* @return the next stage of the definition
*/
WithAttach withExistingVirtualMachines(HasNetworkInterfaces...vms);
/**
* Adds the specified set of virtual machines, assuming they are from the same
* availability set, to this backend address pool.
*
* This will add references to the primary IP configurations of the primary network interfaces of
* the provided set of virtual machines.
*
* If the virtual machines are not in the same availability set, they will not be associated with this back end.
*
* Only those virtual machines will be associated with the load balancer that already have an existing
* network interface. Virtual machines without a network interface will be skipped.
* @param vms existing virtual machines
* @return the next stage of the definition
*/
WithAttach withExistingVirtualMachines(Collection vms);
}
/** The final stage of a load balancer backend definition.
*
* At this stage, any remaining optional settings can be specified, or the definition
* can be attached to the parent load balancer definition.
* @param the stage of the parent definition to return to after attaching this definition
*/
interface WithAttach extends
Attachable.InDefinition,
WithVirtualMachine {
}
}
/** The entirety of a load balancer backend definition.
* @param the stage of the parent definition to return to after attaching this definition
*/
interface Definition extends
DefinitionStages.Blank,
DefinitionStages.WithAttach {
}
/**
* Grouping of load balancer backend update stages.
*/
interface UpdateStages {
}
/**
* The entirety of a load balancer backend update as part of a load balancer update.
*/
interface Update extends
Settable {
}
/**
* Grouping of load balancer backend definition stages applicable as part of a load balancer update.
*/
interface UpdateDefinitionStages {
/**
* The first stage of a load balancer backend definition.
* @param the stage of the parent definition to return to after attaching this definition
*/
interface Blank extends WithAttach {
}
/**
* The stage of a load balancer backend definition allowing to select a set of virtual machines to load balance
* the network traffic among.
* @param the next stage of the definition
*/
interface WithVirtualMachine {
/**
* Adds the specified set of virtual machines, assuming they are from the same
* availability set, to this back end address pool.
*
* This will add references to the primary IP configurations of the primary network interfaces of
* the provided set of virtual machines.
*
* If the virtual machines are not in the same availability set, they will not be associated with this back end.
*
* Only those virtual machines will be associated with the load balancer that already have an existing
* network interface. Virtual machines without a network interface will be skipped.
* @param vms existing virtual machines
* @return the next stage of the definition
*/
WithAttach withExistingVirtualMachines(HasNetworkInterfaces...vms);
/**
* Adds the specified set of virtual machines, assuming they are from the same
* availability set, to this backend address pool.
*
* This will add references to the primary IP configurations of the primary network interfaces of
* the provided set of virtual machines.
*
* If the virtual machines are not in the same availability set, they will not be associated with this back end.
*
* Only those virtual machines will be associated with the load balancer that already have an existing
* network interface. Virtual machines without a network interface will be skipped.
* @param vms existing virtual machines
* @return the next stage of the definition
*/
WithAttach withExistingVirtualMachines(Collection vms);
}
/** The final stage of a load balancer backend definition.
*
* At this stage, any remaining optional settings can be specified, or the definition
* can be attached to the parent load balancer definition.
* @param the stage of the parent definition to return to after attaching this definition
*/
interface WithAttach extends
Attachable.InUpdate,
WithVirtualMachine {
}
}
/** The entirety of a load balancer backend definition as part of a load balancer update.
* @param the stage of the parent definition to return to after attaching this definition
*/
interface UpdateDefinition extends
UpdateDefinitionStages.Blank,
UpdateDefinitionStages.WithAttach {
}
}