SqlServer Interface

Package:

com.microsoft.azure.management.sql

public interface SqlServer extends GroupableResource<SqlServerManager, ServerInner>,Refreshable,Updatable<SqlServer.Update>,GroupableResource<SqlServerManager, ServerInner>,Refreshable,Updatable<SqlServer.Update>

An immutable client-side representation of an Azure SQL Server.

Method Summary

Modifier and Type	Method and Description
String	administratorLogin()
SqlDatabaseOperations.SqlDatabaseActionsDefinition	databases()
SqlServerDnsAliasOperations.SqlServerDnsAliasActionsDefinition	dnsAliases()
SqlElasticPoolOperations.SqlElasticPoolActionsDefinition	elasticPools()
SqlFirewallRule	enableAccessFromAzureServices() Sets the Azure services default access to this server to true. A firewall rule named "AllowAllWindowsAzureIps" with the start IP "0.0.0.0" will be added to the SQL server if one does not exist.
SqlEncryptionProtectorOperations.SqlEncryptionProtectorActionsDefinition	encryptionProtectors()
SqlFailoverGroupOperations.SqlFailoverGroupActionsDefinition	failoverGroups()
SqlFirewallRuleOperations.SqlFirewallRuleActionsDefinition	firewallRules()
String	fullyQualifiedDomainName()
SqlActiveDirectoryAdministrator	getActiveDirectoryAdministrator() Gets the Active Directory administrator for this server.
SqlServerAutomaticTuning	getServerAutomaticTuning() Gets a SQL server automatic tuning state and options.
ServiceObjective	getServiceObjective(String serviceObjectiveName) Gets the information on a particular Sql Server Service Objective.
boolean	isManagedServiceIdentityEnabled()
String	kind()
Map<String, RecommendedElasticPool>	listRecommendedElasticPools() Returns all the recommended elastic pools for the server.
List<SqlRestorableDroppedDatabase>	listRestorableDroppedDatabases()
Observable<SqlRestorableDroppedDatabase>	listRestorableDroppedDatabasesAsync()
List<ServiceObjective>	listServiceObjectives()
List<ServerMetric>	listUsageMetrics()
List<ServerMetric>	listUsages()
IdentityType	managedServiceIdentityType()
void	removeAccessFromAzureServices() Sets the Azure services default access to this server to false. The firewall rule named "AllowAllWindowsAzureIps" will be removed from the SQL server.
void	removeActiveDirectoryAdministrator() Removes the Active Directory administrator from this server.
SqlServerKeyOperations.SqlServerKeyActionsDefinition	serverKeys()
SqlServerSecurityAlertPolicyOperations.SqlServerSecurityAlertPolicyActionsDefinition	serverSecurityAlertPolicies()
SqlActiveDirectoryAdministrator	setActiveDirectoryAdministrator(String userLogin, String id) Sets an Active Directory administrator to this server. Azure Active Directory authentication allows you to centrally manage identity and access to your Azure SQL Database V12.
String	state()
String	systemAssignedManagedServiceIdentityPrincipalId()
String	systemAssignedManagedServiceIdentityTenantId()
String	version()
SqlVirtualNetworkRuleOperations.SqlVirtualNetworkRuleActionsDefinition	virtualNetworkRules()

Inherited Members

HasId.id() HasInner<T>.inner() Indexable.key() HasManager<ManagerT>.manager() HasName.name() Refreshable<T>.refresh() Refreshable<T>.refreshAsync() Resource.region() Resource.regionName() HasResourceGroup.resourceGroupName() Resource.tags() Resource.type() Updatable<T>.update()

Method Details

administratorLogin

public String administratorLogin()

Returns:

the administrator login user name for the SQL Server

databases

public SqlDatabaseOperations.SqlDatabaseActionsDefinition databases()

Returns:

entry point to manage Databases for this SQL server

dnsAliases

public SqlServerDnsAliasOperations.SqlServerDnsAliasActionsDefinition dnsAliases()

Returns:

the entry point to manage SQL Server DNS aliases for this server

elasticPools

public SqlElasticPoolOperations.SqlElasticPoolActionsDefinition elasticPools()

Returns:

the entry point to manage the SQL Elastic Pools for this server

enableAccessFromAzureServices

public SqlFirewallRule enableAccessFromAzureServices()

Sets the Azure services default access to this server to true.

A firewall rule named "AllowAllWindowsAzureIps" with the start IP "0.0.0.0" will be added to the SQL server if one does not exist.

