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 매개 변수

Name	In(다음 안에)	필수	형식	Description
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 버전입니다.

요청 본문

Name	형식	Description
properties.desiredState	AutomaticTuningMode	원하는 상태를 자동으로 조정합니다.
properties.options	<string,  AutomaticTuningOptions>	자동 튜닝 옵션 정의입니다.

응답

Name	형식	Description
200 OK	DatabaseAutomaticTuning	지정된 데이터베이스 자동 튜닝 설정을 업데이트했습니다.
Other Status Codes		오류 응답: *** 400 FeatureDisabledOnSelectedEdition - 사용자가 현재 데이터베이스 버전에서 사용하지 않도록 설정된 기능을 사용하려고 했습니다. 400 InvalidIdentifier - 식별자에 NULL 또는 잘못된 유니코드 문자가 포함되어 있습니다. 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

Sample Request

HTTP

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"
      }
    }
  }
}

Java

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

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"
  }
}

Java

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"
      }
    }
  }
}

정의

Name	Description
AutomaticTuningDisabledReason	원하는 상태와 실제 상태가 다른 경우 이유 설명입니다.
AutomaticTuningMode	원하는 상태를 자동으로 조정합니다.
AutomaticTuningOptionModeActual	자동 튜닝 옵션 실제 상태입니다.
AutomaticTuningOptionModeDesired	자동 튜닝 옵션 원하는 상태입니다.
AutomaticTuningOptions	개별 관리자에 대한 자동 튜닝 속성입니다.
DatabaseAutomaticTuning	데이터베이스 수준 자동 튜닝.

AutomaticTuningDisabledReason

원하는 상태와 실제 상태가 다른 경우 이유 설명입니다.

Name	형식	Description
AutoConfigured	string
Default	string
Disabled	string
InheritedFromServer	string
NotSupported	string
QueryStoreOff	string
QueryStoreReadOnly	string

AutomaticTuningMode

원하는 상태를 자동으로 조정합니다.

Name	형식	Description
Auto	string
Custom	string
Inherit	string
Unspecified	string

AutomaticTuningOptionModeActual

자동 튜닝 옵션 실제 상태입니다.

Name	형식	Description
Off	string
On	string

AutomaticTuningOptionModeDesired

자동 튜닝 옵션 원하는 상태입니다.

Name	형식	Description
Default	string
Off	string
On	string

AutomaticTuningOptions

개별 관리자에 대한 자동 튜닝 속성입니다.

Name	형식	Description
actualState	AutomaticTuningOptionModeActual	자동 튜닝 옵션 실제 상태입니다.
desiredState	AutomaticTuningOptionModeDesired	자동 튜닝 옵션 원하는 상태입니다.
reasonCode	integer	원하는 코드와 실제 상태가 다른 경우 이유 코드입니다.
reasonDesc	AutomaticTuningDisabledReason	원하는 상태와 실제 상태가 다른 경우 이유 설명입니다.

DatabaseAutomaticTuning

데이터베이스 수준 자동 튜닝.

Name	형식	Description
id	string	리소스 ID입니다.
name	string	리소스 이름입니다.
properties.actualState	AutomaticTuningMode	자동 튜닝 실제 상태.
properties.desiredState	AutomaticTuningMode	원하는 상태를 자동으로 조정합니다.
properties.options	<string,  AutomaticTuningOptions>	자동 튜닝 옵션 정의입니다.
type	string	리소스 종류.