Database Recommended Actions - Update

リファレンス

サービス:: SQL Database

API バージョン:: 2021-11-01

データベース推奨アクションを更新します。

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

URI パラメーター

名前	/	必須	型	説明
advisorName	path	True	string	データベースアドバイザーの名前。
databaseName	path	True	string	データベースの名前。
recommendedActionName	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.state	True	RecommendedActionStateInfo	推奨されるアクションの現在の状態の情報を取得します。

応答

名前	型	説明
200 OK	RecommendedAction	指定されたデータベース推奨アクションが正常に更新されました。
Other Status Codes		エラー応答: *** 400 FeatureDisabledOnSelectedEdition - ユーザーは、現在のデータベースエディションで無効になっている機能を使用しようとしました。 400 InvalidIdentifier - 識別子に NULL または無効な Unicode 文字が含まれています。 400 InvalidRecommendedActionUpsertRequest - 更新推奨アクション要求本文が存在しないか、プロパティまたは状態オブジェクトがありません。 400 InvalidRecommendedActionState - 推奨されるアクションの指定された状態が無効です 404 DatabaseDoesNotExist - 要求されたデータベースが見つかりませんでした 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 SubscriptionDoesNotHaveElasticPool - 要求されたエラスティックプールが見つかりませんでした 404 AdvisorNotFound - 要求されたアドバイザーが見つかりませんでした。 404 RecommendedActionNotFound - 要求された推奨アクションが見つかりませんでした。 404 AdvisorNotFound - 要求されたアドバイザーが見つかりませんでした。 404 RecommendedActionNotFound - 要求された推奨アクションが見つかりませんでした。 405 NotSupported - この機能はサポートされていません。 409 競合 - 要求の競合が原因で要求を処理できませんでした。 503 ServiceTemporarilyUnavailable - 機能を一時的に使用できません。

名前

型

説明

200 OK

RecommendedAction

指定されたデータベース推奨アクションが正常に更新されました。

Other Status Codes

エラー応答: ***

400 FeatureDisabledOnSelectedEdition - ユーザーは、現在のデータベースエディションで無効になっている機能を使用しようとしました。
400 InvalidIdentifier - 識別子に NULL または無効な Unicode 文字が含まれています。
400 InvalidRecommendedActionUpsertRequest - 更新推奨アクション要求本文が存在しないか、プロパティまたは状態オブジェクトがありません。
400 InvalidRecommendedActionState - 推奨されるアクションの指定された状態が無効です
404 DatabaseDoesNotExist - 要求されたデータベースが見つかりませんでした
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 SubscriptionDoesNotHaveElasticPool - 要求されたエラスティックプールが見つかりませんでした
404 AdvisorNotFound - 要求されたアドバイザーが見つかりませんでした。
404 RecommendedActionNotFound - 要求された推奨アクションが見つかりませんでした。
404 AdvisorNotFound - 要求されたアドバイザーが見つかりませんでした。
404 RecommendedActionNotFound - 要求された推奨アクションが見つかりませんでした。
405 NotSupported - この機能はサポートされていません。
409 競合 - 要求の競合が原因で要求を処理できませんでした。
503 ServiceTemporarilyUnavailable - 機能を一時的に使用できません。

例

Update database recommended action

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/recommendedActions/IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB?api-version=2021-11-01

{
  "properties": {
    "state": {
      "currentValue": "Pending"
    }
  }
}


import com.azure.resourcemanager.sql.fluent.models.RecommendedActionInner;
import com.azure.resourcemanager.sql.models.RecommendedActionCurrentState;
import com.azure.resourcemanager.sql.models.RecommendedActionStateInfo;

