Database Automatic Tuning - Get

Ссылка

Служба:: SQL Database

Версия API:: 2023-08-01

Возвращает автоматическую настройку базы данных.

GET 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	Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки, идентифицирующий подписку Azure.
api-version	query	True	string	Версия API, используемая для запроса.

Ответы

Имя	Тип	Описание
200 OK	DatabaseAutomaticTuning	Успешно получены свойства автоматической настройки базы данных.
Other Status Codes	ErrorResponse	Ответы на ошибки: *** 400 FeatureDisabledOnSelectedEdition — пользователь попытался использовать функцию, которая отключена в текущем выпуске базы данных. 400 InvalidIdentifier — идентификатор содержит значение NULL или недопустимый символ юникода. 400 SystemDatabasesNotSupported— пользователь пытался получить сведения о автоматической настройке системных баз данных. 400 DataWarehouseNotSupported. Автоматическая настройка не поддерживается для хранилища данных SQL. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 DatabaseDoesNotExist — запрошенная база данных не найдена 404 SubscriptionDoesNotHaveElasticPool — запрошенный эластичные пулы не найдены 404 OperationIdNotFound — операция с идентификатором не существует. 405 NotSupported — эта функция не поддерживается. Конфликт 409. Не удалось обработать запрос из-за конфликта в запросе. 409 CannotCancelOperation — операция управления находится в состоянии, которое не может быть отменено. 409 OperationCancelled — операция отменена пользователем. 409 Operation Прервана — операция с ресурсом не удалось завершить, так как она была прервана другой операцией в том же ресурсе. 429 SubscriptionTooManyCreateUpdateRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами. 429 SubscriptionTooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами. 500 OperationTimedOut — время ожидания операции истекло и автоматически откатился. Повторите операцию. 503 ServiceTemporarilyUnavailable — функция временно недоступна. 503 TooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами.

Имя

Тип

Описание

200 OK

DatabaseAutomaticTuning

Успешно получены свойства автоматической настройки базы данных.

Other Status Codes

ErrorResponse

Ответы на ошибки: ***

400 FeatureDisabledOnSelectedEdition — пользователь попытался использовать функцию, которая отключена в текущем выпуске базы данных.
400 InvalidIdentifier — идентификатор содержит значение NULL или недопустимый символ юникода.
400 SystemDatabasesNotSupported— пользователь пытался получить сведения о автоматической настройке системных баз данных.
400 DataWarehouseNotSupported. Автоматическая настройка не поддерживается для хранилища данных SQL.
404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден
404 DatabaseDoesNotExist — запрошенная база данных не найдена
404 SubscriptionDoesNotHaveElasticPool — запрошенный эластичные пулы не найдены
404 OperationIdNotFound — операция с идентификатором не существует.
405 NotSupported — эта функция не поддерживается.
Конфликт 409. Не удалось обработать запрос из-за конфликта в запросе.
409 CannotCancelOperation — операция управления находится в состоянии, которое не может быть отменено.
409 OperationCancelled — операция отменена пользователем.
409 Operation Прервана — операция с ресурсом не удалось завершить, так как она была прервана другой операцией в том же ресурсе.
429 SubscriptionTooManyCreateUpdateRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами.
429 SubscriptionTooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами.
500 OperationTimedOut — время ожидания операции истекло и автоматически откатился. Повторите операцию.
503 ServiceTemporarilyUnavailable — функция временно недоступна.
503 TooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами.

Примеры

Get a database's automatic tuning settings

GET 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

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/DatabaseAutomaticTuningGet.json
// this example is just showing the usage of "DatabaseAutomaticTuning_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 SqlDatabaseAutomaticTuningResource created on azure
// for more information of creating SqlDatabaseAutomaticTuningResource, please refer to the document of SqlDatabaseAutomaticTuningResource
string subscriptionId = "c3aa9078-0000-0000-0000-e36f151182d7";
string resourceGroupName = "default-sql-onebox";
string serverName = "testsvr11";
string databaseName = "db1";
ResourceIdentifier sqlDatabaseAutomaticTuningResourceId = SqlDatabaseAutomaticTuningResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseAutomaticTuningResource sqlDatabaseAutomaticTuning = client.GetSqlDatabaseAutomaticTuningResource(sqlDatabaseAutomaticTuningResourceId);

// invoke the operation
SqlDatabaseAutomaticTuningResource result = await sqlDatabaseAutomaticTuning.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
SqlDatabaseAutomaticTuningData 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/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

Перечисление

Описание причины, если нужное и фактическое состояние отличаются.

Значение	Описание
AutoConfigured
Default
Disabled
InheritedFromServer
NotSupported
QueryStoreOff
QueryStoreReadOnly

AutomaticTuningMode

Перечисление

Требуемое состояние автоматической настройки.

Значение	Описание
Auto
Custom
Inherit
Unspecified

AutomaticTuningOptionModeActual

Перечисление

Фактическое состояние параметра автоматической настройки.

Значение	Описание
Off
On

AutomaticTuningOptionModeDesired

Перечисление

Требуемое состояние параметра автоматической настройки.

Значение	Описание
Default
Off
On

AutomaticTuningOptions

Object

Свойства автоматической настройки для отдельных помощников.

Имя	Тип	Описание
actualState	AutomaticTuningOptionModeActual	Фактическое состояние параметра автоматической настройки.
desiredState	AutomaticTuningOptionModeDesired	Требуемое состояние параметра автоматической настройки.
reasonCode	integer (int32)	Код причины, если нужно, и фактическое состояние отличаются.
reasonDesc	AutomaticTuningDisabledReason	Описание причины, если нужное и фактическое состояние отличаются.