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 com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Beta.SinceVersion;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.apigeneration.Method;
import com.microsoft.azure.management.network.implementation.VirtualNetworkGatewayIPConfigurationInner;
import com.microsoft.azure.management.network.model.HasPublicIPAddress;
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.HasInner;
import com.microsoft.azure.management.resources.fluentcore.model.Settable;


A client-side representation of an virtual network gateway IP configuration.

/**
 * A client-side representation of an virtual network gateway IP configuration.
 */
@Fluent
@Beta(SinceVersion.V1_3_0)
public interface VirtualNetworkGatewayIPConfiguration extends
        HasInner<VirtualNetworkGatewayIPConfigurationInner>,
        ChildResource<VirtualNetworkGateway> {
    
Returns:the resource ID of the virtual network the application gateway is in
/**
     * @return the resource ID of the virtual network the application gateway is in
     */
    String networkId();

    
Returns:the resource id of associated public IP address
/**
     * @return the resource id of associated public IP address
     */
    String publicIPAddressId();

    
Returns:the name of the subnet the virtual network gateway is in
/**
     * @return the name of the subnet the virtual network gateway is in
     */
    String subnetName();

    
Returns:the private IP allocation method. Possible values are: 'Static' and
'Dynamic'.
/**
     * @return the private IP allocation method. Possible values are: 'Static' and
     * 'Dynamic'.
     */
    IPAllocationMethod privateIPAllocationMethod();

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

    
Grouping of virtual network gateway IP configuration definition stages.

/**
     * Grouping of virtual network gateway IP configuration definition stages.
     */
    interface DefinitionStages {
        
The first stage of an virtual network gateway IP configuration definition.

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

        
The stage of virtual network gateway IP configuration definition allowing to specify the subnet the virtual network gateway is on.

Type parameters:
  • <ParentT> – the stage of the virtual network gateway definition to return to after attaching this definition
/**
         * The stage of virtual network gateway IP configuration definition allowing to specify the subnet the virtual network gateway is on.
         * @param <ParentT> the stage of the virtual network gateway definition to return to after attaching this definition
         */
        interface WithSubnet<ParentT> extends HasSubnet.DefinitionStages.WithSubnet<WithAttach<ParentT>> {
            
Specifies an existing subnet the virtual network gateway should be part of and get its private IP address from.

Params:
  • subnet – an existing subnet
Returns:the next stage of the definition
/**
             * Specifies an existing subnet the virtual network 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<ParentT> withExistingSubnet(Subnet subnet);

            
Specifies an existing subnet the virtual network gateway should be part of and get its private IP address from.

Params:
  • network – an existing virtual network
  • subnetName – the name of a subnet within the selected network
Returns:the next stage of the definition
/**
             * Specifies an existing subnet the virtual network 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<ParentT> withExistingSubnet(Network network, String subnetName);
        }

        
The stage of virtual network gateway frontend definition allowing to specify an existing public IP address to make
the virtual network gateway available at as Internet-facing.

Type parameters:
  • <ParentT> – the stage of the parent virtual network gateway definition to return to after attaching this definition
/**
         * The stage of virtual network gateway frontend definition allowing to specify an existing public IP address to make
         * the virtual network gateway available at as Internet-facing.
         * @param <ParentT> the stage of the parent virtual network gateway definition to return to after attaching this definition
         */
        interface WithPublicIPAddress<ParentT> extends HasPublicIPAddress.DefinitionStages.WithExistingPublicIPAddress<WithAttach<ParentT>> {
        }

        
The final stage of the virtual network gateway IP configuration definition.


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

Type parameters:
  • <ParentT> – the stage of the parent application gateway definition to return to after attaching this definition
/** The final stage of the virtual network gateway IP configuration definition.
         * <p>
         * At this stage, any remaining optional settings can be specified, or the definition
         * can be attached to the parent virtual network 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> {
        }
    }

    
The entirety of virtual network gateway IP configuration definition.

Type parameters:
  • <ParentT> – the stage of the parent application gateway definition to return to after attaching this definition
/** The entirety of virtual network gateway IP configuration 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>,
            DefinitionStages.WithPublicIPAddress<ParentT> {
    }

    
Grouping of application gateway IP configuration update stages.

/**
     * Grouping of application gateway IP configuration update stages.
     */
    interface UpdateStages {
    }

    
The entirety of an application gateway IP configuration update as part of a virtual network gateway update.

/**
     * The entirety of an application gateway IP configuration update as part of a virtual network gateway update.
     */
    interface Update extends
            Settable<VirtualNetworkGateway.Update> {
    }

    
Grouping of application gateway IP configuration definition stages applicable as part of a virtual network gateway update.

/**
     * Grouping of application gateway IP configuration definition stages applicable as part of a virtual network gateway update.
     */
    interface UpdateDefinitionStages {
        
The first stage of a virtual network gateway IP configuration definition.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
         * The first stage of a virtual network gateway IP configuration definition.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface Blank<ParentT> {
        }

        
The final stage of a virtual network 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.

Type parameters:
  • <ParentT> – the stage of the parent application gateway definition to return to after attaching this definition
/** The final stage of a virtual network gateway IP configuration 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> {
        }
    }

    
The entirety of an application gateway IP configuration definition as part of a virtual network gateway update.

Type parameters:
  • <ParentT> – the parent type
/** The entirety of an application gateway IP configuration definition as part of a virtual network gateway update.
     * @param <ParentT> the parent type
     */
    interface UpdateDefinition<ParentT> extends
            UpdateDefinitionStages.Blank<ParentT>,
            UpdateDefinitionStages.WithAttach<ParentT> {
    }
}