SqlServer Interface

Package:

com.azure.resourcemanager.sql.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-sql:2.45.0

Implements

GroupableResource<SqlServerManager,ServerInner> Refreshable<SqlServer> Updatable<Update>

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

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

Method Summary

Modifier and Type	Method and Description
abstract String	administratorLogin()
abstract SqlDatabaseActionsDefinition	databases()
abstract SqlServerDnsAliasActionsDefinition	dnsAliases()
abstract SqlElasticPoolActionsDefinition	elasticPools()
abstract SqlFirewallRule	enableAccessFromAzureServices() Sets the Azure services default access to this server to true.
abstract SqlEncryptionProtectorActionsDefinition	encryptionProtectors()
abstract SqlFailoverGroupActionsDefinition	failoverGroups()
abstract SqlFirewallRuleActionsDefinition	firewallRules()
abstract String	fullyQualifiedDomainName()
abstract SqlActiveDirectoryAdministrator	getActiveDirectoryAdministrator() Gets the Active Directory administrator for this server.
abstract SqlServerAutomaticTuning	getServerAutomaticTuning() Gets a SQL server automatic tuning state and options.
abstract boolean	isManagedServiceIdentityEnabled()
abstract String	kind()
abstract List<SqlRestorableDroppedDatabase>	listRestorableDroppedDatabases()
abstract PagedFlux<SqlRestorableDroppedDatabase>	listRestorableDroppedDatabasesAsync()
abstract List<ServerMetric>	listUsageMetrics()
abstract IdentityType	managedServiceIdentityType()
abstract ServerNetworkAccessFlag	publicNetworkAccess() Whether the SQL Server can be accessed from public network.
abstract void	removeAccessFromAzureServices() Sets the Azure services default access to this server to false.
abstract void	removeActiveDirectoryAdministrator() Removes the Active Directory administrator from this server.
abstract SqlServerKeyActionsDefinition	serverKeys()
abstract SqlServerSecurityAlertPolicyActionsDefinition	serverSecurityAlertPolicies()
abstract SqlActiveDirectoryAdministrator	setActiveDirectoryAdministrator(String userLogin, String id) Sets an Active Directory administrator to this server.
abstract String	state()
abstract String	systemAssignedManagedServiceIdentityPrincipalId()
abstract String	systemAssignedManagedServiceIdentityTenantId()
abstract String	version()
abstract SqlVirtualNetworkRuleActionsDefinition	virtualNetworkRules()

Method Details

administratorLogin

public abstract String administratorLogin()

Returns:

the administrator login user name for the SQL Server

databases

public abstract SqlDatabaseOperations.SqlDatabaseActionsDefinition databases()

Returns:

entry point to manage Databases for this SQL server

dnsAliases

public abstract SqlServerDnsAliasOperations.SqlServerDnsAliasActionsDefinition dnsAliases()

Returns:

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

elasticPools

public abstract SqlElasticPoolOperations.SqlElasticPoolActionsDefinition elasticPools()

Returns:

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

enableAccessFromAzureServices

public abstract 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 abstract SqlEncryptionProtectorOperations.SqlEncryptionProtectorActionsDefinition encryptionProtectors()

Returns:

the entry point to manage SQL Encryption Protector for this server

failoverGroups

public abstract SqlFailoverGroupOperations.SqlFailoverGroupActionsDefinition failoverGroups()

Returns:

the entry point to manage SQL Failover Group for this server

firewallRules

public abstract SqlFirewallRuleOperations.SqlFirewallRuleActionsDefinition firewallRules()

Returns:

the entry point to manage SQL Firewall rules for this server

fullyQualifiedDomainName

public abstract String fullyQualifiedDomainName()

Returns:

fully qualified name of the SQL Server

getActiveDirectoryAdministrator

public abstract 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 abstract SqlServerAutomaticTuning getServerAutomaticTuning()

Gets a SQL server automatic tuning state and options.

Returns:

the SQL server automatic tuning state and options

isManagedServiceIdentityEnabled

public abstract boolean isManagedServiceIdentityEnabled()

Returns:

true if Managed Service Identity is enabled for the SQL server

kind

public abstract String kind()

Returns:

the SQL Server "kind"

listRestorableDroppedDatabases

public abstract List listRestorableDroppedDatabases()

Returns:

the list of all restorable dropped databases

listRestorableDroppedDatabasesAsync

public abstract PagedFlux listRestorableDroppedDatabasesAsync()

Returns:

the list of all restorable dropped databases

listUsageMetrics

public abstract List listUsageMetrics()

Returns:

returns the list of usage metrics for an Azure SQL Server

managedServiceIdentityType

public abstract IdentityType managedServiceIdentityType()

Returns:

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

publicNetworkAccess

public abstract ServerNetworkAccessFlag publicNetworkAccess()

Whether the SQL Server can be accessed from public network.

Returns:

whether the SQL Server can be accessed from public network.

removeAccessFromAzureServices

public abstract 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 abstract void removeActiveDirectoryAdministrator()

Removes the Active Directory administrator from this server.

serverKeys

public abstract SqlServerKeyOperations.SqlServerKeyActionsDefinition serverKeys()

Returns:

the entry point to manage SQL Server Keys for this server

serverSecurityAlertPolicies

public abstract SqlServerSecurityAlertPolicyOperations.SqlServerSecurityAlertPolicyActionsDefinition serverSecurityAlertPolicies()

Returns:

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

setActiveDirectoryAdministrator

public abstract 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 abstract String state()

Returns:

the state of the server.

systemAssignedManagedServiceIdentityPrincipalId

public abstract String systemAssignedManagedServiceIdentityPrincipalId()

Returns:

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

systemAssignedManagedServiceIdentityTenantId

public abstract String systemAssignedManagedServiceIdentityTenantId()

Returns:

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

version

public abstract String version()

Returns:

the SQL Server version

virtualNetworkRules

public abstract SqlVirtualNetworkRuleOperations.SqlVirtualNetworkRuleActionsDefinition virtualNetworkRules()

Returns:

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