SqlServer Interface

Package:

com.azure.resourcemanager.sql.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-sql:2.48.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() Gets the administrator login user name for the SQL Server.
abstract SqlDatabaseActionsDefinition	databases() Gets entry point to manage Databases for this SQL server.
abstract SqlServerDnsAliasActionsDefinition	dnsAliases() Gets the entry point to manage SQL Server DNS aliases for this server.
abstract SqlElasticPoolActionsDefinition	elasticPools() Gets the entry point to manage the SQL Elastic Pools for this server.
abstract SqlFirewallRule	enableAccessFromAzureServices() Sets the Azure services default access to this server to true.
abstract SqlEncryptionProtectorActionsDefinition	encryptionProtectors() Gets the entry point to manage SQL Encryption Protector for this server.
abstract SqlFailoverGroupActionsDefinition	failoverGroups() Gets the entry point to manage SQL Failover Group for this server.
abstract SqlFirewallRuleActionsDefinition	firewallRules() Gets the entry point to manage SQL Firewall rules for this server.
abstract String	fullyQualifiedDomainName() Gets the fully qualified name of the SQL Server.
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() Checks whether Managed Service Identity is enabled for the SQL server.
abstract String	kind() Gets the kind of the SQL Server.
abstract List<SqlRestorableDroppedDatabase>	listRestorableDroppedDatabases() Gets the list of all restorable dropped databases.
abstract PagedFlux<SqlRestorableDroppedDatabase>	listRestorableDroppedDatabasesAsync() Gets the list of all restorable dropped databases.
abstract List<ServerMetric>	listUsageMetrics() Gets the list of usage metrics for an Azure SQL Server.
abstract IdentityType	managedServiceIdentityType() Gets the type of Managed Service Identity used for the SQL server.
abstract ServerNetworkAccessFlag	publicNetworkAccess() Checks 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() Gets the entry point to manage SQL Server Keys for this server.
abstract SqlServerSecurityAlertPolicyActionsDefinition	serverSecurityAlertPolicies() Gets the entry point to manage SQL Server Security Alert Policy for this server.
abstract SqlActiveDirectoryAdministrator	setActiveDirectoryAdministrator(String userLogin, String id) Sets an Active Directory administrator to this server.
abstract String	state() Gets the state of the server.
abstract String	systemAssignedManagedServiceIdentityPrincipalId() Gets the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the SQL server.
abstract String	systemAssignedManagedServiceIdentityTenantId() Gets the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the SQL server.
abstract String	version() Gets the SQL Server version.
abstract SqlVirtualNetworkRuleActionsDefinition	virtualNetworkRules() Gets the entry point to manage SQL Virtual Network Rule for this server.

Method Details

administratorLogin

public abstract String administratorLogin()

Gets the administrator login user name for the SQL Server.

Returns:

the administrator login user name for the SQL Server

databases

public abstract SqlDatabaseOperations.SqlDatabaseActionsDefinition databases()

Gets entry point to manage Databases for this SQL server.

Returns:

entry point to manage Databases for this SQL server

dnsAliases

public abstract SqlServerDnsAliasOperations.SqlServerDnsAliasActionsDefinition dnsAliases()

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

Returns:

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

elasticPools

public abstract SqlElasticPoolOperations.SqlElasticPoolActionsDefinition elasticPools()

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

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()

Gets the entry point to manage SQL Encryption Protector for this server.

Returns:

the entry point to manage SQL Encryption Protector for this server

failoverGroups

public abstract SqlFailoverGroupOperations.SqlFailoverGroupActionsDefinition failoverGroups()

Gets the entry point to manage SQL Failover Group for this server.

Returns:

the entry point to manage SQL Failover Group for this server

firewallRules

public abstract SqlFirewallRuleOperations.SqlFirewallRuleActionsDefinition firewallRules()

Gets the entry point to manage SQL Firewall rules for this server.

Returns:

the entry point to manage SQL Firewall rules for this server

fullyQualifiedDomainName

public abstract String fullyQualifiedDomainName()

Gets the fully qualified name of the SQL Server.

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()

Checks whether Managed Service Identity is enabled for the SQL server.

Returns:

true if Managed Service Identity is enabled for the SQL server

kind

public abstract String kind()

Gets the kind of the SQL Server.

Returns:

the SQL Server "kind"

listRestorableDroppedDatabases

public abstract List listRestorableDroppedDatabases()

Gets the list of all restorable dropped databases.

Returns:

the list of all restorable dropped databases

listRestorableDroppedDatabasesAsync

public abstract PagedFlux listRestorableDroppedDatabasesAsync()

Gets the list of all restorable dropped databases.

Returns:

the list of all restorable dropped databases

listUsageMetrics

public abstract List listUsageMetrics()

Gets the list of usage metrics for an Azure SQL Server.

Returns:

returns the list of usage metrics for an Azure SQL Server

managedServiceIdentityType

public abstract IdentityType managedServiceIdentityType()

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

Returns:

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

publicNetworkAccess

public abstract ServerNetworkAccessFlag publicNetworkAccess()

Checks 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()

Gets the entry point to manage SQL Server Keys for this server.

Returns:

the entry point to manage SQL Server Keys for this server

serverSecurityAlertPolicies

public abstract SqlServerSecurityAlertPolicyOperations.SqlServerSecurityAlertPolicyActionsDefinition serverSecurityAlertPolicies()

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

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()

Gets the state of the server.

Returns:

the state of the server.

systemAssignedManagedServiceIdentityPrincipalId

public abstract String systemAssignedManagedServiceIdentityPrincipalId()

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

Returns:

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

systemAssignedManagedServiceIdentityTenantId

public abstract String systemAssignedManagedServiceIdentityTenantId()

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

Returns:

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

version

public abstract String version()

Gets the SQL Server version.

Returns:

the SQL Server version

virtualNetworkRules

public abstract SqlVirtualNetworkRuleOperations.SqlVirtualNetworkRuleActionsDefinition virtualNetworkRules()

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

Returns:

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