Package com.microsoft.azure.management.sql

Interface SqlServer

All Superinterfaces:
GroupableResource<com.microsoft.azure.management.sql.implementation.SqlServerManager,com.microsoft.azure.management.sql.implementation.ServerInner>, HasId, HasInner<com.microsoft.azure.management.sql.implementation.ServerInner>, HasManager<com.microsoft.azure.management.sql.implementation.SqlServerManager>, HasName, HasResourceGroup, Indexable, Refreshable<SqlServer>, Resource, Updatable<SqlServer.Update>
@Beta(V1_7_0) public interface SqlServer extends GroupableResource<com.microsoft.azure.management.sql.implementation.SqlServerManager,com.microsoft.azure.management.sql.implementation.ServerInner>, Refreshable<SqlServer>, Updatable<SqlServer.Update>
An immutable client-side representation of an Azure SQL Server.

  • Method Details

    • fullyQualifiedDomainName

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

    • administratorLogin

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

    • version

      String version()
      Returns:
      the SQL Server version

    • kind

      @Beta(V1_7_0) String kind()
      Returns:
      the SQL Server "kind"

    • state

      @Beta(V1_7_0) String state()
      Returns:
      the state of the server.

    • isManagedServiceIdentityEnabled

      @Beta(V1_8_0) boolean isManagedServiceIdentityEnabled()
      Returns:
      true if Managed Service Identity is enabled for the SQL server

    • systemAssignedManagedServiceIdentityTenantId

      @Beta(V1_8_0) String systemAssignedManagedServiceIdentityTenantId()
      Returns:
      the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the SQL server.

    • systemAssignedManagedServiceIdentityPrincipalId

      @Beta(V1_8_0) String systemAssignedManagedServiceIdentityPrincipalId()
      Returns:
      the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the SQL server.

    • managedServiceIdentityType

      @Beta(V1_8_0) IdentityType managedServiceIdentityType()
      Returns:
      the type of Managed Service Identity used for the SQL server.

    • listUsages

      @Deprecated List<ServerMetric> listUsages()
      Deprecated.
      Returns:
      returns the list of usages (ServerMetric) of Azure SQL Server

    • listUsageMetrics

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

    • listServiceObjectives

      List<ServiceObjective> listServiceObjectives()
      Returns:
      the list of information on all service objectives

    • getServiceObjective

      @Beta(V1_7_0) 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

    • listRecommendedElasticPools

      Map<String,RecommendedElasticPool> listRecommendedElasticPools()
      Returns all the recommended elastic pools for the server.
      Returns:
      list of recommended elastic pools for the server

    • listRestorableDroppedDatabases

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

    • listRestorableDroppedDatabasesAsync

      @Beta(V1_7_0) rx.Observable<SqlRestorableDroppedDatabase> listRestorableDroppedDatabasesAsync()
      Returns:
      the list of all restorable dropped databases

    • enableAccessFromAzureServices

      @Beta(V1_7_0) 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

    • removeAccessFromAzureServices

      @Beta(V1_7_0) 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

      @Beta(V1_7_0) 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

      @Beta(V1_7_0) 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

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

    • getServerAutomaticTuning

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

    • firewallRules

      @Beta(V1_7_0) SqlFirewallRuleOperations.SqlFirewallRuleActionsDefinition firewallRules()
      Returns:
      the entry point to manage SQL Firewall rules for this server

    • virtualNetworkRules

      @Beta(V1_8_0) SqlVirtualNetworkRuleOperations.SqlVirtualNetworkRuleActionsDefinition virtualNetworkRules()
      Returns:
      the entry point to manage SQL Virtual Network Rule for this server

    • elasticPools

      @Beta(V1_7_0) SqlElasticPoolOperations.SqlElasticPoolActionsDefinition elasticPools()
      Returns:
      the entry point to manage the SQL Elastic Pools for this server

    • databases

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

    • dnsAliases

      @Beta(V1_8_0) SqlServerDnsAliasOperations.SqlServerDnsAliasActionsDefinition dnsAliases()
      Returns:
      the entry point to manage SQL Server DNS aliases for this server

    • failoverGroups

      @Beta(V1_8_0) SqlFailoverGroupOperations.SqlFailoverGroupActionsDefinition failoverGroups()
      Returns:
      the entry point to manage SQL Failover Group for this server

    • serverKeys

      @Beta(V1_8_0) SqlServerKeyOperations.SqlServerKeyActionsDefinition serverKeys()
      Returns:
      the entry point to manage SQL Server Keys for this server

    • encryptionProtectors

      @Beta(V1_9_0) SqlEncryptionProtectorOperations.SqlEncryptionProtectorActionsDefinition encryptionProtectors()
      Returns:
      the entry point to manage SQL Encryption Protector for this server

    • serverSecurityAlertPolicies

      @Beta(V1_15_0) SqlServerSecurityAlertPolicyOperations.SqlServerSecurityAlertPolicyActionsDefinition serverSecurityAlertPolicies()
      Returns:
      the entry point to manage SQL Server Security Alert Policy for this server