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

Server Automatic Tuning - Update

参考

服务:: SQL Database

API 版本:: 2021-11-01

更新服务器上的自动优化选项。

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

URI 参数

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

请求正文

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

响应

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

名称

类型

说明

200 OK

ServerAutomaticTuning

已成功更新服务器级自动优化选项。

Other Status Codes

错误响应： ***

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

示例

Updates server automatic tuning settings with all properties

Updates server automatic tuning settings with minimal properties

Updates server 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/automaticTuning/current?api-version=2021-11-01

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


import com.azure.resourcemanager.sql.fluent.models.ServerAutomaticTuningInner;
import com.azure.resourcemanager.sql.models.AutomaticTuningOptionModeDesired;
import com.azure.resourcemanager.sql.models.AutomaticTuningServerMode;
import com.azure.resourcemanager.sql.models.AutomaticTuningServerOptions;
import java.util.HashMap;
import java.util.Map;

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

    // Use "Map.of" if available
    @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

示例响应

状态代码:: 200

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

Updates server automatic tuning settings with minimal properties

示例请求

HTTP
Java

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

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


import com.azure.resourcemanager.sql.fluent.models.ServerAutomaticTuningInner;
import com.azure.resourcemanager.sql.models.AutomaticTuningServerMode;
import java.util.HashMap;
import java.util.Map;

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

    // Use "Map.of" if available
    @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

示例响应

状态代码:: 200

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

定义

名称	说明
AutomaticTuningOptionModeActual	自动优化选项实际状态。
AutomaticTuningOptionModeDesired	自动优化选项所需状态。
AutomaticTuningServerMode	自动优化所需状态。
AutomaticTuningServerOptions	单个顾问的自动优化属性。
AutomaticTuningServerReason	如果需要和实际状态的原因说明不同。
ServerAutomaticTuning	服务器级自动优化。

AutomaticTuningOptionModeActual

枚举

自动优化选项实际状态。

值	说明
Off
On

AutomaticTuningOptionModeDesired

枚举

自动优化选项所需状态。

值	说明
Default
Off
On

AutomaticTuningServerMode

枚举

自动优化所需状态。

值	说明
Auto
Custom
Unspecified

AutomaticTuningServerOptions

Object

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

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

AutomaticTuningServerReason

枚举

如果需要和实际状态的原因说明不同。

值	说明
AutoConfigured
Default
Disabled