Server Automatic Tuning - Get

サービス:: SQL Database

API バージョン:: 2023-08-01

サーバーの自動チューニングオプションを取得します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースを含むリソースグループの名前。この値は、Azure Resource Manager API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求に使用する API バージョン。

応答

名前	型	説明
200 OK	ServerAutomaticTuning	サーバーの自動チューニングプロパティが正常に取得されました。
Other Status Codes	ErrorResponse	エラー応答: *** 400 FeatureDisabledOnSelectedEdition - ユーザーは、現在のデータベースエディションで無効になっている機能を使用しようとしました。 400 InvalidIdentifier - 識別子に NULL または無効な Unicode 文字が含まれています。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 DatabaseDoesNotExist - 要求されたデータベースが見つかりませんでした 404 SubscriptionDoesNotHaveElasticPool - 要求されたエラスティックプールが見つかりませんでした 404 OperationIdNotFound - Id を持つ操作が存在しません。 405 NotSupported - この機能はサポートされていません。 409 競合 - 要求の競合が原因で要求を処理できませんでした。 409 CannotCancelOperation - 管理操作が取り消すことができない状態です。 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作を再試行してください。 503 ServiceTemporarilyUnavailable - 機能は一時的に使用できません。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

名前

型

説明

200 OK

ServerAutomaticTuning

サーバーの自動チューニングプロパティが正常に取得されました。

Other Status Codes

ErrorResponse

エラー応答: ***

400 FeatureDisabledOnSelectedEdition - ユーザーは、現在のデータベースエディションで無効になっている機能を使用しようとしました。
400 InvalidIdentifier - 識別子に NULL または無効な Unicode 文字が含まれています。
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 DatabaseDoesNotExist - 要求されたデータベースが見つかりませんでした
404 SubscriptionDoesNotHaveElasticPool - 要求されたエラスティックプールが見つかりませんでした
404 OperationIdNotFound - Id を持つ操作が存在しません。
405 NotSupported - この機能はサポートされていません。
409 競合 - 要求の競合が原因で要求を処理できませんでした。
409 CannotCancelOperation - 管理操作が取り消すことができない状態です。
409 OperationCancelled - 操作がユーザーによって取り消されました。
409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。
429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作を再試行してください。
503 ServiceTemporarilyUnavailable - 機能は一時的に使用できません。
503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

例

Get a server's automatic tuning settings

GET https://management.azure.com/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/automaticTuning/current?api-version=2023-08-01

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/ServerAutomaticTuningGet.json
// this example is just showing the usage of "ServerAutomaticTuning_Get" 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 SqlServerAutomaticTuningResource created on azure
// for more information of creating SqlServerAutomaticTuningResource, please refer to the document of SqlServerAutomaticTuningResource
string subscriptionId = "c3aa9078-0000-0000-0000-e36f151182d7";
string resourceGroupName = "default-sql-onebox";
string serverName = "testsvr11";
ResourceIdentifier sqlServerAutomaticTuningResourceId = SqlServerAutomaticTuningResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerAutomaticTuningResource sqlServerAutomaticTuning = client.GetSqlServerAutomaticTuningResource(sqlServerAutomaticTuningResourceId);

// invoke the operation
SqlServerAutomaticTuningResource result = await sqlServerAutomaticTuning.GetAsync();

// 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
SqlServerAutomaticTuningData 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/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/automaticTuning/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/automaticTuning",
  "properties": {
    "desiredState": "Auto",
    "actualState": "Auto",
    "options": {
      "createIndex": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "dropIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "forceLastGoodPlan": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "maintainIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      }
    }
  }
}

定義

名前	説明
AutomaticTuningOptionModeActual	自動チューニングオプションの実際の状態。
AutomaticTuningOptionModeDesired	自動チューニングオプションの必要な状態。
AutomaticTuningServerMode	必要な状態の自動チューニング。
AutomaticTuningServerOptions	個々のアドバイザーの自動チューニングプロパティ。
AutomaticTuningServerReason	必要な場合の理由の説明と実際の状態が異なります。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ServerAutomaticTuning	サーバーレベルの自動チューニング。

AutomaticTuningOptionModeActual

列挙

自動チューニングオプションの実際の状態。

値	説明
Off
On

AutomaticTuningOptionModeDesired

列挙

自動チューニングオプションの必要な状態。

値	説明
Off
On
Default

AutomaticTuningServerMode

列挙

必要な状態の自動チューニング。

値	説明
Custom
Auto
Unspecified

AutomaticTuningServerOptions

Object

個々のアドバイザーの自動チューニングプロパティ。

名前	型	説明
actualState	AutomaticTuningOptionModeActual	自動チューニングオプションの実際の状態。
desiredState	AutomaticTuningOptionModeDesired	自動チューニングオプションの必要な状態。
reasonCode	integer (int32)	必要に応じて理由コードと実際の状態が異なります。
reasonDesc	AutomaticTuningServerReason	必要な場合の理由の説明と実際の状態が異なります。

AutomaticTuningServerReason

列挙

必要な場合の理由の説明と実際の状態が異なります。

値	説明
Default
Disabled
AutoConfigured

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ServerAutomaticTuning

Object

サーバーレベルの自動チューニング。

名前	型	説明
id	string	リソース ID。
name	string	リソース名。
properties.actualState	AutomaticTuningServerMode	自動チューニングの実際の状態。
properties.desiredState	AutomaticTuningServerMode	必要な状態の自動チューニング。
properties.options	<string, AutomaticTuningServerOptions>	自動チューニングオプションの定義。
type	string	リソースの種類。

次の方法で共有

Server Automatic Tuning - Get

URI パラメーター

応答

例

Get a server's automatic tuning settings

要求のサンプル

応答のサンプル

定義

AutomaticTuningOptionModeActual

AutomaticTuningOptionModeDesired

AutomaticTuningServerMode

AutomaticTuningServerOptions

AutomaticTuningServerReason

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerAutomaticTuning