com.microsoft.azure.management.network.ApplicationGatewayIPConfiguration Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of azure-mgmt-network Show documentation
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
There is a newer version: 1.41.4
Show newest version
/**
 * 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 com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.network.implementation.ApplicationGatewayIPConfigurationInner;
import com.microsoft.azure.management.resources.fluentcore.arm.models.ChildResource;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasSubnet;
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 IP configuration.
 */
@Fluent()
public interface ApplicationGatewayIPConfiguration extends
    HasInner,
    ChildResource {

    /**
     * @return the resource ID of the virtual network the application gateway is in
     */
    String networkId();

    /**
     * @return the name of the subnet the application gateway is in
     */
    String subnetName();

    /**
     * @return the subnet the application gateway is in
     * 
     * Note, this results in a separate call to Azure.
     */
    Subnet getSubnet();

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

        /**
         * The stage of an application gateway IP configuration definition allowing to specify the subnet the application gateway is on.
         * @param  the stage of the application gateway definition to return to after attaching this definition
         */
        interface WithSubnet extends HasSubnet.DefinitionStages.WithSubnet> {
            /**
             * Specifies an existing subnet the application gateway should be part of and get its private IP address from.
             * @param subnet an existing subnet
             * @return the next stage of the definition
             */
            WithAttach withExistingSubnet(Subnet subnet);

            /**
             * Specifies an existing subnet the application gateway should be part of and get its private IP address from.
             * @param network an existing virtual network
             * @param subnetName the name of a subnet within the selected network
             * @return the next stage of the definition
             */
            WithAttach withExistingSubnet(Network network, String subnetName);
        }

        /** The final stage of the application gateway IP configuration definition.
         * 

         * At this stage, any remaining optional settings can be specified, or the 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.InDefinition {
        }
    }

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

    /**
     * Grouping of application gateway IP configuration update stages.
     */
    interface UpdateStages {
        /**
         * The stage of an application gateway IP configuration update allowing to modify the subnet the application gateway is part of.
         */
        interface WithSubnet extends HasSubnet.UpdateStages.WithSubnet {
            /**
             * Specifies an existing subnet the application gateway should be part of and get its private IP address from.
             * @param subnet an existing subnet
             * @return the next stage of the update
             */
            Update withExistingSubnet(Subnet subnet);

            /**
             * Specifies an existing subnet the application gateway should be part of and get its private IP address from.
             * @param network an existing virtual network
             * @param subnetName the name of a subnet within the selected network
             * @return the next stage of the update
             */
            Update withExistingSubnet(Network network, String subnetName);
        }
    }

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

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

        /**
         * The stage of an application gateway IP configuration definition allowing to specify the subnet the application gateway is on.
         * @param  the parent type
         */
        interface WithSubnet extends HasSubnet.UpdateDefinitionStages.WithSubnet< WithAttach> {
            /**
             * Specifies an existing subnet the application gateway should be part of and get its private IP address from.
             * @param subnet an existing subnet
             * @return the next stage of the definition
             */
            WithAttach withExistingSubnet(Subnet subnet);

            /**
             * Specifies an existing subnet the application gateway should be part of and get its private IP address from.
             * @param network an existing virtual network
             * @param subnetName the name of a subnet within the selected network
             * @return the next stage of the definition
             */
            WithAttach withExistingSubnet(Network network, String subnetName);
        }

        /** The final stage of an application gateway IP configuration definition.
         * 
         * At this stage, any remaining optional settings can be specified, or the 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.InUpdate {
        }
    }

    /** The entirety of an application gateway IP configuration definition as part of an application gateway update.
     * @param  the parent type
     */
    interface UpdateDefinition extends
       UpdateDefinitionStages.Blank,
       UpdateDefinitionStages.WithSubnet,
       UpdateDefinitionStages.WithAttach {
    }
}