Database Automatic Tuning - Update

リファレンス

サービス:: SQL Database

API バージョン:: 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 - Advisor に対して指定された自動実行状態は許可されません。 404 DatabaseDoesNotExist - 要求されたデータベースが見つかりませんでした 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 SubscriptionDoesNotHaveElasticPool - 要求されたエラスティックプールが見つかりませんでした 404 OperationIdNotFound - Id を持つ操作が存在しません。 404 AutomaticTuningOptionNotFound - 要求された自動チューニングオプションが見つかりませんでした。 405 NotSupported - この機能はサポートされていません。 409 競合 - 要求の競合が原因で要求を処理できませんでした。 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 409 DisabledBySystem - このオプションはシステムによって無効になっています 409 DefaultAdvisorStateNotAllowedInCustomDbMode - DEFAULT advisor 状態は CUSTOM モードでは使用できません 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 - Advisor に対して指定された自動実行状態は許可されません。
404 DatabaseDoesNotExist - 要求されたデータベースが見つかりませんでした
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 SubscriptionDoesNotHaveElasticPool - 要求されたエラスティックプールが見つかりませんでした
404 OperationIdNotFound - Id を持つ操作が存在しません。
404 AutomaticTuningOptionNotFound - 要求された自動チューニングオプションが見つかりませんでした。
405 NotSupported - この機能はサポートされていません。
409 競合 - 要求の競合が原因で要求を処理できませんでした。
409 OperationCancelled - 操作がユーザーによって取り消されました。
409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。
409 DisabledBySystem - このオプションはシステムによって無効になっています
409 DefaultAdvisorStateNotAllowedInCustomDbMode - DEFAULT advisor 状態は CUSTOM モードでは使用できません
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.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))),
            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/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

要求のサンプル

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.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),
            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/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	必要に応じて理由の説明と実際の状態が異なります。

DatabaseAutomaticTuning

データベースレベルの自動チューニング。

名前	型	説明
id	string	リソースの ID
name	string	リソース名。
properties.actualState	AutomaticTuningMode	自動チューニングの実際の状態。
properties.desiredState	AutomaticTuningMode	目的の状態の自動チューニング。
properties.options	<string, AutomaticTuningOptions>	自動チューニングオプションの定義。
type	string	リソースの種類。

次の方法で共有

Database Automatic Tuning - Update

URI パラメーター

要求本文

応答

例

Updates database automatic tuning settings with all properties

要求のサンプル

応答のサンプル

Updates database automatic tuning settings with minimal properties

要求のサンプル

応答のサンプル

定義

AutomaticTuningDisabledReason

AutomaticTuningMode

AutomaticTuningOptionModeActual

AutomaticTuningOptionModeDesired

AutomaticTuningOptions

DatabaseAutomaticTuning

その他のリソース