Database Advisors - Update

服务:

SQL Database

API 版本:

2023-08-01

更新数据库顾问。

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

URI 参数

名称	在	必需	类型	说明
advisorName	path	True	string	数据库顾问的名称。
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.autoExecuteStatus	True	AutoExecuteStatus	获取此顾问的自动执行状态（是否让系统执行建议）。 可能的值为“Enabled”和“Disabled”

响应

名称	类型	说明
200 OK	Advisor	已成功更新指定的数据库顾问。
Other Status Codes	ErrorResponse	错误响应： *** 400 FeatureDisabledOnSelectedEdition - 用户尝试使用当前数据库版本上禁用的功能。 400 InvalidIdentifier - 标识符包含 NULL 或无效的 unicode 字符。 400 DataWarehouseNotSupported - SQL 数据仓库不支持自动优化。 400 InvalidAdvisorUpsertRequest - 更新顾问请求正文不存在或没有属性对象。 400 InvalidAdvisorAutoExecuteStatus - 不允许为顾问指定自动执行状态。 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器 404 DatabaseDoesNotExist - 找不到请求的数据库 404 SubscriptionDoesNotHaveElasticPool - 找不到请求的弹性池 404 AdvisorNotFound - 找不到请求的顾问。 404 AutomaticTuningOptionNotFound - 找不到请求的自动优化选项。 405 NotSupported - 不支持此功能。 409 冲突 - 由于请求中的冲突，无法处理请求。 409 DefaultAdvisorStateNotAllowedInCustomDbMode - CUSTOM 模式下不允许默认顾问状态 409 DisabledBySystem - 系统禁用此选项 503 ServiceTemporarilyUnavailable - 功能暂时不可用。

示例

Update database advisor

示例请求

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/databases/IndexAdvisor_test_3/advisors/CreateIndex?api-version=2023-08-01

{
  "properties": {
    "autoExecuteStatus": "Disabled"
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/DatabaseAdvisorUpdate.json
// this example is just showing the usage of "DatabaseAdvisors_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseAdvisorResource created on azure
// for more information of creating SqlDatabaseAdvisorResource, please refer to the document of SqlDatabaseAdvisorResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "workloadinsight-demos";
string serverName = "misosisvr";
string databaseName = "IndexAdvisor_test_3";
string advisorName = "CreateIndex";
ResourceIdentifier sqlDatabaseAdvisorResourceId = SqlDatabaseAdvisorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, advisorName);
SqlDatabaseAdvisorResource sqlDatabaseAdvisor = client.GetSqlDatabaseAdvisorResource(sqlDatabaseAdvisorResourceId);

// invoke the operation
SqlAdvisorData data = new SqlAdvisorData
{
    AutoExecuteStatus = AutoExecuteStatus.Disabled,
};
SqlDatabaseAdvisorResource result = await sqlDatabaseAdvisor.UpdateAsync(data);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlAdvisorData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/databases/IndexAdvisor_test_3/advisors/CreateIndex",
  "name": "CreateIndex",
  "type": "Microsoft.Sql/servers/databases/advisors",
  "properties": {
    "advisorStatus": "GA",
    "autoExecuteStatus": "Disabled",
    "recommendationsStatus": "Ok",
    "lastChecked": "2017-06-20T00:24:39Z"
  }
}

定义

名称	说明
Advisor	数据库、服务器或弹性池顾问。
AdvisorStatus	获取此顾问对客户的可用性状态。 可能的值为“GA”、“PublicPreview”、“LimitedPublicPreview”和“PrivatePreview”。
AutoExecuteStatus	获取此顾问的自动执行状态（是否让系统执行建议）。 可能的值为“Enabled”和“Disabled”
AutoExecuteStatusInheritedFrom	获取从中继承自动执行状态的当前值的资源。 可以在资源层次结构中的不同级别上设置自动执行状态（并从中继承）。 可能的值为“Subscription”、“Server”、“ElasticPool”、“Database”和“Default”（如果未在任何级别显式设置状态）。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ImplementationMethod	获取可手动实现此建议作的方法。 例如，TSql、AzurePowerShell。
IsRetryable	获取是否可以忽略错误并重试建议的作。 可能的值为：是/否
RecommendedAction	数据库、服务器或弹性池建议的作。
RecommendedActionCurrentState	建议的作处于当前状态。 一些常用的状态是：活动 -> 建议的作处于活动状态，但尚未采取任何作。 挂起 -> 建议的作已批准并正在等待执行。 正在执行 -> 建议的作应用于用户数据库。 正在验证 -> 已应用建议的作，并且系统正在验证其有用性。 成功 -> 验证期间已应用建议的作和改进。 挂起还原 -> 验证发现很少或没有改进，因此建议的作排队等待还原或用户手动还原。 正在还原 - 在用户数据库上还原应用建议作时所做的> 更改。 已还原 -> 已成功还原对用户数据库的建议作所做的更改。 忽略 -> 用户显式忽略/放弃建议的作。
RecommendedActionErrorInfo	包含 Azure SQL 数据库、服务器或弹性池建议作的错误信息。
RecommendedActionImpactRecord	包含对 Azure SQL 数据库、服务器或弹性池建议作的各种指标的估计或观察到的影响的信息。
RecommendedActionImplementationInfo	包含有关 Azure SQL 数据库、服务器或弹性池推荐作的手动实现的信息。
RecommendedActionInitiatedBy	获取谁启动了此建议作的执行。 可能的值是：用户 -> 当用户显式通知系统应用建议的作时。 系统 -> 当此顾问的自动执行状态设置为“已启用”时，在这种情况下，系统会应用它。
RecommendedActionMetricInfo	包含 Azure SQL 数据库、服务器或弹性池建议作的各种受影响的指标的时序。
RecommendedActionStateInfo	包含 Azure SQL 数据库、服务器或弹性池建议作的当前状态的信息。

Advisor

Object

数据库、服务器或弹性池顾问。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
location	string	资源位置。
name	string	资源名称。
properties.advisorStatus	AdvisorStatus	获取此顾问对客户的可用性状态。 可能的值为“GA”、“PublicPreview”、“LimitedPublicPreview”和“PrivatePreview”。
properties.autoExecuteStatus	AutoExecuteStatus	获取此顾问的自动执行状态（是否让系统执行建议）。 可能的值为“Enabled”和“Disabled”
properties.autoExecuteStatusInheritedFrom	AutoExecuteStatusInheritedFrom	获取从中继承自动执行状态的当前值的资源。 可以在资源层次结构中的不同级别上设置自动执行状态（并从中继承）。 可能的值为“Subscription”、“Server”、“ElasticPool”、“Database”和“Default”（如果未在任何级别显式设置状态）。
properties.lastChecked	string (date-time)	获取此顾问分析当前资源的建议的时间。
properties.recommendationsStatus	string	获取此顾问的建议状态，以及没有任何建议的原因。 可能的值包括但不限于“确定”（可用建议）、LowActivity（没有足够的工作负载进行分析）、“DbSeemsTuned”（数据库运行良好）等。
properties.recommendedActions	RecommendedAction[]	获取此顾问的建议作。
type	string	资源类型。

AdvisorStatus

枚举

获取此顾问对客户的可用性状态。 可能的值为“GA”、“PublicPreview”、“LimitedPublicPreview”和“PrivatePreview”。

值	说明
GA
PublicPreview
LimitedPublicPreview
PrivatePreview

AutoExecuteStatus

枚举

获取此顾问的自动执行状态（是否让系统执行建议）。 可能的值为“Enabled”和“Disabled”

值	说明
Enabled
Disabled
Default

AutoExecuteStatusInheritedFrom

枚举

