com.azure.resourcemanager.network.models.ApplicationGatewayFrontend Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-network Show documentation
This package contains Microsoft Azure Network Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt
There is a newer version: 2.44.0
Show newest version
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.resourcemanager.network.models;

import com.azure.core.annotation.Fluent;
import com.azure.resourcemanager.resources.fluentcore.arm.models.ChildResource;
import com.azure.resourcemanager.resources.fluentcore.arm.models.HasSubnet;
import com.azure.resourcemanager.resources.fluentcore.model.Attachable;
import com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel;
import com.azure.resourcemanager.resources.fluentcore.model.Settable;

/** A client-side representation of an application gateway frontend. */
@Fluent()
public interface ApplicationGatewayFrontend
    extends HasInnerModel,
        ChildResource,
        HasPrivateIpAddress,
        HasSubnet,
        HasPublicIpAddress {

    /** @return true if the frontend is accessible via a public IP address, else false */
    boolean isPublic();

    /** @return true is the frontend is accessible via an private IP address */
    boolean isPrivate();

    /** @return the associated subnet */
    Subnet getSubnet();

    /** Grouping of application gateway frontend definition stages. */
    interface DefinitionStages {
        /**
         * The first stage of an application gateway frontend definition.
         *
         * @param  the stage of the parent application gateway definition to return to after attaching this
         *     definition
         */
        interface Blank extends WithSubnet {
        }

        /**
         * The stage of an application gateway frontend definition allowing to specify a subnet from the selected
         * network to make this application gateway visible to.
         *
         * @param  the stage of the parent application gateway definition to return to after attaching this
         *     definition
         */
        interface WithSubnet extends HasSubnet.DefinitionStages.WithSubnet> {
            /**
             * Assigns the specified subnet to this private frontend.
             *
             * @param network the virtual network the subnet exists in
             * @param subnetName the name of a subnet
             * @return the next stage of the definition
             */
            WithAttach withExistingSubnet(Network network, String subnetName);
        }

        /**
         * The stage of an application gateway frontend definition allowing to specify the private IP address this
         * application gateway should be available at within the selected subnet.
         *
         * @param  the stage of the parent application gateway definition to return to after attaching this
         *     definition
         */
        interface WithPrivateIP
            extends HasPrivateIpAddress.DefinitionStages.WithPrivateIPAddress> {
        }

        /**
         * The stage of an application gateway frontend definition allowing to specify an existing public IP address to
         * make the application gateway available at as Internet-facing.
         *
         * @param  the stage of the parent application gateway definition to return to after attaching this
         *     definition
         */
        interface WithPublicIPAddress
            extends HasPublicIpAddress.DefinitionStages.WithExistingPublicIPAddress> {
        }

        /**
         * The final stage of an application gateway frontend definition.
         *
         * At this stage, any remaining optional settings can be specified, or the frontend definition can be
         * attached to the parent application gateway definition.
         *
         * @param  the stage of the parent application gateway definition to return to after attaching this
         *     definition
         */
        interface WithAttach
            extends Attachable.InDefinitionAlt, WithSubnet, WithPrivateIP {
        }
    }

    /**
     * The entirety of an application gateway frontend definition.
     *
     * @param  the stage of the parent application gateway definition to return to after attaching this
     *     definition
     */
    interface Definition
        extends DefinitionStages.Blank,
            DefinitionStages.WithAttach,
            DefinitionStages.WithPublicIPAddress {
    }

    /** Grouping of application gateway frontend update stages. */
    interface UpdateStages {
        /**
         * The stage of an application gateway frontend definition allowing to specify an existing public IP address to
         * make the application gateway available at as Internet-facing.
         */
        interface WithPublicIPAddress extends HasPublicIpAddress.UpdateStages.WithExistingPublicIPAddress {
        }
    }

    /** The entirety of an application gateway frontend update as part of an application gateway update. */
    interface Update extends Settable, UpdateStages.WithPublicIPAddress {
    }

    /**
     * Grouping of application gateway frontend definition stages applicable as part of an application gateway update.
     */
    interface UpdateDefinitionStages {
        /**
         * The first stage of an application gateway frontend definition.
         *
         * @param  the stage of the parent application gateway definition to return to after attaching this
         *     definition
         */
        interface Blank extends WithSubnet {
        }

        /**
         * The stage of an application gateway frontend definition allowing to specify an existing public IP address to
         * make the application gateway available at as Internet-facing.
         *
         * @param  the stage of the parent definition to return to after attaching this definition
         */
        interface WithPublicIPAddress
            extends HasPublicIpAddress.UpdateDefinitionStages.WithExistingPublicIPAddress> {
        }

        /**
         * The stage of an application gateway frontend definition allowing to specify a subnet from the selected
         * network to make this application gateway visible to.
         *
         * @param  the stage of the parent application gateway definition to return to after attaching this
         *     definition
         */
        interface WithSubnet extends HasSubnet.UpdateDefinitionStages.WithSubnet> {
            /**
             * Assigns the specified subnet to this private frontend.
             *
             * @param network the virtual network the subnet exists in
             * @param subnetName the name of a subnet
             * @return the next stage of the definition
             */
            WithAttach withExistingSubnet(Network network, String subnetName);
        }

        /**
         * The stage of an application gateway frontend definition allowing to specify the private IP address this
         * application gateway should be available at within the selected virtual network.
         *
         * @param  the stage of the parent application gateway definition to return to after attaching this
         *     definition
         */
        interface WithPrivateIP
            extends HasPrivateIpAddress.UpdateDefinitionStages.WithPrivateIPAddress> {
        }

        /**
         * The final stage of an application gateway frontend definition.
         *
         * At this stage, any remaining optional settings can be specified, or the frontend definition can be
         * attached to the parent application gateway definition.
         *
         * @param  the stage of the parent application gateway definition to return to after attaching this
         *     definition
         */
        interface WithAttach
            extends Attachable.InUpdateAlt,
                WithPublicIPAddress,
                WithSubnet,
                WithPrivateIP {
        }
    }

    /**
     * The entirety of an application gateway frontend definition as part of an application gateway update.
     *
     * @param  the stage of the parent application gateway definition to return to after attaching this
     *     definition
     */
    interface UpdateDefinition
        extends UpdateDefinitionStages.Blank, UpdateDefinitionStages.WithAttach {
    }
}