Returns:

the SQL Firewall rule

encryptionProtectors

public SqlEncryptionProtectorOperations.SqlEncryptionProtectorActionsDefinition encryptionProtectors()

Returns:

the entry point to manage SQL Encryption Protector for this server

failoverGroups

public SqlFailoverGroupOperations.SqlFailoverGroupActionsDefinition failoverGroups()

Returns:

the entry point to manage SQL Failover Group for this server

firewallRules

public SqlFirewallRuleOperations.SqlFirewallRuleActionsDefinition firewallRules()

Returns:

the entry point to manage SQL Firewall rules for this server

fullyQualifiedDomainName

public String fullyQualifiedDomainName()

Returns:

fully qualified name of the SQL Server

getActiveDirectoryAdministrator

public SqlActiveDirectoryAdministrator getActiveDirectoryAdministrator()

Gets the Active Directory administrator for this server.

Returns:

a representation of a SQL Server Active Directory administrator object (null if one is not set)

getServerAutomaticTuning

public SqlServerAutomaticTuning getServerAutomaticTuning()

Gets a SQL server automatic tuning state and options.

Returns:

the SQL server automatic tuning state and options

getServiceObjective

public ServiceObjective getServiceObjective(String serviceObjectiveName)

Gets the information on a particular Sql Server Service Objective.

Parameters:

serviceObjectiveName - name of the service objective to be fetched

Returns:

information of the service objective

isManagedServiceIdentityEnabled

public boolean isManagedServiceIdentityEnabled()

Returns:

true if Managed Service Identity is enabled for the SQL server

kind

public String kind()

Returns:

the SQL Server "kind"

listRecommendedElasticPools

public Map listRecommendedElasticPools()

Returns all the recommended elastic pools for the server.

Returns:

list of recommended elastic pools for the server

listRestorableDroppedDatabases

public List listRestorableDroppedDatabases()

Returns:

the list of all restorable dropped databases

listRestorableDroppedDatabasesAsync

public Observable listRestorableDroppedDatabasesAsync()

Returns:

the list of all restorable dropped databases

listServiceObjectives

public List listServiceObjectives()

Returns:

the list of information on all service objectives

listUsageMetrics

public List listUsageMetrics()

Returns:

returns the list of usage metrics for an Azure SQL Server

listUsages

public List listUsages()

Returns:

returns the list of usages (ServerMetric) of Azure SQL Server

managedServiceIdentityType

public IdentityType managedServiceIdentityType()

Returns:

the type of Managed Service Identity used for the SQL server.

removeAccessFromAzureServices

public void removeAccessFromAzureServices()

Sets the Azure services default access to this server to false.

The firewall rule named "AllowAllWindowsAzureIps" will be removed from the SQL server.

removeActiveDirectoryAdministrator

public void removeActiveDirectoryAdministrator()

Removes the Active Directory administrator from this server.

serverKeys

public SqlServerKeyOperations.SqlServerKeyActionsDefinition serverKeys()

Returns:

the entry point to manage SQL Server Keys for this server

serverSecurityAlertPolicies

public SqlServerSecurityAlertPolicyOperations.SqlServerSecurityAlertPolicyActionsDefinition serverSecurityAlertPolicies()

Returns:

the entry point to manage SQL Server Security Alert Policy for this server

setActiveDirectoryAdministrator

public SqlActiveDirectoryAdministrator setActiveDirectoryAdministrator(String userLogin, String id)

Sets an Active Directory administrator to this server.

Azure Active Directory authentication allows you to centrally manage identity and access to your Azure SQL Database V12.

Parameters:

userLogin - the user or group login; it can be the name or the email address

id - the user or group unique ID

Returns:

a representation of a SQL Server Active Directory administrator object

state

public String state()

Returns:

the state of the server.

systemAssignedManagedServiceIdentityPrincipalId

public String systemAssignedManagedServiceIdentityPrincipalId()

Returns:

the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the SQL server.

systemAssignedManagedServiceIdentityTenantId

public String systemAssignedManagedServiceIdentityTenantId()

Returns:

the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the SQL server.

version

public String version()

Returns:

the SQL Server version

virtualNetworkRules

public SqlVirtualNetworkRuleOperations.SqlVirtualNetworkRuleActionsDefinition virtualNetworkRules()

Returns:

the entry point to manage SQL Virtual Network Rule for this server