你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Database Automatic Tuning - Update

更新目标数据库的自动优化属性。

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

包含资源的资源组的名称。 可以从 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

ErrorResponse

错误响应: ***

  • 400 FeatureDisabledOnSelectedEdition - 用户尝试使用当前数据库版本上禁用的功能。

  • 400 InvalidIdentifier - 标识符包含 NULL 或无效的 unicode 字符。

  • 400 SystemDatabasesNotSupported - 用户尝试获取系统数据库上的自动优化信息。

  • 400 DataWarehouseNotSupported - SQL 数据仓库不支持自动优化。

  • 400 InvalidAutomaticTuningUpsertRequest - 更新自动优化请求正文不存在或没有属性对象。

  • 400 InvalidAdvisorAutoExecuteStatus - 不允许为顾问指定自动执行状态。

  • 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器

  • 404 DatabaseDoesNotExist - 找不到请求的数据库

  • 404 SubscriptionDoesNotHaveElasticPool - 找不到请求的弹性池

  • 404 OperationIdNotFound - ID作不存在。

  • 404 AutomaticTuningOptionNotFound - 找不到请求的自动优化选项。

  • 405 NotSupported - 不支持此功能。

  • 409 冲突 - 由于请求中的冲突,无法处理请求。

  • 409 CannotCancelOperation - 管理作处于无法取消的状态。

  • 409 OperationCancelled -作已被用户取消。

  • 409 OperationInterrupted - 无法完成资源上的作,因为它被同一资源上的另一个作中断。

  • 409 DefaultAdvisorStateNotAllowedInCustomDbMode - CUSTOM 模式下不允许默认顾问状态

  • 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

示例请求

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

示例响应

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

示例请求

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

示例响应

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

资源 ID。

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

错误对象。