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.sql;

import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating;
import com.microsoft.azure.management.resources.fluentcore.model.Creatable;

A representation of the Azure SQL Firewall rule operations.
/**
 * A representation of the Azure SQL Firewall rule operations.
 */
@Fluent
@Beta(Beta.SinceVersion.V1_7_0)
public interface SqlFirewallRuleOperations extends
    SupportsCreating<SqlFirewallRuleOperations.DefinitionStages.WithSqlServer>,
    SqlChildrenOperations<SqlFirewallRule> {

    
Container interface for all the definitions that need to be implemented.
/**
     * Container interface for all the definitions that need to be implemented.
     */
    interface SqlFirewallRuleOperationsDefinition extends
        SqlFirewallRuleOperations.DefinitionStages.WithSqlServer,
        SqlFirewallRuleOperations.DefinitionStages.WithIPAddressRange,
        SqlFirewallRuleOperations.DefinitionStages.WithCreate {
    }

    
Grouping of all the SQL Firewall rule definition stages.
/**
     * Grouping of all the SQL Firewall rule definition stages.
     */
    interface DefinitionStages {
        
The first stage of the SQL Server Firewall rule definition.
/**
         * The first stage of the SQL Server Firewall rule definition.
         */
        interface WithSqlServer {
            
Sets the parent SQL server name and resource group it belongs to.
Params:
resourceGroupName – the name of the resource group the parent SQL server
sqlServerName –     the parent SQL server name
Returns:
The next stage of the definition./**
             * Sets the parent SQL server name and resource group it belongs to.
             *
             * @param resourceGroupName the name of the resource group the parent SQL server
             * @param sqlServerName     the parent SQL server name
             * @return The next stage of the definition.
             */
            WithIPAddressRange withExistingSqlServer(String resourceGroupName, String sqlServerName);

            
Sets the parent SQL server for the new Firewall rule.
Params:
sqlServerId – the parent SQL server ID
Returns:
The next stage of the definition./**
             * Sets the parent SQL server for the new Firewall rule.
             *
             * @param sqlServerId the parent SQL server ID
             * @return The next stage of the definition.
             */
            WithIPAddressRange withExistingSqlServerId(String sqlServerId);

            
Sets the parent SQL server for the new Firewall rule.
Params:
sqlServer – the parent SQL server
Returns:
The next stage of the definition./**
             * Sets the parent SQL server for the new Firewall rule.
             *
             * @param sqlServer the parent SQL server
             * @return The next stage of the definition.
             */
            WithIPAddressRange withExistingSqlServer(SqlServer sqlServer);
        }

        
The SQL Firewall Rule definition to set the IP address range for the parent SQL Server.
/**
         * The SQL Firewall Rule definition to set the IP address range for the parent SQL Server.
         */
        interface WithIPAddressRange {
            
Sets the starting IP address of SQL server's firewall rule.
Params:
startIPAddress – starting IP address in IPv4 format.
endIPAddress –   starting IP address in IPv4 format.
Returns:
The next stage of the definition./**
             * Sets the starting IP address of SQL server's firewall rule.
             *
             * @param startIPAddress starting IP address in IPv4 format.
             * @param endIPAddress   starting IP address in IPv4 format.
             * @return The next stage of the definition.
             */
            WithCreate withIPAddressRange(String startIPAddress, String endIPAddress);

            
Sets the ending IP address of SQL server's firewall rule.
Params:
ipAddress – IP address in IPv4 format.
Returns:
The next stage of the definition./**
             * Sets the ending IP address of SQL server's firewall rule.
             *
             * @param ipAddress IP address in IPv4 format.
             * @return The next stage of the definition.
             */
            WithCreate withIPAddress(String ipAddress);
        }

        
The final stage of the SQL Firewall Rule definition.
/**
         * The final stage of the SQL Firewall Rule definition.
         */
        interface WithCreate extends Creatable<SqlFirewallRule> {
        }
    }

    
Grouping of the Azure SQL Server Firewall Rule common actions.
/**
     * Grouping of the Azure SQL Server Firewall Rule common actions.
     */
    interface SqlFirewallRuleActionsDefinition extends SqlChildrenActionsDefinition<SqlFirewallRule> {
        
Begins the definition of a new SQL Firewall rule to be added to this server.
Params:
firewallRuleName – the name of the new SQL Firewall rule
Returns:
the first stage of the new SQL Firewall rule definition/**
         * Begins the definition of a new SQL Firewall rule to be added to this server.
         *
         * @param firewallRuleName the name of the new SQL Firewall rule
         * @return the first stage of the new SQL Firewall rule definition
         */
        SqlFirewallRuleOperations.DefinitionStages.WithIPAddressRange define(String firewallRuleName);
    }
}