你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Database Automatic Tuning - Update

参考

Service:: SQL Database

API Version:: 2021-11-01

更新目标数据库的自动优化属性。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/automaticTuning/current?api-version=2021-11-01

URI 参数

名称	在	必需	类型	说明
databaseName	path	True	string	数据库的名称。
resourceGroupName	path	True	string	包含该资源的资源组名称。可以从 Azure 资源管理器 API 或门户获取此值。
serverName	path	True	string	服务器的名称。
subscriptionId	path	True	string	用于标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

请求正文

名称	类型	说明
properties.desiredState	AutomaticTuningMode	自动优化所需状态。
properties.options	<string, AutomaticTuningOptions>	自动优化选项定义。

响应

名称	类型	说明
200 OK	DatabaseAutomaticTuning	已成功更新指定的数据库自动优化设置。
Other Status Codes		错误响应： *** 400 FeatureDisabledOnSelectedEdition - 用户尝试使用在当前数据库版本上禁用的功能。 400 InvalidIdentifier - 标识符包含 NULL 或无效的 unicode 字符。 400 SystemDatabasesNotSupported - 用户尝试获取有关系统数据库的自动优化信息。 400 DataWarehouseNotSupported - SQL Data Warehouse不支持自动优化。 400 InvalidAutomaticTuningUpsertRequest - 更新自动优化请求正文不存在或没有属性对象。 400 InvalidAdvisorAutoExecuteStatus - 不允许为顾问指定自动执行状态。 404 DatabaseDoesNotExist - 找不到请求的数据库 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器 404 SubscriptionDoesNotHaveElasticPool - 找不到请求的弹性池 404 OperationIdNotFound - ID 为的操作不存在。 404 AutomaticTuningOptionNotFound - 找不到请求的自动优化选项。 405 NotSupported - 不支持此功能。 409 冲突 - 由于请求中的冲突，无法处理请求。 409 OperationCancelled - 用户已取消该操作。 409 操作中断 - 无法完成对资源的操作，因为它被同一资源上的另一个操作中断。 409 DisabledBySystem - 此选项由系统禁用 409 DefaultAdvisorStateNotAllowedInCustomDbMode - 在自定义模式下不允许使用 DEFAULT 顾问状态 429 SubscriptionTooManyCreateUpdateRequests - 超出可用资源可处理的最大请求数的请求数。 429 SubscriptionTooManyRequests - 超出可用资源可处理的最大请求数的请求数。 500 OperationTimedOut - 操作超时并自动回滚。请重试该操作。 503 ServiceTemporarilyUnavailable - 功能暂时不可用。 503 TooManyRequests - 超出可用资源可处理的最大请求数的请求数。

名称

类型

说明

200 OK

DatabaseAutomaticTuning

已成功更新指定的数据库自动优化设置。

Other Status Codes

错误响应： ***

400 FeatureDisabledOnSelectedEdition - 用户尝试使用在当前数据库版本上禁用的功能。
400 InvalidIdentifier - 标识符包含 NULL 或无效的 unicode 字符。
400 SystemDatabasesNotSupported - 用户尝试获取有关系统数据库的自动优化信息。
400 DataWarehouseNotSupported - SQL Data Warehouse不支持自动优化。
400 InvalidAutomaticTuningUpsertRequest - 更新自动优化请求正文不存在或没有属性对象。
400 InvalidAdvisorAutoExecuteStatus - 不允许为顾问指定自动执行状态。
404 DatabaseDoesNotExist - 找不到请求的数据库
404 SubscriptionDoesNotHaveServer - 找不到请求的服务器
404 SubscriptionDoesNotHaveElasticPool - 找不到请求的弹性池
404 OperationIdNotFound - ID 为的操作不存在。
404 AutomaticTuningOptionNotFound - 找不到请求的自动优化选项。
405 NotSupported - 不支持此功能。
409 冲突 - 由于请求中的冲突，无法处理请求。
409 OperationCancelled - 用户已取消该操作。
409 操作中断 - 无法完成对资源的操作，因为它被同一资源上的另一个操作中断。
409 DisabledBySystem - 此选项由系统禁用
409 DefaultAdvisorStateNotAllowedInCustomDbMode - 在自定义模式下不允许使用 DEFAULT 顾问状态
429 SubscriptionTooManyCreateUpdateRequests - 超出可用资源可处理的最大请求数的请求数。
429 SubscriptionTooManyRequests - 超出可用资源可处理的最大请求数的请求数。
500 OperationTimedOut - 操作超时并自动回滚。请重试该操作。
503 ServiceTemporarilyUnavailable - 功能暂时不可用。
503 TooManyRequests - 超出可用资源可处理的最大请求数的请求数。

示例