获取从中继承自动执行状态的当前值的资源。 可以在资源层次结构中的不同级别上设置自动执行状态（并从中继承）。 可能的值为“Subscription”、“Server”、“ElasticPool”、“Database”和“Default”（如果未在任何级别显式设置状态）。

值	说明
Default
Subscription
Server
ElasticPool
Database

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ImplementationMethod

枚举

获取可手动实现此建议作的方法。 例如，TSql、AzurePowerShell。

值	说明
TSql
AzurePowerShell

IsRetryable

枚举

获取是否可以忽略错误并重试建议的作。 可能的值为：是/否

值	说明
Yes
No

RecommendedAction

Object

数据库、服务器或弹性池建议的作。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
location	string	资源位置。
name	string	资源名称。
properties.details	object	获取特定于此建议作的其他详细信息。
properties.errorDetails	RecommendedActionErrorInfo	获取错误详细信息，以及为什么将此建议的作置于错误状态。
properties.estimatedImpact	RecommendedActionImpactRecord[]	获取此建议作的估计影响信息，例如估计 CPU 增益、估计磁盘空间更改
properties.executeActionDuration	string (duration)	获取对用户资源应用此建议作所需的时间。 例如，创建索引所需的时间
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	获取用户/系统是否批准应用此建议作。
properties.executeActionInitiatedTime	string (date-time)	获取批准执行此建议作的时间。
properties.executeActionStartTime	string (date-time)	获取系统开始对用户资源应用此建议作的时间。 例如索引创建开始时间
properties.implementationDetails	RecommendedActionImplementationInfo	获取此建议作的实现详细信息，供用户手动应用。
properties.isArchivedAction	boolean	获取此建议作是否在一段时间前建议，但用户选择忽略此作，并且系统再次添加了新的建议作。
properties.isExecutableAction	boolean	获取此建议的作是否可由用户作
properties.isRevertableAction	boolean	获取用户是否可以还原此建议作应用的更改
properties.lastRefresh	string (date-time)	获取上次刷新此建议作的时间。
properties.linkedObjects	string[]	获取链接的对象（如果有）。
properties.observedImpact	RecommendedActionImpactRecord[]	获取此建议作的观察到/实际影响信息，例如实际 CPU 增益、实际磁盘空间更改
properties.recommendationReason	string	获取建议此作的原因。 例如，DuplicateIndex
properties.revertActionDuration	string (duration)	获取在用户资源上还原此建议作更改所花费的时间。 例如，删除创建的索引所需的时间。
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	获取用户/系统是否批准还原此建议作。
properties.revertActionInitiatedTime	string (date-time)	获取批准此建议作进行还原的时间。
properties.revertActionStartTime	string (date-time)	获取系统开始在用户资源上还原此建议作更改的时间。 例如，执行索引删除的时间。
properties.score	integer (int32)	获取此建议作的影响。 可能的值为 1 - 低影响，2 - 中等影响和 3 - 高影响
properties.state	RecommendedActionStateInfo	获取建议作处于的当前状态的信息。
properties.timeSeries	RecommendedActionMetricInfo[]	获取此建议作的指标的时序信息，例如 CPU 消耗时序
properties.validSince	string (date-time)	获取自此建议作有效以来的时间。
type	string	资源类型。

RecommendedActionCurrentState

枚举

建议的作处于当前状态。 一些常用的状态是：活动 -> 建议的作处于活动状态，但尚未采取任何作。 挂起 -> 建议的作已批准并正在等待执行。 正在执行 -> 建议的作应用于用户数据库。 正在验证 -> 已应用建议的作，并且系统正在验证其有用性。 成功 -> 验证期间已应用建议的作和改进。 挂起还原 -> 验证发现很少或没有改进，因此建议的作排队等待还原或用户手动还原。 正在还原 - 在用户数据库上还原应用建议作时所做的> 更改。 已还原 -> 已成功还原对用户数据库的建议作所做的更改。 忽略 -> 用户显式忽略/放弃建议的作。

