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.Fluent;
import com.microsoft.azure.management.network.implementation.ExpressRouteCircuitInner;
import com.microsoft.azure.management.network.implementation.NetworkManager;
import com.microsoft.azure.management.network.model.UpdatableWithTags;
import com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource;
import com.microsoft.azure.management.resources.fluentcore.arm.models.Resource;
import com.microsoft.azure.management.resources.fluentcore.model.Appliable;
import com.microsoft.azure.management.resources.fluentcore.model.Creatable;
import com.microsoft.azure.management.resources.fluentcore.model.Refreshable;
import com.microsoft.azure.management.resources.fluentcore.model.Updatable;

import java.util.Map;

Entry point for Express Route Circuit management API in Azure.
/**
 * Entry point for Express Route Circuit management API in Azure.
 */
@Fluent
@Beta(Beta.SinceVersion.V1_4_0)
public interface ExpressRouteCircuit extends
        GroupableResource<NetworkManager, ExpressRouteCircuitInner>,
        Refreshable<ExpressRouteCircuit>,
        Updatable<ExpressRouteCircuit.Update>,
        UpdatableWithTags<ExpressRouteCircuit> {

    // Actions

    
Returns:
entry point to manage express route peerings associated with express route circuit/**
     * @return entry point to manage express route peerings associated with express route circuit
     */
    ExpressRouteCircuitPeerings peerings();

    // Getters

    
Returns:
the SKU type/**
     * @return the SKU type
     */
    ExpressRouteCircuitSkuType sku();

    
Returns:
the flag indicating if classic operations allowed/**
     * @return the flag indicating if classic operations allowed
     */
    boolean isAllowClassicOperations();

    
Returns:
the CircuitProvisioningState state of the resource/**
     * @return the CircuitProvisioningState state of the resource
     */
    String circuitProvisioningState();

    
The ServiceProviderProvisioningState state of the resource.
Returns:
serviceProviderProvisioningState/**
     * The ServiceProviderProvisioningState state of the resource.
     * @return serviceProviderProvisioningState
     */
    ServiceProviderProvisioningState serviceProviderProvisioningState();

    
Returns:
the peerings associated with this express route circuit, indexed by name/**
     * @return the peerings associated with this express route circuit, indexed by name
     */
    Map<String, ExpressRouteCircuitPeering> peeringsMap();

    
Returns:
the ServiceKey/**
     * @return the ServiceKey
     */
    String serviceKey();

    
Returns:
the ServiceProviderNotes/**
     * @return the ServiceProviderNotes
     */
    String serviceProviderNotes();

    
Returns:
the ServiceProviderProperties/**
     * @return the ServiceProviderProperties
     */
    ExpressRouteCircuitServiceProviderProperties serviceProviderProperties();

    
Gets the provisioning state of the express route circuit resource.
Returns:
provisioningState/**
     * Gets the provisioning state of the express route circuit resource.
     * @return provisioningState
     */
    ProvisioningState provisioningState();

    
The entirety of the express route circuit definition.
/**
     * The entirety of the express route circuit definition.
     */
    interface Definition extends
            DefinitionStages.Blank,
            DefinitionStages.WithGroup,
            DefinitionStages.WithServiceProvider,
            DefinitionStages.WithPeeringLocation,
            DefinitionStages.WithBandwidth,
            DefinitionStages.WithSku,
            DefinitionStages.WithCreate {
    }

    
Grouping of express route circuit definition stages.
/**
     * Grouping of express route circuit definition stages.
     */
    interface DefinitionStages {
        
The first stage of express route circuit definition.
/**
         * The first stage of express route circuit definition.
         */
        interface Blank extends GroupableResource.DefinitionWithRegion<WithGroup> {
        }

        
The stage of express route circuit definition allowing to specify the resource group.
/**
         * The stage of express route circuit definition allowing to specify the resource group.
         */
        interface WithGroup
                extends GroupableResource.DefinitionStages.WithGroup<DefinitionStages.WithServiceProvider> {
        }

        
The stage of express route circuit definition allowing to specify service provider name.
/**
         * The stage of express route circuit definition allowing to specify service provider name.
         */
        interface WithServiceProvider {
            WithPeeringLocation withServiceProvider(String serviceProviderName);
        }

        
The stage of express route circuit definition allowing to specify service provider peering location.
/**
         * The stage of express route circuit definition allowing to specify service provider peering location.
         */
        interface WithPeeringLocation {
            WithBandwidth withPeeringLocation(String location);
        }

        
The stage of express route circuit definition allowing to specify service provider bandwidth.
/**
         * The stage of express route circuit definition allowing to specify service provider bandwidth.
         */
        interface WithBandwidth {
            WithSku withBandwidthInMbps(int bandwidthInMbps);
        }

        
The stage of express route circuit definition allowing to specify SKU tier and family.
/**
         * The stage of express route circuit definition allowing to specify SKU tier and family.
         */
        interface WithSku {
            WithCreate withSku(ExpressRouteCircuitSkuType skuType);
        }

        
The stage of express route circuit definition allowing to enable/disable classic operations.
/**
         * The stage of express route circuit definition allowing to enable/disable classic operations.
         */
        interface WithAllowClassicOperations {
            WithCreate withClassicOperations();
        }

        
The stage of definition allowing to add authorization.
/**
         * The stage of definition allowing to add authorization.
         */
        interface WithAuthorization {
            WithCreate withAuthorization(String authorizationName);
        }

        
The stage of the express route circuit definition which contains all the minimum required inputs for
the resource to be created, but also allows
for any other optional settings to be specified.
/**
         * The stage of the express route circuit definition which contains all the minimum required inputs for
         * the resource to be created, but also allows
         * for any other optional settings to be specified.
         */
        interface WithCreate extends
                Creatable<ExpressRouteCircuit>,
                Resource.DefinitionWithTags<WithCreate>,
                WithAllowClassicOperations,
                WithAuthorization {
        }
    }

    
Grouping of express route circuit update stages.
/**
     * Grouping of express route circuit update stages.
     */
    interface UpdateStages {
        
The stage of express route circuit update allowing to specify service provider bandwidth.
/**
         * The stage of express route circuit update allowing to specify service provider bandwidth.
         */
        interface WithBandwidth {
            Update withBandwidthInMbps(int bandwidthInMbps);
        }

        
The stage of express route circuit update allowing to specify SKU tier and family.
/**
         * The stage of express route circuit update allowing to specify SKU tier and family.
         */
        interface WithSku {
            Update withSku(ExpressRouteCircuitSkuType sku);
        }

        
The stage of express route circuit update allowing to enable/disable classic operations.
/**
         * The stage of express route circuit update allowing to enable/disable classic operations.
         */
        interface WithAllowClassicOperations {
            Update withClassicOperations();

            Update withoutClassicOperations();
        }

        
The stage of express route circuit update allowing to add authorization.
/**
         * The stage of express route circuit update allowing to add authorization.
         */
        interface WithAuthorization {
            Update withAuthorization(String authorizationName);
        }
    }

    
The template for a express route circuit update operation, containing all the settings that
can be modified.
/**
     * The template for a express route circuit update operation, containing all the settings that
     * can be modified.
     */
    interface Update extends
            Appliable<ExpressRouteCircuit>,
            Resource.UpdateWithTags<Update>,
            UpdateStages.WithBandwidth,
            UpdateStages.WithSku,
            UpdateStages.WithAllowClassicOperations,
            UpdateStages.WithAuthorization {
    }
}