Interface SqlServer

All Superinterfaces:
GroupableResource<SqlServerManager, ServerInner>, HasId, HasInnerModel<ServerInner>, HasManager<SqlServerManager>, HasName, HasResourceGroup, Indexable, Refreshable<SqlServer>, Resource, Updatable<SqlServer.Update>
public interface SqlServer extends GroupableResource<SqlServerManager, ServerInner>, Refreshable<SqlServer>, Updatable<SqlServer.Update>
An immutable client-side representation of an Azure SQL Server.

  • Method Details

    • fullyQualifiedDomainName

      String fullyQualifiedDomainName()
      Gets the fully qualified name of the SQL Server.
      Returns:
      fully qualified name of the SQL Server

    • administratorLogin

      String administratorLogin()
      Gets the administrator login user name for the SQL Server.
      Returns:
      the administrator login user name for the SQL Server

    • version

      String version()
      Gets the SQL Server version.
      Returns:
      the SQL Server version

    • kind

      String kind()
      Gets the kind of the SQL Server.
      Returns:
      the SQL Server "kind"

    • state

      String state()
      Gets the state of the server.
      Returns:
      the state of the server.

    • isManagedServiceIdentityEnabled

      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

    • systemAssignedManagedServiceIdentityTenantId

      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.

    • systemAssignedManagedServiceIdentityPrincipalId

      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.

    • managedServiceIdentityType

      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.

    • listUsageMetrics

      List<ServerMetric> listUsageMetrics()
      Gets the list of usage metrics for an Azure SQL Server.
      Returns:
      returns the list of usage metrics for an Azure SQL Server

    • listRestorableDroppedDatabases

      List<SqlRestorableDroppedDatabase> listRestorableDroppedDatabases()
      Gets the list of all restorable dropped databases.
      Returns:
      the list of all restorable dropped databases

    • listRestorableDroppedDatabasesAsync

      com.azure.core.http.rest.PagedFlux<SqlRestorableDroppedDatabase> listRestorableDroppedDatabasesAsync()
      Gets the list of all restorable dropped databases.
      Returns:
      the list of all restorable dropped databases

    • enableAccessFromAzureServices

      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

    • publicNetworkAccess

      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

      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.

    • setActiveDirectoryAdministrator

      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

    • getActiveDirectoryAdministrator

      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)

    • removeActiveDirectoryAdministrator

      void removeActiveDirectoryAdministrator()
      Removes the Active Directory administrator from this server.

    • getServerAutomaticTuning

      SqlServerAutomaticTuning getServerAutomaticTuning()
      Gets a SQL server automatic tuning state and options.
      Returns:
      the SQL server automatic tuning state and options

    • firewallRules

      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

    • virtualNetworkRules

      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

    • elasticPools

      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

    • databases

      SqlDatabaseOperations.SqlDatabaseActionsDefinition databases()
      Gets entry point to manage Databases for this SQL server.
      Returns:
      entry point to manage Databases for this SQL server

    • dnsAliases

      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

    • failoverGroups

      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

    • serverKeys

      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

    • encryptionProtectors

      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

    • serverSecurityAlertPolicies

      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