Database Automatic Tuning - Update

Служба:

SQL Database

Версия API:

2023-08-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
databaseName	path	True	string	Имя базы данных.
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки, идентифицирующий подписку Azure.
api-version	query	True	string	Версия API, используемая для запроса.

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

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

Ответы

Имя	Тип	Описание
200 OK	DatabaseAutomaticTuning	Успешно обновлены указанные параметры автоматической настройки базы данных.
Other Status Codes	ErrorResponse	Ответы на ошибки: *** 400 FeatureDisabledOnSelectedEdition — пользователь попытался использовать функцию, которая отключена в текущем выпуске базы данных. 400 InvalidIdentifier — идентификатор содержит значение NULL или недопустимый символ юникода. 400 SystemDatabasesNotSupported— пользователь пытался получить сведения о автоматической настройке системных баз данных. 400 DataWarehouseNotSupported. Автоматическая настройка не поддерживается для хранилища данных SQL. 400 InvalidAutomaticTuningUpsertRequest — текст запроса автоматической настройки обновления не существует или не имеет объекта свойств. 400 InvalidAdvisorAutoExecuteStatus — указанное состояние автоматического выполнения для помощника запрещено. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 DatabaseDoesNotExist — запрошенная база данных не найдена 404 SubscriptionDoesNotHaveElasticPool — запрошенный эластичные пулы не найдены 404 OperationIdNotFound — операция с идентификатором не существует. 404 AutomaticTuningOptionNotFound — запрошенный параметр автоматической настройки не найден. 405 NotSupported — эта функция не поддерживается. Конфликт 409. Не удалось обработать запрос из-за конфликта в запросе. 409 CannotCancelOperation — операция управления находится в состоянии, которое не может быть отменено. 409 OperationCancelled — операция отменена пользователем. 409 Operation Прервана — операция с ресурсом не удалось завершить, так как она была прервана другой операцией в том же ресурсе. 409 DefaultAdvisorStateNotAllowedInCustomDbMode — состояние помощника по УМОЛЧАНИю запрещено в пользовательском режиме 409 DisabledBySystem — этот параметр отключен системой 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

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

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=2023-08-01

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

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

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

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

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=2023-08-01

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

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

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

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	Автоматическая настройка на уровне базы данных.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку

AutomaticTuningDisabledReason

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

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

Значение	Описание
Default
Disabled
AutoConfigured
InheritedFromServer
QueryStoreOff
QueryStoreReadOnly
NotSupported

AutomaticTuningMode

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

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

Значение	Описание
Inherit
Custom
Auto
Unspecified

AutomaticTuningOptionModeActual

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

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

Значение	Описание
Off
On

AutomaticTuningOptionModeDesired

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

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

Значение	Описание
Off
On
Default

AutomaticTuningOptions

Объект

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

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

DatabaseAutomaticTuning

Объект

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

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

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.