com.microsoft.azure.management.sql.SqlVirtualNetworkRule Maven / Gradle / Ivy
Show all versions of azure-mgmt-sql Show documentation
/**
* 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.apigeneration.Method;
import com.microsoft.azure.management.resources.fluentcore.arm.models.ExternalChildResource;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.model.Appliable;
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.Refreshable;
import com.microsoft.azure.management.resources.fluentcore.model.Updatable;
import com.microsoft.azure.management.sql.implementation.VirtualNetworkRuleInner;
import rx.Completable;
/**
* An immutable client-side representation of an Azure SQL Server Virtual Network Rule.
*/
@Fluent
@Beta(Beta.SinceVersion.V1_8_0)
public interface SqlVirtualNetworkRule
extends
ExternalChildResource,
HasInner,
HasResourceGroup,
Refreshable,
Updatable {
/**
* @return name of the SQL Server to which this Virtual Network Rule belongs
*/
String sqlServerName();
/**
* @return the subnet ID of the Azure SQL Server Virtual Network Rule.
*/
String subnetId();
/**
* @return the Azure SQL Server Virtual Network Rule state; possible values include: 'Initializing',
* 'InProgress', 'Ready', 'Deleting', 'Unknown'
*/
String state();
/**
* @return the parent SQL server ID
*/
String parentId();
/**
* Deletes the virtual network rule.
*/
@Method
void delete();
/**
* Deletes the virtual network rule asynchronously.
*
* @return a representation of the deferred computation of this call
*/
@Method
Completable deleteAsync();
/**************************************************************
* Fluent interfaces to provision a SQL Virtual Network Rule
**************************************************************/
/**
* Container interface for all the definitions that need to be implemented.
*
* @param the stage of the parent definition to return to after attaching this definition
*/
@Beta(Beta.SinceVersion.V1_8_0)
interface SqlVirtualNetworkRuleDefinition extends
SqlVirtualNetworkRule.DefinitionStages.Blank,
SqlVirtualNetworkRule.DefinitionStages.WithSubnet,
SqlVirtualNetworkRule.DefinitionStages.WithServiceEndpoint,
SqlVirtualNetworkRule.DefinitionStages.WithAttach {
}
/**
* Grouping of all the SQL Virtual Network Rule definition stages.
*/
@Beta(Beta.SinceVersion.V1_8_0)
interface DefinitionStages {
/**
* The first stage of the SQL Server Virtual Network Rule definition.
*
* @param the stage of the parent definition to return to after attaching this definition
*/
@Beta(Beta.SinceVersion.V1_8_0)
interface Blank extends
SqlVirtualNetworkRule.DefinitionStages.WithSubnet {
}
/**
* The SQL Virtual Network Rule definition to set the virtual network ID and the subnet name.
*/
@Beta(Beta.SinceVersion.V1_8_0)
interface WithSubnet {
/**
* Sets the virtual network ID and the subnet name for the SQL server Virtual Network Rule.
*
* @param networkId the virtual network ID to be used
* @param subnetName the name of the subnet within the virtual network to be used
* @return The next stage of the definition.
*/
SqlVirtualNetworkRule.DefinitionStages.WithServiceEndpoint withSubnet(String networkId, String subnetName);
}
/**
* The SQL Virtual Network Rule definition to set ignore flag for the missing subnet's SQL service endpoint entry.
*/
@Beta(Beta.SinceVersion.V1_8_0)
interface WithServiceEndpoint extends SqlVirtualNetworkRule.DefinitionStages.WithAttach {
/**
* Sets the flag to ignore the missing subnet's SQL service endpoint entry.
*
* Virtual Machines in the subnet will not be able to connect to the SQL server until Microsoft.Sql
* service endpoint is added to the subnet
*
* @return The next stage of the definition.
*/
SqlVirtualNetworkRule.DefinitionStages.WithAttach ignoreMissingSqlServiceEndpoint();
}
/** The final stage of the SQL Virtual Network Rule definition.
*
* At this stage, any remaining optional settings can be specified, or the SQL Virtual Network Rule definition
* can be attached to the parent SQL Server definition.
* @param the stage of the parent definition to return to after attaching this definition
*/
interface WithAttach extends
Attachable.InDefinition {
}
}
/**
* The template for a SQL Virtual Network Rule update operation, containing all the settings that can be modified.
*/
@Beta(Beta.SinceVersion.V1_8_0)
interface Update extends
SqlVirtualNetworkRule.UpdateStages.WithSubnet,
SqlVirtualNetworkRule.UpdateStages.WithServiceEndpoint,
Appliable {
}
/**
* Grouping of all the SQL Virtual Network Rule update stages.
*/
@Beta(Beta.SinceVersion.V1_8_0)
interface UpdateStages {
/**
* The SQL Virtual Network Rule definition to set the virtual network ID and the subnet name.
*/
@Beta(Beta.SinceVersion.V1_8_0)
interface WithSubnet {
/**
* Sets the virtual network ID and the subnet name for the SQL server Virtual Network Rule.
*
* @param networkId the virtual network ID to be used
* @param subnetName the name of the subnet within the virtual network to be used
* @return The next stage of the definition.
*/
SqlVirtualNetworkRule.Update withSubnet(String networkId, String subnetName);
}
/**
* The SQL Virtual Network Rule definition to set ignore flag for the missing subnet's SQL service endpoint entry.
*/
@Beta(Beta.SinceVersion.V1_8_0)
interface WithServiceEndpoint {
/**
* Sets the flag to ignore the missing subnet's SQL service endpoint entry.
*
* Virtual Machines in the subnet will not be able to connect to the SQL server until Microsoft.Sql
* service endpoint is added to the subnet
*
* @return The next stage of the definition.
*/
SqlVirtualNetworkRule.Update ignoreMissingSqlServiceEndpoint();
}
}
}