Database Automatic Tuning - Update

Служба:: SQL Database

Версия API:: 2025-01-01

Обновите свойства автоматической настройки для целевой базы данных.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/automaticTuning/current?api-version=2025-01-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
databaseName	path	True	string	Имя базы данных.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
serverName	path	True	string	Имени сервера.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

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

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

Ответы

Имя	Тип	Описание
200 OK	DatabaseAutomaticTuning	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Updates database automatic tuning settings with all properties

Updates database automatic tuning settings with minimal properties

Updates database automatic tuning settings with all properties

Образец запроса

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=2025-01-01

{
  "properties": {
    "desiredState": "Auto",
    "options": {
      "createIndex": {
        "desiredState": "Off"
      },
      "dropIndex": {
        "desiredState": "On"
      },
      "forceLastGoodPlan": {
        "desiredState": "Default"
      }
    }
  }
}

Пример ответа

Код состояния:: 200

{
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/automaticTuning",
  "id": "/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current",
  "properties": {
    "actualState": "Auto",
    "desiredState": "Auto",
    "options": {
      "createIndex": {
        "actualState": "Off",
        "desiredState": "Off"
      },
      "dropIndex": {
        "actualState": "On",
        "desiredState": "On"
      },
      "forceLastGoodPlan": {
        "actualState": "On",
        "desiredState": "Default",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "maintainIndex": {
        "actualState": "Off",
        "desiredState": "Default",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      }
    }
  }
}

Updates database automatic tuning settings with minimal properties

Образец запроса

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=2025-01-01

{
  "properties": {
    "desiredState": "Auto"
  }
}

Пример ответа

Код состояния:: 200

{
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/automaticTuning",
  "id": "/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current",
  "properties": {
    "actualState": "Auto",
    "desiredState": "Auto",
    "options": {
      "createIndex": {
        "actualState": "On",
        "desiredState": "Default",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "dropIndex": {
        "actualState": "Off",
        "desiredState": "Default",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "forceLastGoodPlan": {
        "actualState": "On",
        "desiredState": "Default",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "maintainIndex": {
        "actualState": "Off",
        "desiredState": "Default",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      }
    }
  }
}

Определения

Имя	Описание
AutomaticTuningDisabledReason	Описание причины, если нужное и фактическое состояние отличаются.
AutomaticTuningMode	Требуемое состояние автоматической настройки.
AutomaticTuningOptionModeActual	Фактическое состояние параметра автоматической настройки.
AutomaticTuningOptionModeDesired	Требуемое состояние параметра автоматической настройки.
AutomaticTuningOptions	Свойства автоматической настройки для отдельных помощников.
createdByType	Тип удостоверения, создавшего ресурс.
DatabaseAutomaticTuning	Автоматическая настройка на уровне базы данных.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

AutomaticTuningDisabledReason

Перечисление

Описание причины, если нужное и фактическое состояние отличаются.

Значение	Описание
Default	По умолчанию
Disabled	Disabled
AutoConfigured	Автоматическая конфигурация
InheritedFromServer	InheritedFromServer
QueryStoreOff	QueryStoreOff
QueryStoreReadOnly	ЗапросStoreReadOnly
NotSupported	NotSupported

AutomaticTuningMode

Перечисление

Требуемое состояние автоматической настройки.

Значение	Описание
Inherit	Наследовать
Custom	Настройка
Auto	Auto
Unspecified	Не определено

AutomaticTuningOptionModeActual

Перечисление

Фактическое состояние параметра автоматической настройки.

Значение	Описание
Off	Выкл.
On	Вкл

AutomaticTuningOptionModeDesired

Перечисление

Требуемое состояние параметра автоматической настройки.

Значение	Описание
Off	Выкл.
On	Вкл
Default	По умолчанию

AutomaticTuningOptions

Объект

Свойства автоматической настройки для отдельных помощников.

Имя	Тип	Описание
actualState	AutomaticTuningOptionModeActual	Фактическое состояние параметра автоматической настройки.
desiredState	AutomaticTuningOptionModeDesired	Требуемое состояние параметра автоматической настройки.
reasonCode	integer (int32)	Код причины, если нужно, и фактическое состояние отличаются.
reasonDesc	AutomaticTuningDisabledReason	Описание причины, если нужное и фактическое состояние отличаются.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key