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
  • 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 com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.network.model.HasBackendNics;
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 an application gateway backend.

/**
 * A client-side representation of an application gateway backend.
 */
@Fluent()
public interface ApplicationGatewayBackend extends
    HasInner<ApplicationGatewayBackendAddressPool>,
    ChildResource<ApplicationGateway>,
    HasBackendNics {

    
Returns:addresses on the backend of the application gateway
/**
     * @return addresses on the backend of the application gateway
     */
    Collection<ApplicationGatewayBackendAddress> addresses();

    
Checks whether the specified IP address is referenced by this backend address pool.

Params:
  • ipAddress – an IP address
Returns:true if the specified IP address is referenced by this backend, else false
/**
     * Checks whether the specified IP address is referenced by this backend address pool.
     * @param ipAddress an IP address
     * @return true if the specified IP address is referenced by this backend, else false
     */
    boolean containsIPAddress(String ipAddress);

    
Checks whether the specified FQDN is referenced by this backend address pool.

Params:
  • fqdn – a fully qualified domain name (FQDN)
Returns:true if the specified FQDN is referenced by this backend, else false
/**
     * Checks whether the specified FQDN is referenced by this backend address pool.
     * @param fqdn a fully qualified domain name (FQDN)
     * @return true if the specified FQDN is referenced by this backend, else false
     */
    boolean containsFqdn(String fqdn);

    
Grouping of application gateway backend definition stages.

/**
     * Grouping of application gateway backend definition stages.
     */
    interface DefinitionStages {
        
The first stage of an application gateway backend definition.

Type parameters:
  • <ParentT> – the stage of the parent application gateway definition to return to after attaching this definition
/**
         * The first stage of an application gateway backend definition.
         * @param <ParentT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface Blank<ParentT> extends WithAttach<ParentT> {
        }

        
The stage of an application gateway backend definition allowing to add an address to the backend.

Type parameters:
  • <ParentT> – the stage of the parent application gateway definition to return to after attaching this definition
/**
         * The stage of an application gateway backend definition allowing to add an address to the backend.
         * @param <ParentT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface WithAddress<ParentT> {
            
Adds the specified existing IP address to the backend.


This call can be made in a sequence to add multiple IP addresses.

Params:
  • ipAddress – an IP address
Returns:the next stage of the definition
/**
             * Adds the specified existing IP address to the backend.
             * <p>
             * This call can be made in a sequence to add multiple IP addresses.
             * @param ipAddress an IP address
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withIPAddress(String ipAddress);

            
Adds the specified existing fully qualified domain name (FQDN) to the backend.


This call can be made in a sequence to add multiple FQDNs.

Params:
  • fqdn – a fully qualified domain name (FQDN)
Returns:the next stage of the definition
/**
             * Adds the specified existing fully qualified domain name (FQDN) to the backend.
             * <p>
             * This call can be made in a sequence to add multiple FQDNs.
             * @param fqdn a fully qualified domain name (FQDN)
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withFqdn(String fqdn);
        }

        
The final stage of an application gateway backend definition.


At this stage, any remaining optional settings can be specified, or the definition
can be attached to the parent application gateway definition.

Type parameters:
  • <ParentT> – the stage of the parent application gateway definition to return to after attaching this definition
/** The final stage of an application gateway backend definition.
         * <p>
         * At this stage, any remaining optional settings can be specified, or the definition
         * can be attached to the parent application gateway definition.
         * @param <ParentT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface WithAttach<ParentT> extends
            Attachable.InDefinition<ParentT>,
            WithAddress<ParentT> {
        }
    }

    
The entirety of an application gateway backend definition.

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

    
Grouping of application gateway backend update stages.

/**
     * Grouping of application gateway backend update stages.
     */
    interface UpdateStages {
        
The stage of an application gateway backend update allowing to add an address to the backend.

/**
         * The stage of an application gateway backend update allowing to add an address to the backend.
         */
        interface WithAddress {
            
Adds the specified existing IP address to the backend.

Params:
  • ipAddress – an IP address
Returns:the next stage of the update
/**
             * Adds the specified existing IP address to the backend.
             * @param ipAddress an IP address
             * @return the next stage of the update
             */
            Update withIPAddress(String ipAddress);

            
Adds the specified existing fully qualified domain name (FQDN) to the backend.

Params:
  • fqdn – a fully qualified domain name (FQDN)
Returns:the next stage of the update
/**
             * Adds the specified existing fully qualified domain name (FQDN) to the backend.
             * @param fqdn a fully qualified domain name (FQDN)
             * @return the next stage of the update
             */
            Update withFqdn(String fqdn);

            
Ensures the specified IP address is not associated with this backend.

Params:
  • ipAddress – an IP address
Returns:the next stage of the update
/**
             * Ensures the specified IP address is not associated with this backend.
             * @param ipAddress an IP address
             * @return the next stage of the update
             */
            Update withoutIPAddress(String ipAddress);

            
Ensure the specified address is not associated with this backend.

Params:
  • address – an existing address currently associated with the backend
Returns:the next stage of the update
/**
             * Ensure the specified address is not associated with this backend.
             * @param address an existing address currently associated with the backend
             * @return the next stage of the update
             */
            Update withoutAddress(ApplicationGatewayBackendAddress address);

            
Ensures the specified fully qualified domain name (FQDN) is not associated with this backend.

Params:
  • fqdn – a fully qualified domain name
Returns:the next stage of the update
/**
             * Ensures the specified fully qualified domain name (FQDN) is not associated with this backend.
             * @param fqdn a fully qualified domain name
             * @return the next stage of the update
             */
            Update withoutFqdn(String fqdn);
        }
    }

    
The entirety of an application gateway backend update as part of an application gateway update.

/**
     * The entirety of an application gateway backend update as part of an application gateway update.
     */
    interface Update extends
        Settable<ApplicationGateway.Update>,
        UpdateStages.WithAddress {
    }

    
Grouping of application gateway backend definition stages applicable as part of an application gateway update.

/**
     * Grouping of application gateway backend definition stages applicable as part of an application gateway update.
     */
    interface UpdateDefinitionStages {
        
The first stage of an application gateway backend definition.

Type parameters:
  • <ParentT> – the stage of the parent application gateway definition to return to after attaching this definition
/**
         * The first stage of an application gateway backend definition.
         * @param <ParentT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface Blank<ParentT> extends WithAttach<ParentT> {
        }

        
The stage of an application gateway backed definition allowing to add an address to the backend.

Type parameters:
  • <ParentT> – the stage of the parent application gateway definition to return to after attaching this definition
/**
         * The stage of an application gateway backed definition allowing to add an address to the backend.
         * @param <ParentT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface WithAddress<ParentT> {
            
Adds the specified existing IP address to the backend.

Params:
  • ipAddress – an IP address
Returns:the next stage of the definition
/**
             * Adds the specified existing IP address to the backend.
             * @param ipAddress an IP address
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withIPAddress(String ipAddress);

            
Adds the specified existing fully qualified domain name (FQDN) to the backend.

Params:
  • fqdn – a fully qualified domain name (FQDN)
Returns:the next stage of the definition
/**
             * Adds the specified existing fully qualified domain name (FQDN) to the backend.
             * @param fqdn a fully qualified domain name (FQDN)
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withFqdn(String fqdn);
        }

        
The final stage of an application gateway backend definition.


At this stage, any remaining optional settings can be specified, or the definition
can be attached to the parent application gateway definition.

Type parameters:
  • <ParentT> – the stage of the parent application gateway definition to return to after attaching this definition
/** The final stage of an application gateway backend definition.
         * <p>
         * At this stage, any remaining optional settings can be specified, or the definition
         * can be attached to the parent application gateway definition.
         * @param <ParentT> the stage of the parent application gateway definition to return to after attaching this definition
         */
        interface WithAttach<ParentT> extends
            Attachable.InUpdate<ParentT>,
            WithAddress<ParentT> {
        }
    }

    
The entirety of an application gateway backend definition as part of an application gateway update.

Type parameters:
  • <ParentT> – the stage of the parent application gateway definition to return to after attaching this definition
/** The entirety of an application gateway backend definition as part of an application gateway update.
     * @param <ParentT> the stage of the parent application gateway definition to return to after attaching this definition
     */
    interface UpdateDefinition<ParentT> extends
        UpdateDefinitionStages.Blank<ParentT>,
        UpdateDefinitionStages.WithAttach<ParentT> {
    }
}