值	说明
Active
Pending
Executing
Verifying
PendingRevert
RevertCancelled
Reverting
Reverted
Ignored
Expired
Monitoring
Resolved
Success
Error

RecommendedActionErrorInfo

Object

包含 Azure SQL 数据库、服务器或弹性池建议作的错误信息。

名称	类型	说明
errorCode	string	获取将建议的作置于错误状态的原因。 例如，DatabaseHasQdsOff、IndexAlreadyExists
isRetryable	IsRetryable	获取是否可以忽略错误并重试建议的作。 可能的值为：是/否

RecommendedActionImpactRecord

Object

包含对 Azure SQL 数据库、服务器或弹性池建议作的各种指标的估计或观察到的影响的信息。

名称	类型	说明
absoluteValue	number (double)	获取此维度的绝对值（如果适用）。 例如受影响的查询数
changeValueAbsolute	number (double)	获取此维度的值的绝对更改。 例如，以兆字节为单位的绝对磁盘空间更改
changeValueRelative	number (double)	获取此维度的值的相对更改。 例如，相对磁盘空间更改（以百分比为单位）
dimensionName	string	获取影响维度的名称。 例如，CPUChange、DiskSpaceChange、NumberOfQueriesAffected。
unit	string	获取影响维度的名称。 例如，CPUChange、DiskSpaceChange、NumberOfQueriesAffected。

RecommendedActionImplementationInfo

Object

包含有关 Azure SQL 数据库、服务器或弹性池推荐作的手动实现的信息。

名称	类型	说明
method	ImplementationMethod	获取可手动实现此建议作的方法。 例如，TSql、AzurePowerShell。
script	string	获取手动实现脚本。 例如，可以在数据库上执行的 T-SQL 脚本。

RecommendedActionInitiatedBy

枚举

获取谁启动了此建议作的执行。 可能的值是：用户 -> 当用户显式通知系统应用建议的作时。 系统 -> 当此顾问的自动执行状态设置为“已启用”时，在这种情况下，系统会应用它。

值	说明
User
System

RecommendedActionMetricInfo

Object

包含 Azure SQL 数据库、服务器或弹性池建议作的各种受影响的指标的时序。

名称	类型	说明
metricName	string	获取指标的名称。 例如 CPU、查询数。
startTime	string (date-time)	获取此 MetricInfo 给出的时间间隔的开始时间。
timeGrain	string	获取此 MetricInfo 给出的值的时间间隔持续时间。 例如 PT1H （1 小时）
unit	string	获取度量指标的单位。 例如，DTU、频率
value	number (double)	获取此 MetricInfo 给出的时间间隔内指标的值。

RecommendedActionStateInfo

Object

包含 Azure SQL 数据库、服务器或弹性池建议作的当前状态的信息。

名称	类型	说明
actionInitiatedBy	RecommendedActionInitiatedBy	获取谁启动了此建议作的执行。 可能的值是：用户 -> 当用户显式通知系统应用建议的作时。 系统 -> 当此顾问的自动执行状态设置为“已启用”时，在这种情况下，系统会应用它。
currentValue	RecommendedActionCurrentState	建议的作处于当前状态。 一些常用的状态是：活动 -> 建议的作处于活动状态，但尚未采取任何作。 挂起 -> 建议的作已批准并正在等待执行。 正在执行 -> 建议的作应用于用户数据库。 正在验证 -> 已应用建议的作，并且系统正在验证其有用性。 成功 -> 验证期间已应用建议的作和改进。 挂起还原 -> 验证发现很少或没有改进，因此建议的作排队等待还原或用户手动还原。 正在还原 - 在用户数据库上还原应用建议作时所做的> 更改。 已还原 -> 已成功还原对用户数据库的建议作所做的更改。 忽略 -> 用户显式忽略/放弃建议的作。
lastModified	string (date-time)	获取上次修改状态的时间