Updates database automatic tuning settings with all properties

Updates database automatic tuning settings with minimal properties

Updates database automatic tuning settings with all properties

PATCH https://management.azure.com/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current?api-version=2021-11-01

{
  "properties": {
    "desiredState": "Auto",
    "options": {
      "createIndex": {
        "desiredState": "Off"
      },
      "dropIndex": {
        "desiredState": "On"
      },
      "forceLastGoodPlan": {
        "desiredState": "Default"
      }
    }
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.DatabaseAutomaticTuningInner;
import com.azure.resourcemanager.sql.models.AutomaticTuningMode;
import com.azure.resourcemanager.sql.models.AutomaticTuningOptionModeDesired;
import com.azure.resourcemanager.sql.models.AutomaticTuningOptions;
import java.util.HashMap;
import java.util.Map;

/** Samples for DatabaseAutomaticTuning Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseAutomaticTuningUpdateMax.json
     */
    /**
     * Sample code: Updates database automatic tuning settings with all properties.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updatesDatabaseAutomaticTuningSettingsWithAllProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseAutomaticTunings().updateWithResponse(
            "default-sql-onebox", "testsvr11", "db1",
            new DatabaseAutomaticTuningInner().withDesiredState(AutomaticTuningMode.AUTO)
                .withOptions(mapOf("createIndex",
                    new AutomaticTuningOptions().withDesiredState(AutomaticTuningOptionModeDesired.OFF), "dropIndex",
                    new AutomaticTuningOptions().withDesiredState(AutomaticTuningOptionModeDesired.ON),
                    "forceLastGoodPlan",
                    new AutomaticTuningOptions().withDesiredState(AutomaticTuningOptionModeDesired.DEFAULT))),
            Context.NONE);
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/automaticTuning",
  "properties": {
    "desiredState": "Auto",
    "actualState": "Auto",
    "options": {
      "forceLastGoodPlan": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "createIndex": {
        "desiredState": "Off",
        "actualState": "Off"
      },
      "dropIndex": {
        "desiredState": "On",
        "actualState": "On"
      },
      "maintainIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      }
    }
  }
}

Updates database automatic tuning settings with minimal properties

Sample Request

HTTP
Java

PATCH https://management.azure.com/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current?api-version=2021-11-01

{
  "properties": {
    "desiredState": "Auto"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.DatabaseAutomaticTuningInner;
import com.azure.resourcemanager.sql.models.AutomaticTuningMode;
import java.util.HashMap;
import java.util.Map;

/** Samples for DatabaseAutomaticTuning Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseAutomaticTuningUpdateMin.json
     */
    /**
     * Sample code: Updates database automatic tuning settings with minimal properties.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updatesDatabaseAutomaticTuningSettingsWithMinimalProperties(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseAutomaticTunings().updateWithResponse(
            "default-sql-onebox", "testsvr11", "db1",
            new DatabaseAutomaticTuningInner().withDesiredState(AutomaticTuningMode.AUTO), Context.NONE);
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/automaticTuning",
  "properties": {
    "desiredState": "Auto",
    "actualState": "Auto",
    "options": {
      "forceLastGoodPlan": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "createIndex": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "dropIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "maintainIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      }
    }
  }
}

定义

名称	说明
AutomaticTuningDisabledReason	所需状态和实际状态不同的原因说明。
AutomaticTuningMode	自动优化所需状态。
AutomaticTuningOptionModeActual	自动优化选项的实际状态。
AutomaticTuningOptionModeDesired	自动优化选项所需状态。
AutomaticTuningOptions	单个顾问的自动优化属性。
DatabaseAutomaticTuning	数据库级自动优化。

AutomaticTuningDisabledReason

所需状态和实际状态不同的原因说明。

名称	类型	说明
AutoConfigured	string
Default	string
Disabled	string
InheritedFromServer	string
NotSupported	string
QueryStoreOff	string
QueryStoreReadOnly	string

AutomaticTuningMode

自动优化所需状态。

名称	类型	说明
Auto	string
Custom	string
Inherit	string
Unspecified	string

AutomaticTuningOptionModeActual

自动优化选项的实际状态。

名称	类型	说明
Off	string
On	string

AutomaticTuningOptionModeDesired

自动优化选项所需状态。

名称	类型	说明
Default	string
Off	string
On	string

AutomaticTuningOptions

单个顾问的自动优化属性。

名称	类型	说明
actualState	AutomaticTuningOptionModeActual	自动优化选项的实际状态。
desiredState	AutomaticTuningOptionModeDesired	自动优化选项所需状态。
reasonCode	integer	原因代码（如果需要）和实际状态不同。
reasonDesc	AutomaticTuningDisabledReason	所需状态和实际状态不同的原因说明。