Server 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}/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 - Advisor に対して指定された自動実行状態は許可されません。 404 DatabaseDoesNotExist - 要求されたデータベースが見つかりませんでした 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 SubscriptionDoesNotHaveElasticPool - 要求されたエラスティックプールが見つかりませんでした 404 OperationIdNotFound - Id を持つ操作が存在しません。 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 - 使用可能なリソースで処理できる最大要求を超える要求。

名前

型

説明

200 OK

ServerAutomaticTuning

サーバーレベルの自動チューニングオプションが正常に更新されました。

Other Status Codes

エラー応答: ***

400 FeatureDisabledOnSelectedEdition - ユーザーは、現在のデータベースエディションで無効になっている機能を使用しようとしました。
400 InvalidIdentifier - 識別子に NULL または無効な Unicode 文字が含まれています。
400 InvalidAutomaticTuningUpsertRequest - 更新プログラムの自動チューニング要求本文が存在しないか、プロパティオブジェクトがありません。
400 InvalidAdvisorAutoExecuteStatus - Advisor に対して指定された自動実行状態は許可されません。
404 DatabaseDoesNotExist - 要求されたデータベースが見つかりませんでした
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 SubscriptionDoesNotHaveElasticPool - 要求されたエラスティックプールが見つかりませんでした
404 OperationIdNotFound - Id を持つ操作が存在しません。
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.core.util.Context;
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))),
            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/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

Sample Request

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.core.util.Context;
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), 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/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	string
On	string

AutomaticTuningOptionModeDesired

自動チューニングオプションの目的の状態。

名前	型	説明
Default	string
Off	string
On	string

AutomaticTuningServerMode

目的の状態の自動チューニング。

名前	型	説明
Auto	string
Custom	string
Unspecified	string

AutomaticTuningServerOptions

個々のアドバイザーの自動チューニングプロパティ。

名前	型	説明
actualState	AutomaticTuningOptionModeActual	自動チューニングオプションの実際の状態。
desiredState	AutomaticTuningOptionModeDesired	自動チューニングオプションの目的の状態。
reasonCode	integer	必要に応じて理由コードと実際の状態が異なります。
reasonDesc	AutomaticTuningServerReason	必要に応じて理由の説明と実際の状態が異なります。

AutomaticTuningServerReason

必要に応じて理由の説明と実際の状態が異なります。

名前	型	説明
AutoConfigured	string
Default	string
Disabled	string

ServerAutomaticTuning

サーバーレベルの自動チューニング。

名前	型	説明
id	string	リソースの ID
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

Sample Request

Sample Response

Updates server automatic tuning settings with minimal properties

Sample Request

Sample Response

定義

AutomaticTuningOptionModeActual

AutomaticTuningOptionModeDesired

AutomaticTuningServerMode

AutomaticTuningServerOptions

AutomaticTuningServerReason

ServerAutomaticTuning

その他のリソース