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 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	包含資源的資源群組名稱。您可以從 Azure 資源管理員 API 或入口網站取得這個值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	可識別 Azure 訂用帳戶的訂用帳戶識別碼。
api-version	query	True	string	要用於要求的 API 版本。

要求本文

名稱	類型	Description
properties.desiredState	AutomaticTuningServerMode	自動調整所需的狀態。
properties.options	<string, AutomaticTuningServerOptions>	自動調整選項定義。

回應

名稱	類型	Description
200 OK	ServerAutomaticTuning	已成功更新伺服器層級的自動調整選項。
Other Status Codes		錯誤回應： ≦ 400 FeatureDisabledOnSelectedEdition - 用戶嘗試使用目前資料庫版本停用的功能。 400 InvalidIdentifier - 識別碼包含 NULL 或無效的 Unicode 字元。 400 InvalidAutomaticTuningUpsertRequest - 更新自動調整要求本文不存在或沒有 properties 物件。 400 InvalidAdvisorAutoExecuteStatus - 不允許指定建議程序的自動執行狀態。 404 DatabaseDoesNotExist - 找不到要求的資料庫 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器 404 SubscriptionDoesNotHaveElasticPool - 找不到要求的彈性集區 404 OperationIdNotFound - 標識符為的作業不存在。 404 AutomaticTuningOptionNotFound - 找不到要求的自動調整選項。 405 NotSupported - 不支援此功能。 409 衝突 - 要求因要求衝突而無法處理。 409 OperationCancelled - 使用者已取消作業。 409 OperationInterrupted - 無法完成資源上的作業，因為它被相同資源上的另一個作業中斷。 409 DefaultAdvisorStateNotAllowedInCustomServerMode - CUSTOM 模式中不允許 DEFAULT Advisor 狀態 409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress - 先前要求的自動微調設定尚未傳播至所有用戶資料庫。 429 SubscriptionTooManyCreateUpdateRequests - 超出可用資源可處理之最大要求的要求。 429 SubscriptionTooManyRequests - 超出可用資源可處理的最大要求。 500 OperationTimedOut - 作業逾時並自動回復。請重試該作業。 503 ServiceTemporarilyUnavailable - 功能暫時無法使用。 503 TooManyRequests - 超出可用資源可處理之最大要求的要求。

名稱

類型

Description

200 OK

ServerAutomaticTuning

已成功更新伺服器層級的自動調整選項。

Other Status Codes

錯誤回應： ≦

400 FeatureDisabledOnSelectedEdition - 用戶嘗試使用目前資料庫版本停用的功能。
400 InvalidIdentifier - 識別碼包含 NULL 或無效的 Unicode 字元。
400 InvalidAutomaticTuningUpsertRequest - 更新自動調整要求本文不存在或沒有 properties 物件。
400 InvalidAdvisorAutoExecuteStatus - 不允許指定建議程序的自動執行狀態。
404 DatabaseDoesNotExist - 找不到要求的資料庫
404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器
404 SubscriptionDoesNotHaveElasticPool - 找不到要求的彈性集區
404 OperationIdNotFound - 標識符為的作業不存在。
404 AutomaticTuningOptionNotFound - 找不到要求的自動調整選項。
405 NotSupported - 不支援此功能。
409 衝突 - 要求因要求衝突而無法處理。
409 OperationCancelled - 使用者已取消作業。
409 OperationInterrupted - 無法完成資源上的作業，因為它被相同資源上的另一個作業中斷。
409 DefaultAdvisorStateNotAllowedInCustomServerMode - CUSTOM 模式中不允許 DEFAULT Advisor 狀態
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"
      }
    }
  }
}

定義

名稱	Description
AutomaticTuningOptionModeActual	自動微調選項實際狀態。
AutomaticTuningOptionModeDesired	自動調整選項所需的狀態。
AutomaticTuningServerMode	自動調整所需的狀態。
AutomaticTuningServerOptions	個別建議程序自動微調屬性。
AutomaticTuningServerReason	如有需要且實際狀態不同，原因描述。
ServerAutomaticTuning	伺服器層級的自動調整。

AutomaticTuningOptionModeActual

自動微調選項實際狀態。

名稱	類型	Description
Off	string
On	string

AutomaticTuningOptionModeDesired

自動調整選項所需的狀態。

名稱	類型	Description
Default	string
Off	string
On	string

AutomaticTuningServerMode

自動調整所需的狀態。

名稱	類型	Description
Auto	string
Custom	string
Unspecified	string

AutomaticTuningServerOptions

個別建議程序自動微調屬性。

名稱	類型	Description
actualState	AutomaticTuningOptionModeActual	自動微調選項實際狀態。
desiredState	AutomaticTuningOptionModeDesired	自動調整選項所需的狀態。
reasonCode	integer	如有需要且實際狀態不同，則原因代碼。
reasonDesc	AutomaticTuningServerReason	如有需要且實際狀態不同，原因描述。

AutomaticTuningServerReason

如有需要且實際狀態不同，原因描述。

名稱	類型	Description
AutoConfigured	string
Default	string
Disabled	string

ServerAutomaticTuning

伺服器層級的自動調整。

名稱	類型	Description
id	string	資源識別碼。
name	string	資源名稱。
properties.actualState	AutomaticTuningServerMode	自動微調實際狀態。
properties.desiredState	AutomaticTuningServerMode	自動調整所需的狀態。
properties.options	<string, AutomaticTuningServerOptions>	自動調整選項定義。
type	string	資源類型。

共用方式為

Server Automatic Tuning - Update

URI 參數

要求本文

回應

範例

Updates server automatic tuning settings with all properties

範例要求

範例回覆

Updates server automatic tuning settings with minimal properties

範例要求

範例回覆

定義

AutomaticTuningOptionModeActual

AutomaticTuningOptionModeDesired

AutomaticTuningServerMode

AutomaticTuningServerOptions

AutomaticTuningServerReason

ServerAutomaticTuning

其他資源