Database Advisors - Update
データベース アドバイザーを更新します。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}?api-version=2025-01-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
advisor
|
path | True |
string |
データベース アドバイザーの名前。 |
|
database
|
path | True |
string |
データベースの名前。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
リソース グループの名前。 名前の大文字と小文字は区別されません。 |
|
server
|
path | True |
string |
サーバーの名前。 |
|
subscription
|
path | True |
string (uuid) |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| properties.autoExecuteStatus | True |
この Advisor の自動実行状態 (システムに推奨事項を実行させるかどうか) を取得します。 有効な値は 'Enabled' と 'Disabled' です |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
Azureの運用は無事に完了しました。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 Flow.
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
Update database advisor
要求のサンプル
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=2025-01-01
{
"properties": {
"autoExecuteStatus": "Disabled"
}
}
応答のサンプル
{
"name": "CreateIndex",
"type": "Microsoft.Sql/servers/databases/advisors",
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/databases/IndexAdvisor_test_3/advisors/CreateIndex",
"properties": {
"advisorStatus": "GA",
"autoExecuteStatus": "Disabled",
"lastChecked": "2017-06-20T00:24:39Z",
"recommendationsStatus": "Ok"
}
}
定義
| 名前 | 説明 |
|---|---|
| Advisor |
データベース、サーバー、またはエラスティック プール アドバイザー。 |
|
Advisor |
顧客に対するこのアドバイザーの可用性の状態を取得します。 指定できる値は、'GA'、'PublicPreview'、'LimitedPublicPreview' および 'PrivatePreview' です。 |
|
Auto |
この Advisor の自動実行状態 (システムに推奨事項を実行させるかどうか) を取得します。 有効な値は 'Enabled' と 'Disabled' です |
|
Auto |
自動実行状態の現在の値が継承されるリソースを取得します。 自動実行の状態は、リソース階層内のさまざまなレベルで設定 (および継承) できます。 指定できる値は、'Subscription'、'Server'、'ElasticPool'、'Database' 、および 'Default' です (状態がどのレベルでも明示的に設定されていない場合)。 |
|
created |
リソースを作成した ID の種類。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
|
Implementation |
この推奨されるアクションを手動で実装できるメソッドを取得します。 たとえば、TSql、AzurePowerShell などです。 |
|
Is |
エラーを無視し、推奨されるアクションを再試行できるかどうかを取得します。 使用可能な値: はい/いいえ |
|
Recommended |
データベース、サーバー、またはエラスティック プールの推奨アクション。 |
|
Recommended |
推奨されるアクションの現在の状態。 一般的に使用される状態には、アクティブ - 推奨されるアクション> アクティブであり、まだ何も実行されていない状態があります。 保留中 -> 推奨されるアクションが承認され、実行を待機しています。 実行中 -> 推奨されるアクションがユーザー データベースに適用されています。 検証 -> 推奨されるアクションが適用され、システムによってその有用性が検証されています。 成功 -> 推奨されるアクションが適用され、検証中に改善が見つかりました。 保留中の元に戻す -> 検証で改善がほとんどまたはまったく見つからなかったため、推奨されるアクションは元に戻すか、ユーザーが手動で元に戻す必要があります。 元に戻す - 推奨されるアクションの適用中に行われた変更>、ユーザー データベースで元に戻されます。 元に戻す -> は、ユーザー データベースで推奨されるアクションによって行われた変更を正常に元に戻しました。 無視 - ユーザー> 明示的に無視/推奨されるアクションを破棄しました。 |
|
Recommended |
Azure SQL Database、サーバー、またはエラスティックプール推奨アクションに関するエラー情報が含まれています。 |
|
Recommended |
Azure SQL Database、サーバー、またはElastic Pool推奨アクションに関する様々な指標に対する推定または観察された影響情報が含まれています。 |
|
Recommended |
Azure SQL Database、Server、またはElastic Pool推奨アクションの手動実装に関する情報が含まれています。 |
|
Recommended |
この推奨アクションの適用の承認がユーザー/システムによって与えられたかどうかを取得します。 |
|
Recommended |
Azure SQL Database、サーバー、またはエラスティックプール推奨アクションに関する様々な影響を受けた指標の時系列を含みます。 |
|
Recommended |
Azure SQL Database、サーバー、またはエラスティックプールの推奨アクションの現在の状態情報が含まれています。 |
|
system |
リソースの作成と最後の変更に関連するメタデータ。 |
Advisor
データベース、サーバー、またはエラスティック プール アドバイザー。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string (arm-id) |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| kind |
string |
リソースの種類。 |
| location |
string |
リソースの場所。 |
| name |
string |
リソースの名前 |
| properties.advisorStatus |
顧客に対するこのアドバイザーの可用性の状態を取得します。 指定できる値は、'GA'、'PublicPreview'、'LimitedPublicPreview' および 'PrivatePreview' です。 |
|
| properties.autoExecuteStatus |
この Advisor の自動実行状態 (システムに推奨事項を実行させるかどうか) を取得します。 有効な値は 'Enabled' と 'Disabled' です |
|
| properties.autoExecuteStatusInheritedFrom |
自動実行状態の現在の値が継承されるリソースを取得します。 自動実行の状態は、リソース階層内のさまざまなレベルで設定 (および継承) できます。 指定できる値は、'Subscription'、'Server'、'ElasticPool'、'Database' 、および 'Default' です (状態がどのレベルでも明示的に設定されていない場合)。 |
|
| properties.lastChecked |
string (date-time) |
現在のリソースがこのアドバイザーによる推奨事項を分析した時刻を取得します。 |
| properties.recommendationsStatus |
string |
このアドバイザーの推奨事項の状態と、推奨事項がない理由を取得します。 使用可能な値には、'OK' (使用可能な推奨事項)、LowActivity (分析に十分なワークロードがありません)、'DbSeemsTuned' (データベースがうまくいっています) などがありますが、これらに限定されません。 |
| properties.recommendedActions |
このアドバイザーに推奨されるアクションを取得します。 |
|
| systemData |
create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。 |
|
| type |
string |
リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」 |
AdvisorStatus
顧客に対するこのアドバイザーの可用性の状態を取得します。 指定できる値は、'GA'、'PublicPreview'、'LimitedPublicPreview' および 'PrivatePreview' です。
| 値 | 説明 |
|---|---|
| GA |
GA |
| PublicPreview |
PublicPreview |
| LimitedPublicPreview |
リミテッドパブリックプレビュー |
| PrivatePreview |
PrivatePreview |
AutoExecuteStatus
この Advisor の自動実行状態 (システムに推奨事項を実行させるかどうか) を取得します。 有効な値は 'Enabled' と 'Disabled' です
| 値 | 説明 |
|---|---|
| Enabled |
有効 |
| Disabled |
Disabled |
| Default |
デフォルト |
AutoExecuteStatusInheritedFrom
自動実行状態の現在の値が継承されるリソースを取得します。 自動実行の状態は、リソース階層内のさまざまなレベルで設定 (および継承) できます。 指定できる値は、'Subscription'、'Server'、'ElasticPool'、'Database' 、および 'Default' です (状態がどのレベルでも明示的に設定されていない場合)。
| 値 | 説明 |
|---|---|
| Default |
デフォルト |
| Subscription |
Subscription |
| Server |
[サーバー] |
| ElasticPool |
エラスティックプール |
| Database |
データベース |
createdByType
リソースを作成した ID の種類。
| 値 | 説明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
ImplementationMethod
この推奨されるアクションを手動で実装できるメソッドを取得します。 たとえば、TSql、AzurePowerShell などです。
| 値 | 説明 |
|---|---|
| TSql |
TSql |
| AzurePowerShell |
AzurePowerShell |
IsRetryable
エラーを無視し、推奨されるアクションを再試行できるかどうかを取得します。 使用可能な値: はい/いいえ
| 値 | 説明 |
|---|---|
| Yes |
はい |
| No |
いいえ |
RecommendedAction
データベース、サーバー、またはエラスティック プールの推奨アクション。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string (arm-id) |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| kind |
string |
リソースの種類。 |
| location |
string |
リソースの場所。 |
| name |
string |
リソースの名前 |
| properties.details |
object |
この推奨されるアクションに固有の追加の詳細を取得します。 |
| properties.errorDetails |
この推奨アクションがエラー状態に設定された場合とその理由について、エラーの詳細を取得します。 |
|
| properties.estimatedImpact |
この推奨されるアクションの推定影響情報を取得します (例: 推定 CPU ゲイン、推定ディスク領域の変更) |
|
| properties.executeActionDuration |
string (duration) |
この推奨されるアクションをユーザー リソースに適用するためにかかった時間を取得します。 たとえば、インデックスの作成にかかった時間などです。 |
| properties.executeActionInitiatedBy |
この推奨アクションの適用の承認がユーザー/システムによって与えられたかどうかを取得します。 |
|
| properties.executeActionInitiatedTime |
string (date-time) |
この推奨アクションの実行が承認された時刻を取得します。 |
| properties.executeActionStartTime |
string (date-time) |
システムがユーザー リソースに対してこの推奨アクションの適用を開始した時刻を取得します。 例: インデックス作成の開始時刻 |
| properties.implementationDetails |
ユーザーが手動で適用するために推奨されるこのアクションの実装の詳細を取得します。 |
|
| properties.isArchivedAction |
boolean |
この推奨されるアクションがしばらく前に提案されたが、ユーザーはこれを無視することを選択し、システムが新しい推奨アクションをもう一度追加したかどうかを取得します。 |
| properties.isExecutableAction |
boolean |
この推奨されるアクションがユーザーによって実行可能かどうかを取得します |
| properties.isRevertableAction |
boolean |
この推奨アクションによって適用された変更をユーザーが元に戻すことができるかどうかを取得します |
| properties.lastRefresh |
string (date-time) |
この推奨アクションが最後に更新された時刻を取得します。 |
| properties.linkedObjects |
string[] |
リンクされたオブジェクト (存在する場合) を取得します。 |
| properties.observedImpact |
この推奨されるアクション (実際の CPU ゲイン、実際のディスク領域の変更など) について、観察/実際の影響情報を取得します。 |
|
| properties.recommendationReason |
string |
このアクションを推奨する理由を取得します。 例: DuplicateIndex |
| properties.revertActionDuration |
string (duration) |
ユーザー リソースに対するこの推奨されるアクションの変更を元に戻すのにかかった時間を取得します。 たとえば、作成されたインデックスを削除するためにかかった時間などです。 |
| properties.revertActionInitiatedBy |
この推奨アクションを元に戻す承認がユーザー/システムによって与えられたかどうかを取得します。 |
|
| properties.revertActionInitiatedTime |
string (date-time) |
この推奨されるアクションが元に戻すのが承認された時刻を取得します。 |
| properties.revertActionStartTime |
string (date-time) |
ユーザー リソースに対するこの推奨されるアクションの変更をシステムが元に戻し始めた時刻を取得します。 たとえば、インデックスの削除が実行される時刻などです。 |
| properties.score |
integer (int32) |
この推奨されるアクションの影響を取得します。 使用可能な値は、1 - 低衝撃、2 - 中程度の影響、3 - 影響度の高い値です。 |
| properties.state |
推奨されるアクションの現在の状態の情報を取得します。 |
|
| properties.timeSeries |
この推奨されるアクションのメトリックの時系列情報 (CPU 消費量の時系列など) を取得します。 |
|
| properties.validSince |
string (date-time) |
この推奨アクションが有効な時刻を取得します。 |
| systemData |
create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。 |
|
| type |
string |
リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」 |
RecommendedActionCurrentState
推奨されるアクションの現在の状態。 一般的に使用される状態には、アクティブ - 推奨されるアクション> アクティブであり、まだ何も実行されていない状態があります。 保留中 -> 推奨されるアクションが承認され、実行を待機しています。 実行中 -> 推奨されるアクションがユーザー データベースに適用されています。 検証 -> 推奨されるアクションが適用され、システムによってその有用性が検証されています。 成功 -> 推奨されるアクションが適用され、検証中に改善が見つかりました。 保留中の元に戻す -> 検証で改善がほとんどまたはまったく見つからなかったため、推奨されるアクションは元に戻すか、ユーザーが手動で元に戻す必要があります。 元に戻す - 推奨されるアクションの適用中に行われた変更>、ユーザー データベースで元に戻されます。 元に戻す -> は、ユーザー データベースで推奨されるアクションによって行われた変更を正常に元に戻しました。 無視 - ユーザー> 明示的に無視/推奨されるアクションを破棄しました。
| 値 | 説明 |
|---|---|
| Active |
アクティブ |
| Pending |
保留中 |
| Executing |
実行 |
| Verifying |
検証 |
| PendingRevert |
PendingRevert |
| RevertCancelled |
RevertCancelled |
| Reverting |
リバート |
| Reverted |
復活 |
| Ignored |
無視 |
| Expired |
有効期限切れ |
| Monitoring |
モニタリング |
| Resolved |
解決済み |
| Success |
成功 |
| Error |
エラー |
RecommendedActionErrorInfo
Azure SQL Database、サーバー、またはエラスティックプール推奨アクションに関するエラー情報が含まれています。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
推奨されるアクションがエラー状態になった理由を取得します。 例: DatabaseHasQdsOff、IndexAlreadyExists |
| isRetryable |
エラーを無視し、推奨されるアクションを再試行できるかどうかを取得します。 使用可能な値: はい/いいえ |
RecommendedActionImpactRecord
Azure SQL Database、サーバー、またはElastic Pool推奨アクションに関する様々な指標に対する推定または観察された影響情報が含まれています。
| 名前 | 型 | 説明 |
|---|---|---|
| absoluteValue |
number (double) |
該当する場合は、このディメンションの絶対値を取得します。 例: 影響を受けるクエリの数 |
| changeValueAbsolute |
number (double) |
このディメンションの値の絶対変更を取得します。 たとえば、絶対ディスク領域の変更 (メガバイト単位) |
| changeValueRelative |
number (double) |
このディメンションの値の相対的な変更を取得します。 たとえば、相対ディスク領域の変化 (パーセンテージ) |
| dimensionName |
string |
影響ディメンションの名前を取得します。 たとえば、CPUChange、DiskSpaceChange、NumberOfQueriesAffected などです。 |
| unit |
string |
影響ディメンションの名前を取得します。 たとえば、CPUChange、DiskSpaceChange、NumberOfQueriesAffected などです。 |
RecommendedActionImplementationInfo
Azure SQL Database、Server、またはElastic Pool推奨アクションの手動実装に関する情報が含まれています。
| 名前 | 型 | 説明 |
|---|---|---|
| method |
この推奨されるアクションを手動で実装できるメソッドを取得します。 たとえば、TSql、AzurePowerShell などです。 |
|
| script |
string |
手動実装スクリプトを取得します。 たとえば、データベースで実行できる T-SQL スクリプトなどです。 |
RecommendedActionInitiatedBy
この推奨アクションの適用の承認がユーザー/システムによって与えられたかどうかを取得します。
| 値 | 説明 |
|---|---|
| User |
User |
| System |
システム |
RecommendedActionMetricInfo
Azure SQL Database、サーバー、またはエラスティックプール推奨アクションに関する様々な影響を受けた指標の時系列を含みます。
| 名前 | 型 | 説明 |
|---|---|---|
| metricName |
string |
メトリックの名前を取得します。 たとえば、CPU、クエリの数などです。 |
| startTime |
string (date-time) |
この MetricInfo によって指定された時間間隔の開始時刻を取得します。 |
| timeGrain |
string |
この MetricInfo によって指定された値の時間間隔の期間を取得します。 例: PT1H (1 時間) |
| unit |
string |
メトリックを測定する単位を取得します。 例: DTU、Frequency |
| value |
number (double) |
この MetricInfo によって指定された時間間隔内のメトリックの値を取得します。 |
RecommendedActionStateInfo
Azure SQL Database、サーバー、またはエラスティックプールの推奨アクションの現在の状態情報が含まれています。
| 名前 | 型 | 説明 |
|---|---|---|
| actionInitiatedBy |
この推奨アクションの実行を開始したユーザーを取得します。 使用可能な値は、ユーザー -> ユーザーが推奨されるアクションを適用するようにシステムに明示的に通知したときです。 システム -> このアドバイザーの自動実行状態が "有効" に設定されている場合、その場合はシステムによって適用されます。 |
|
| currentValue |
推奨されるアクションの現在の状態。 一般的に使用される状態には、アクティブ - 推奨されるアクション> アクティブであり、まだ何も実行されていない状態があります。 保留中 -> 推奨されるアクションが承認され、実行を待機しています。 実行中 -> 推奨されるアクションがユーザー データベースに適用されています。 検証 -> 推奨されるアクションが適用され、システムによってその有用性が検証されています。 成功 -> 推奨されるアクションが適用され、検証中に改善が見つかりました。 保留中の元に戻す -> 検証で改善がほとんどまたはまったく見つからなかったため、推奨されるアクションは元に戻すか、ユーザーが手動で元に戻す必要があります。 元に戻す - 推奨されるアクションの適用中に行われた変更>、ユーザー データベースで元に戻されます。 元に戻す -> は、ユーザー データベースで推奨されるアクションによって行われた変更を正常に元に戻しました。 無視 - ユーザー> 明示的に無視/推奨されるアクションを破棄しました。 |
|
| lastModified |
string (date-time) |
状態が最後に変更された時刻を取得します。 |
systemData
リソースの作成と最後の変更に関連するメタデータ。
| 名前 | 型 | 説明 |
|---|---|---|
| createdAt |
string (date-time) |
リソース作成のタイムスタンプ (UTC)。 |
| createdBy |
string |
リソースを作成した ID。 |
| createdByType |
リソースを作成した ID の種類。 |
|
| lastModifiedAt |
string (date-time) |
リソースの最終変更のタイムスタンプ (UTC) |
| lastModifiedBy |
string |
リソースを最後に変更した ID。 |
| lastModifiedByType |
リソースを最後に変更した ID の種類。 |