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	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.

Текст запроса

Имя	Тип	Описание
properties.desiredState	AutomaticTuningServerMode	Автоматическая настройка требуемого состояния.
properties.options	<string,  AutomaticTuningServerOptions>	Определение параметров автоматической настройки.

Ответы

Имя	Тип	Описание
200 OK	ServerAutomaticTuning	Параметры автоматической настройки на уровне сервера успешно обновлены.
Other Status Codes		Ответы на ошибки: *** 400 FeatureDisabledOnSelectedEdition — пользователь попытался использовать функцию, которая отключена в текущем выпуске базы данных. 400 InvalidIdentifier — идентификатор содержит значение NULL или недопустимый символ Юникода. 400 InvalidAutomaticTuningUpsertRequest — текст запроса на обновление автоматической настройки не существует или не имеет объекта свойств. 400 InvalidAdvisorAutoExecuteStatus — указанное состояние автоматического выполнения для помощника не разрешено. 404 DatabaseDoesNotExist — запрошенная база данных не найдена 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 SubscriptionDoesNotHaveElasticPool — запрошенный эластичный пул не найден 404 OperationIdNotFound — операция с идентификатором не существует. 404 AutomaticTuningOptionNotFound — запрошенный параметр автоматической настройки не найден. 405 NotSupported — эта функция не поддерживается. 409 Conflict — не удалось обработать запрос из-за конфликта в запросе. 409 OperationCancelled — операция отменена пользователем. 409 OperationInterrupted — не удалось завершить операцию с ресурсом, так как она была прервана другой операцией с тем же ресурсом. 409 DefaultAdvisorStateNotAllowedInCustomServerMode — состояние помощника DEFAULT не разрешено в пользовательском режиме 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

Sample Request

HTTP

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

Java

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

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

Java

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	Идентификатор ресурса.
name	string	Имя ресурса.
properties.actualState	AutomaticTuningServerMode	Автоматическая настройка фактического состояния.
properties.desiredState	AutomaticTuningServerMode	Автоматическая настройка требуемого состояния.
properties.options	<string,  AutomaticTuningServerOptions>	Определение параметров автоматической настройки.
type	string	Тип ресурса.