com.microsoft.azure/azure-mgmt-network/1.41.0 : com/microsoft/azure/management/network/LoadBalancerBackend.java

LoadBalancerBackend
https://github.com/Azure/azure-sdk-for-java: This package contains Microsoft Azure Network Management SDK. A new set of management libraries are now Generally Available. For documentation on how to use the new libraries, please see https://aka.ms/azsdk/java/mgmt
The MIT License (MIT)
Microsoft
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.
/**
 * 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.
/**
 * A client-side representation of a load balancer backend address pool.
 */
@Fluent()
public interface LoadBalancerBackend extends
    HasInner<BackendAddressPoolInner>,
    ChildResource<LoadBalancer>,
    HasLoadBalancingRules,
    HasBackendNics {

    Returns: a list of the resource IDs of the virtual machines associated with this backend/**
     * @return a list of the resource IDs of the virtual machines associated with this backend
     */
    Set<String> getVirtualMachineIds();

    Grouping of load balancer backend definition stages.
/**
     * Grouping of load balancer backend definition stages.
     */
    interface DefinitionStages {
        The first stage of a load balancer backend definition.
Type parameters: <ParentT> – the stage of the parent definition to return to after attaching this definition/**
         * The first stage of a load balancer backend definition.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface Blank<ParentT> extends WithAttach<ParentT> {
        }

        The stage of a load balancer backend definition allowing to select a set of virtual machines to load balance
the network traffic among.
Type parameters: <ReturnT> – the next stage of the definition/**
         * The stage of a load balancer backend definition allowing to select a set of virtual machines to load balance
         * the network traffic among.
         * @param <ReturnT> the next stage of the definition
         */
        interface WithVirtualMachine<ReturnT> {
            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.
Params: vms – existing virtual machines
Returns: the next stage of the definition/**
             * Adds the specified set of virtual machines, assuming they are from the same
             * availability set, to this backend address pool.
             * <p>
             * This will add references to the primary IP configurations of the primary network interfaces of
             * the provided set of virtual machines.
             * <p>
             * If the virtual machines are not in the same availability set, they will not be associated with this back end.
             * <p>
             * 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<ReturnT> 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.
Params: vms – existing virtual machines
Returns: the next stage of the definition/**
             * Adds the specified set of virtual machines, assuming they are from the same
             * availability set, to this backend address pool.
             * <p>
             * This will add references to the primary IP configurations of the primary network interfaces of
             * the provided set of virtual machines.
             * <p>
             * If the virtual machines are not in the same availability set, they will not be associated with this back end.
             * <p>
             * 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<ReturnT> withExistingVirtualMachines(Collection<HasNetworkInterfaces> 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.
Type parameters: <ParentT> – the stage of the parent definition to return to after attaching this definition/** The final stage of a load balancer backend definition.
         * <p>
         * At this stage, any remaining optional settings can be specified, or the definition
         * can be attached to the parent load balancer definition.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface WithAttach<ParentT> extends
            Attachable.InDefinition<ParentT>,
            WithVirtualMachine<ParentT> {
        }
    }

    The entirety of a load balancer backend definition.
Type parameters: <ParentT> – the stage of the parent definition to return to after attaching this definition/** The entirety of a load balancer backend definition.
     * @param <ParentT> the stage of the parent definition to return to after attaching this definition
     */
    interface Definition<ParentT> extends
        DefinitionStages.Blank<ParentT>,
        DefinitionStages.WithAttach<ParentT> {
    }

    Grouping of load balancer backend update stages.
/**
     * Grouping of load balancer backend update stages.
     */
    interface UpdateStages {
    }

    The entirety of a load balancer backend update as part of a load balancer update.
/**
     * The entirety of a load balancer backend update as part of a load balancer update.
     */
    interface Update extends
        Settable<LoadBalancer.Update> {
    }

    Grouping of load balancer backend definition stages applicable as part of a load balancer update.
/**
     * 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.
Type parameters: <ParentT> – the stage of the parent definition to return to after attaching this definition/**
         * The first stage of a load balancer backend definition.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface Blank<ParentT> extends WithAttach<ParentT> {
        }

        The stage of a load balancer backend definition allowing to select a set of virtual machines to load balance
the network traffic among.
Type parameters: <ReturnT> – the next stage of the definition/**
         * The stage of a load balancer backend definition allowing to select a set of virtual machines to load balance
         * the network traffic among.
         * @param <ReturnT> the next stage of the definition
         */
        interface WithVirtualMachine<ReturnT> {
            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.
Params: vms – existing virtual machines
Returns: the next stage of the definition/**
             * Adds the specified set of virtual machines, assuming they are from the same
             * availability set, to this back end address pool.
             * <p>
             * This will add references to the primary IP configurations of the primary network interfaces of
             * the provided set of virtual machines.
             * <p>
             * If the virtual machines are not in the same availability set, they will not be associated with this back end.
             * <p>
             * 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<ReturnT> 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.
Params: vms – existing virtual machines
Returns: the next stage of the definition/**
             * Adds the specified set of virtual machines, assuming they are from the same
             * availability set, to this backend address pool.
             * <p>
             * This will add references to the primary IP configurations of the primary network interfaces of
             * the provided set of virtual machines.
             * <p>
             * If the virtual machines are not in the same availability set, they will not be associated with this back end.
             * <p>
             * 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<ReturnT> withExistingVirtualMachines(Collection<HasNetworkInterfaces> 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.
Type parameters: <ParentT> – the stage of the parent definition to return to after attaching this definition/** The final stage of a load balancer backend definition.
         * <p>
         * At this stage, any remaining optional settings can be specified, or the definition
         * can be attached to the parent load balancer definition.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface WithAttach<ParentT> extends
            Attachable.InUpdate<ParentT>,
            WithVirtualMachine<ParentT> {
        }
    }

    The entirety of a load balancer backend definition as part of a load balancer update.
Type parameters: <ParentT> – the stage of the parent definition to return to after attaching this definition/** The entirety of a load balancer backend definition as part of a load balancer update.
     * @param <ParentT> the stage of the parent definition to return to after attaching this definition
     */
    interface UpdateDefinition<ParentT> extends
        UpdateDefinitionStages.Blank<ParentT>,
        UpdateDefinitionStages.WithAttach<ParentT> {
    }
}
Params:	vms – existing virtual machines
Returns:	the next stage of the definition
/

com.microsoft.azure/ azure-mgmt-network/ 1.41.0/ com/microsoft/azure/management/network/LoadBalancerBackend.java