/**
 * Samples for DatabaseRecommendedActions Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseRecommendedActionUpdate.json
     */
    /**
     * Sample code: Update database recommended action.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateDatabaseRecommendedAction(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseRecommendedActions().updateWithResponse(
            "workloadinsight-demos", "misosisvr", "IndexAdvisor_test_3", "CreateIndex",
            "IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB",
            new RecommendedActionInner()
                .withState(new RecommendedActionStateInfo().withCurrentValue(RecommendedActionCurrentState.PENDING)),
            com.azure.core.util.Context.NONE);
    }
}

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/recommendedActions/IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB",
  "name": "IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB",
  "type": "Microsoft.Sql/servers/databases/advisors/recommendedActions",
  "location": "East Asia",
  "kind": "",
  "properties": {
    "recommendationReason": "",
    "validSince": "2017-03-01T14:38:04Z",
    "lastRefresh": "2017-03-01T14:38:04Z",
    "state": {
      "currentValue": "Pending",
      "actionInitiatedBy": "User",
      "lastModified": "2017-06-20T15:11:15Z"
    },
    "isExecutableAction": true,
    "isRevertableAction": true,
    "isArchivedAction": false,
    "executeActionInitiatedBy": "User",
    "executeActionInitiatedTime": "2017-06-20T15:11:15Z",
    "score": 1,
    "implementationDetails": {
      "method": "TSql",
      "script": "CREATE NONCLUSTERED INDEX [nci_wi_DataPoints_B892614093BAC56295EF6018BD4CB51B] ON [CRM].[DataPoints] ([Name],[Money],[Power]) INCLUDE ([Hour], [System], [LastChanged]) WITH (ONLINE = ON)"
    },
    "errorDetails": {},
    "estimatedImpact": [
      {
        "dimensionName": "ActionDuration",
        "unit": "Seconds",
        "absoluteValue": 1440
      },
      {
        "dimensionName": "SpaceChange",
        "unit": "Megabytes",
        "absoluteValue": 209.3125
      }
    ],
    "observedImpact": [],
    "timeSeries": [],
    "details": {
      "indexName": "nci_wi_DataPoints_B892614093BAC56295EF6018BD4CB51B",
      "indexType": "NONCLUSTERED",
      "schema": "[CRM]",
      "table": "[DataPoints]",
      "indexColumns": "[Name],[Money],[Power]",
      "includedColumns": "[Hour], [System], [LastChanged]"
    }
  }
}

定義

名前	説明
ImplementationMethod	この推奨アクションを手動で実装できるメソッドを取得します。たとえば、TSql、AzurePowerShell などです。
IsRetryable	エラーを無視し、推奨されるアクションを再試行できるかどうかを取得します。使用可能な値: はい/いいえ
RecommendedAction	データベース、サーバー、またはエラスティックプールの推奨アクション。
RecommendedActionCurrentState	推奨されるアクションの現在の状態。一般的に使用される状態の一部は次のとおりです。アクティブ -> 推奨アクションはアクティブであり、アクションはまだ実行されていません。保留中 -> 推奨されるアクションはに対して承認され、実行を待機しています。実行中 -> 推奨されるアクションがユーザーデータベースに適用されています。検証 -> 推奨されるアクションが適用され、システムによってその有用性が検証されています。成功 -> 推奨されるアクションが適用され、検証中に改善が見つかりました。保留中の元に戻す -> 検証で改善がほとんどまたはまったく見つからなかったため、推奨されるアクションは元に戻すか、ユーザーが手動で元に戻すキューに入れられます。元に戻す -> 推奨されるアクションの適用中に行われた変更は、ユーザーデータベースで元に戻されます。 [元に戻す] -> ユーザーデータベースで推奨されるアクションによって行われた変更が正常に元に戻されました。 [無視] -> ユーザーは推奨されるアクションを明示的に無視または破棄しました。
RecommendedActionErrorInfo	Azure SQL データベース、サーバー、またはエラスティックプールの推奨アクションに関するエラー情報が含まれています。
RecommendedActionImpactRecord	Azure SQL データベース、サーバー、またはエラスティックプールの推奨アクションのさまざまなメトリックに対する推定または観察された影響に関する情報が含まれます。
RecommendedActionImplementationInfo	Azure SQL データベース、サーバー、またはエラスティックプールの推奨アクションの手動実装に関する情報が含まれています。
RecommendedActionInitiatedBy	この推奨アクションの実行を開始したユーザーを取得します。指定できる値は、User -> 推奨されるアクションを適用するようにユーザーが明示的にシステムに通知したときです。システム -> このアドバイザーの自動実行状態が "有効" に設定されている場合、システムによって適用されました。
RecommendedActionMetricInfo	Azure SQL データベース、サーバー、またはエラスティックプールの推奨アクションに対する影響を受けたさまざまなメトリックの時系列が含まれています。
RecommendedActionStateInfo	Azure SQL データベース、サーバー、またはエラスティックプールの推奨アクションの現在の状態の情報が含まれます。

ImplementationMethod

この推奨アクションを手動で実装できるメソッドを取得します。たとえば、TSql、AzurePowerShell などです。

名前	型	説明
AzurePowerShell	string
TSql	string

IsRetryable

エラーを無視し、推奨されるアクションを再試行できるかどうかを取得します。使用可能な値: はい/いいえ

名前	型	説明
No	string
Yes	string

RecommendedAction

データベース、サーバー、またはエラスティックプールの推奨アクション。

名前	型	説明
id	string	リソースの ID
kind	string	リソースの種類。
location	string	リソースの場所。
name	string	リソース名。
properties.details	object	この推奨されるアクションに固有の追加の詳細を取得します。
properties.errorDetails	RecommendedActionErrorInfo	この推奨されるアクションがエラー状態に設定された場合とその理由を示すエラーの詳細を取得します。
properties.estimatedImpact	RecommendedActionImpactRecord[]	この推奨されるアクションの推定影響情報 (推定 CPU ゲイン、推定ディスク領域の変更など) を取得します
properties.executeActionDuration	string	この推奨アクションをユーザーリソースに適用するためにかかった時間を取得します。たとえば、インデックスの作成にかかった時間
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	この推奨アクションの適用の承認がユーザーまたはシステムによって与えられたかどうかを取得します。
properties.executeActionInitiatedTime	string	この推奨アクションの実行が承認された時刻を取得します。
properties.executeActionStartTime	string	システムがユーザーリソースにこの推奨アクションの適用を開始した時刻を取得します。例: インデックス作成の開始時刻
properties.implementationDetails	RecommendedActionImplementationInfo	ユーザーが手動で適用するために推奨されるこのアクションの実装の詳細を取得します。
properties.isArchivedAction	boolean	この推奨されるアクションがしばらく前に提案されたが、ユーザーがこのアクションを無視することを選択し、システムによって新しい推奨アクションが再び追加されたかどうかを取得します。
properties.isExecutableAction	boolean	この推奨されるアクションがユーザーが操作可能かどうかを取得します
properties.isRevertableAction	boolean	この推奨アクションによって適用された変更をユーザーが元に戻すことができるかどうかを取得します
properties.lastRefresh	string	この推奨アクションが最後に更新された時刻を取得します。
properties.linkedObjects	string[]	リンクされたオブジェクト (存在する場合) を取得します。
properties.observedImpact	RecommendedActionImpactRecord[]	この推奨されるアクション (実際の CPU ゲイン、実際のディスク領域の変更など) の観測/実際の影響情報を取得します
properties.recommendationReason	string	このアクションを推奨する理由を取得します。例: DuplicateIndex
properties.revertActionDuration	string	ユーザーリソースに対するこの推奨アクションの変更を元に戻すのにかかった時間を取得します。たとえば、作成されたインデックスを削除するためにかかった時間などです。
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	この推奨アクションを元に戻す承認がユーザーまたはシステムによって与えられたかどうかを取得します。
properties.revertActionInitiatedTime	string	この推奨アクションが元に戻すのが承認された時刻を取得します。
properties.revertActionStartTime	string	システムがユーザーリソースに対するこの推奨アクションの変更を元に戻し始めた時刻を取得します。たとえば、インデックスの削除が実行された時刻などです。
properties.score	integer	この推奨されるアクションの影響を取得します。使用可能な値は、1 - 低影響、2 - 中程度の影響、3 - 高影響です。
properties.state	RecommendedActionStateInfo	推奨されるアクションの現在の状態の情報を取得します。
properties.timeSeries	RecommendedActionMetricInfo[]	この推奨されるアクションのメトリックの時系列情報 (CPU 消費量の時系列など) を取得します
properties.validSince	string	この推奨アクションが有効な時刻を取得します。
type	string	リソースの種類。

RecommendedActionCurrentState

推奨されるアクションの現在の状態。一般的に使用される状態の一部は次のとおりです。アクティブ -> 推奨アクションはアクティブであり、アクションはまだ実行されていません。保留中 -> 推奨されるアクションはに対して承認され、実行を待機しています。実行中 -> 推奨されるアクションがユーザーデータベースに適用されています。検証 -> 推奨されるアクションが適用され、システムによってその有用性が検証されています。成功 -> 推奨されるアクションが適用され、検証中に改善が見つかりました。保留中の元に戻す -> 検証で改善がほとんどまたはまったく見つからなかったため、推奨されるアクションは元に戻すか、ユーザーが手動で元に戻すキューに入れられます。元に戻す -> 推奨されるアクションの適用中に行われた変更は、ユーザーデータベースで元に戻されます。 [元に戻す] -> ユーザーデータベースで推奨されるアクションによって行われた変更が正常に元に戻されました。 [無視] -> ユーザーは推奨されるアクションを明示的に無視または破棄しました。

名前	型	説明
Active	string
Error	string
Executing	string
Expired	string
Ignored	string
Monitoring	string
Pending	string
PendingRevert	string
Resolved	string
RevertCancelled	string
Reverted	string
Reverting	string
Success	string
Verifying	string

RecommendedActionErrorInfo

Azure SQL データベース、サーバー、またはエラスティックプールの推奨アクションに関するエラー情報が含まれています。

名前	型	説明
errorCode	string	推奨されるアクションがエラー状態になった理由を取得します。例: DatabaseHasQdsOff、IndexAlreadyExists
isRetryable	IsRetryable	エラーを無視し、推奨されるアクションを再試行できるかどうかを取得します。使用可能な値: はい/いいえ

RecommendedActionImpactRecord

Azure SQL データベース、サーバー、またはエラスティックプールの推奨アクションのさまざまなメトリックに対する推定または観察された影響に関する情報が含まれます。

名前	型	説明
absoluteValue	number	該当する場合は、このディメンションの絶対値を取得します。例: 影響を受けるクエリの数
changeValueAbsolute	number	このディメンションの値の絶対変更を取得します。たとえば、絶対ディスク領域の変更 (メガバイト単位)
changeValueRelative	number	このディメンションの値の相対的な変更を取得します。たとえば、相対的なディスク領域の変化 (パーセンテージ)
dimensionName	string	影響ディメンションの名前を取得します。たとえば、CPUChange、DiskSpaceChange、NumberOfQueriesAffected などです。
unit	string	影響ディメンションの名前を取得します。たとえば、CPUChange、DiskSpaceChange、NumberOfQueriesAffected などです。

RecommendedActionImplementationInfo

Azure SQL データベース、サーバー、またはエラスティックプールの推奨アクションの手動実装に関する情報が含まれています。

名前	型	説明
method	ImplementationMethod	この推奨アクションを手動で実装できるメソッドを取得します。たとえば、TSql、AzurePowerShell などです。
script	string	手動実装スクリプトを取得します。たとえば、データベースで実行できる T-SQL スクリプトなどです。

RecommendedActionInitiatedBy

この推奨アクションの実行を開始したユーザーを取得します。指定できる値は、User -> 推奨されるアクションを適用するようにユーザーが明示的にシステムに通知したときです。システム -> このアドバイザーの自動実行状態が "有効" に設定されている場合、システムによって適用されました。

名前	型	説明
System	string
User	string

RecommendedActionMetricInfo

Azure SQL データベース、サーバー、またはエラスティックプールの推奨アクションに対する影響を受けたさまざまなメトリックの時系列が含まれています。

名前	型	説明
metricName	string	メトリックの名前を取得します。たとえば、CPU、クエリの数などです。
startTime	string	この MetricInfo によって指定された時間間隔の開始時刻を取得します。
timeGrain	string	この MetricInfo によって指定された値の時間間隔の期間を取得します。例: PT1H (1 時間)
unit	string	メトリックが測定される単位を取得します。例: DTU、Frequency
value	number	この MetricInfo によって指定された時間間隔のメトリックの値を取得します。

RecommendedActionStateInfo

Azure SQL データベース、サーバー、またはエラスティックプールの推奨アクションの現在の状態の情報が含まれます。

名前	型	説明
actionInitiatedBy	RecommendedActionInitiatedBy	この推奨アクションの実行を開始したユーザーを取得します。指定できる値は、User -> 推奨されるアクションを適用するようにユーザーが明示的にシステムに通知したときです。システム -> このアドバイザーの自動実行状態が "有効" に設定されている場合、システムによって適用されました。
currentValue	RecommendedActionCurrentState	推奨されるアクションの現在の状態。一般的に使用される状態の一部は次のとおりです。アクティブ -> 推奨アクションはアクティブであり、アクションはまだ実行されていません。保留中 -> 推奨されるアクションはに対して承認され、実行を待機しています。実行中 -> 推奨されるアクションがユーザーデータベースに適用されています。検証 -> 推奨されるアクションが適用され、システムによってその有用性が検証されています。成功 -> 推奨されるアクションが適用され、検証中に改善が見つかりました。保留中の元に戻す -> 検証で改善がほとんどまたはまったく見つからなかったため、推奨されるアクションは元に戻すか、ユーザーが手動で元に戻すキューに入れられます。元に戻す -> 推奨されるアクションの適用中に行われた変更は、ユーザーデータベースで元に戻されます。 [元に戻す] -> ユーザーデータベースで推奨されるアクションによって行われた変更が正常に元に戻されました。 [無視] -> ユーザーは推奨されるアクションを明示的に無視または破棄しました。
lastModified	string	状態が最後に変更された時刻を取得します

次の方法で共有

Database Recommended Actions - Update

URI パラメーター

要求本文

応答

例

Update database recommended action

要求のサンプル

応答のサンプル

定義

ImplementationMethod

IsRetryable

RecommendedAction

RecommendedActionCurrentState

RecommendedActionErrorInfo

RecommendedActionImpactRecord

RecommendedActionImplementationInfo

RecommendedActionInitiatedBy

RecommendedActionMetricInfo

RecommendedActionStateInfo

その他のリソース