Database Recommended Actions - 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}/recommendedActions/{recommendedActionName}?api-version=2023-08-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
advisorName	path	True	string	Имя помощника по базе данных.
databaseName	path	True	string	Имя базы данных.
recommendedActionName	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, используемая для запроса.

Текст запроса

Имя	Обязательно	Тип	Описание
properties.state	True	RecommendedActionStateInfo	Возвращает сведения о текущем состоянии, в которое выполняется рекомендуемое действие.

Ответы

Имя	Тип	Описание
200 OK	RecommendedAction	Успешно обновлено указанное рекомендуемое действие базы данных.
Other Status Codes	ErrorResponse	Ответы на ошибки: *** 400 FeatureDisabledOnSelectedEdition — пользователь попытался использовать функцию, которая отключена в текущем выпуске базы данных. 400 InvalidIdentifier — идентификатор содержит значение NULL или недопустимый символ юникода. 400 InvalidRecommendedActionUpsertRequest— текст запроса на обновление не существует или не имеет свойств или объектов состояния. 400 InvalidRecommendedActionState — указанное состояние для рекомендуемого действия недопустимо 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 DatabaseDoesNotExist — запрошенная база данных не найдена 404 SubscriptionDoesNotHaveElasticPool — запрошенный эластичные пулы не найдены 404 AdvisorNotFound - Запрошенный помощник не найден. 404 RecommendedActionNotFound — запрошенное рекомендуемое действие не найдено. 404 AdvisorNotFound - Запрошенный помощник не найден. 404 RecommendedActionNotFound — запрошенное рекомендуемое действие не найдено. 405 NotSupported — эта функция не поддерживается. Конфликт 409. Не удалось обработать запрос из-за конфликта в запросе. 503 ServiceTemporarilyUnavailable — функция временно недоступна.

Имя

Тип

Описание

200 OK

RecommendedAction

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

Other Status Codes

ErrorResponse

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

400 FeatureDisabledOnSelectedEdition — пользователь попытался использовать функцию, которая отключена в текущем выпуске базы данных.
400 InvalidIdentifier — идентификатор содержит значение NULL или недопустимый символ юникода.
400 InvalidRecommendedActionUpsertRequest— текст запроса на обновление не существует или не имеет свойств или объектов состояния.
400 InvalidRecommendedActionState — указанное состояние для рекомендуемого действия недопустимо
404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден
404 DatabaseDoesNotExist — запрошенная база данных не найдена
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=2023-08-01

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

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/DatabaseRecommendedActionUpdate.json
// this example is just showing the usage of "DatabaseRecommendedActions_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 RecommendedActionResource created on azure
// for more information of creating RecommendedActionResource, please refer to the document of RecommendedActionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "workloadinsight-demos";
string serverName = "misosisvr";
string databaseName = "IndexAdvisor_test_3";
string advisorName = "CreateIndex";
string recommendedActionName = "IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB";
ResourceIdentifier recommendedActionResourceId = RecommendedActionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, advisorName, recommendedActionName);
RecommendedActionResource recommendedAction = client.GetRecommendedActionResource(recommendedActionResourceId);

// invoke the operation
RecommendedActionData data = new RecommendedActionData
{
    State = new RecommendedActionStateInfo(RecommendedActionCurrentState.Pending),
};
RecommendedActionResource result = await recommendedAction.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
RecommendedActionData 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/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]"
    }
  }
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ImplementationMethod	Получает метод, в котором это рекомендуемое действие можно реализовать вручную. Например, TSql, AzurePowerShell.
IsRetryable	Возвращает, может ли ошибка быть проигнорирована и рекомендуемое действие может быть извлечено. Возможные значения: Да/Нет
RecommendedAction	Рекомендуемое действие базы данных, сервера или эластичного пула.
RecommendedActionCurrentState	Текущее состояние рекомендуемого действия выполняется. Некоторые часто используемые состояния: активные —> рекомендуемые действия активны, и никаких действий еще не было сделано. Ожидание —> рекомендуемое действие утверждено и ожидает выполнения. Выполнение —> рекомендуемое действие применяется к пользовательской базе данных. Проверка —> рекомендуемое действие было применено и проверяется его полезность системой. Успех —> рекомендуемое действие было применено и улучшено во время проверки. Ожидание возврата —> проверка обнаружила мало или не улучшилась, поэтому рекомендуемое действие помещается в очередь для восстановления или пользователя вручную отменяется. Отмена —> изменения, внесенные при применении рекомендуемого действия, удаляются в пользовательской базе данных. Отменено —> успешно отменяется изменения, внесенные рекомендуемым действием в пользовательской базе данных. Игнорируется—> пользователя явно проигнорировали или отбросили рекомендуемое действие.
RecommendedActionErrorInfo	Содержит сведения об ошибке для рекомендуемого действия базы данных SQL Azure, сервера или эластичного пула.
RecommendedActionImpactRecord	Содержит сведения о предполагаемом или наблюдаемом влиянии на различные метрики для рекомендуемого действия базы данных SQL Azure, сервера или эластичного пула.
RecommendedActionImplementationInfo	Содержит сведения о реализации вручную для рекомендуемого действия базы данных SQL Azure, сервера или эластичного пула.
RecommendedActionInitiatedBy	Возвращает, кто инициировал выполнение этого рекомендуемого действия. Возможные значения: пользователь —>, когда пользователь явно уведомляет систему о применении рекомендуемого действия. Система —> При автоматическом выполнении этого помощника было задано значение "Включено", в этом случае система применила его.
RecommendedActionMetricInfo	Содержит временные ряды различных затронутых метрик для рекомендуемого действия базы данных SQL Azure, сервера или эластичного пула.
RecommendedActionStateInfo	Содержит сведения о текущем состоянии для рекомендуемого действия базы данных SQL Azure, сервера или эластичного пула.

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	Идентификатор ресурса.
kind	string	Тип ресурса.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.details	object	Возвращает дополнительные сведения, относящиеся к этому рекомендуемого действия.
properties.errorDetails	RecommendedActionErrorInfo	Возвращает сведения об ошибке, если и почему это рекомендуемое действие помещается в состояние ошибки.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Возвращает сведения о предполагаемом влиянии для этого рекомендуемого действия, например предполагаемое увеличение ЦП, предполагаемое изменение места на диске
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[]	Возвращает сведения об наблюдаемом или фактическом влиянии для этого рекомендуемого действия, например фактическое увеличение ЦП, изменение фактического места на диске
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[]	Возвращает сведения о временных рядах метрик для этого рекомендуемого действия, например временные ряды потребления ЦП
properties.validSince	string (date-time)	Возвращает время, с тех пор, когда это рекомендуемое действие является допустимым.
type	string	Тип ресурса.

RecommendedActionCurrentState

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

Текущее состояние рекомендуемого действия выполняется. Некоторые часто используемые состояния: активные —> рекомендуемые действия активны, и никаких действий еще не было сделано. Ожидание —> рекомендуемое действие утверждено и ожидает выполнения. Выполнение —> рекомендуемое действие применяется к пользовательской базе данных. Проверка —> рекомендуемое действие было применено и проверяется его полезность системой. Успех —> рекомендуемое действие было применено и улучшено во время проверки. Ожидание возврата —> проверка обнаружила мало или не улучшилась, поэтому рекомендуемое действие помещается в очередь для восстановления или пользователя вручную отменяется. Отмена —> изменения, внесенные при применении рекомендуемого действия, удаляются в пользовательской базе данных. Отменено —> успешно отменяется изменения, внесенные рекомендуемым действием в пользовательской базе данных. Игнорируется—> пользователя явно проигнорировали или отбросили рекомендуемое действие.

Значение	Описание
Active
Pending
Executing
Verifying
PendingRevert
RevertCancelled
Reverting
Reverted
Ignored
Expired
Monitoring
Resolved
Success
Error

RecommendedActionErrorInfo

Object

Содержит сведения об ошибке для рекомендуемого действия базы данных SQL Azure, сервера или эластичного пула.

Имя	Тип	Описание
errorCode	string	Получает причину, по которой рекомендуемое действие было поставлено в состояние ошибки. например, DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Возвращает, может ли ошибка быть проигнорирована и рекомендуемое действие может быть извлечено. Возможные значения: Да/Нет

RecommendedActionImpactRecord

Object

Содержит сведения о предполагаемом или наблюдаемом влиянии на различные метрики для рекомендуемого действия базы данных SQL Azure, сервера или эластичного пула.

Имя	Тип	Описание
absoluteValue	number (double)	Возвращает абсолютное значение этого измерения, если применимо. Например, количество затронутых запросов
changeValueAbsolute	number (double)	Возвращает абсолютное изменение значения этого измерения. Например, изменение абсолютного места на диске в мегабайтах
changeValueRelative	number (double)	Возвращает относительное изменение значения этого измерения. например, изменение относительного места на диске в процентах
dimensionName	string	Возвращает имя измерения влияния. Например, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Возвращает имя измерения влияния. Например, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Object

Содержит сведения о реализации вручную для рекомендуемого действия базы данных SQL Azure, сервера или эластичного пула.

Имя	Тип	Описание
method	ImplementationMethod	Получает метод, в котором это рекомендуемое действие можно реализовать вручную. Например, TSql, AzurePowerShell.
script	string	Возвращает скрипт реализации вручную. Например, скрипт T-SQL, который может быть выполнен в базе данных.

RecommendedActionInitiatedBy

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

Возвращает, кто инициировал выполнение этого рекомендуемого действия. Возможные значения: пользователь —>, когда пользователь явно уведомляет систему о применении рекомендуемого действия. Система —> При автоматическом выполнении этого помощника было задано значение "Включено", в этом случае система применила его.

Значение	Описание
User
System

RecommendedActionMetricInfo

Object

Содержит временные ряды различных затронутых метрик для рекомендуемого действия базы данных SQL Azure, сервера или эластичного пула.

Имя	Тип	Описание
metricName	string	Возвращает имя метрики. Например, ЦП, количество запросов.
startTime	string (date-time)	Возвращает время начала интервала времени, заданного этим параметром MetricInfo.
timeGrain	string	Возвращает длительность интервала времени для значения, заданного этим MetricInfo. например, PT1H (1 час)
unit	string	Возвращает единицу измерения метрики. например, DTU, Частота
value	number (double)	Возвращает значение метрики в интервале времени, заданном этим параметром MetricInfo.

RecommendedActionStateInfo

Object

Содержит сведения о текущем состоянии для рекомендуемого действия базы данных SQL Azure, сервера или эластичного пула.

Имя	Тип	Описание
actionInitiatedBy	RecommendedActionInitiatedBy	Возвращает, кто инициировал выполнение этого рекомендуемого действия. Возможные значения: пользователь —>, когда пользователь явно уведомляет систему о применении рекомендуемого действия. Система —> При автоматическом выполнении этого помощника было задано значение "Включено", в этом случае система применила его.
currentValue	RecommendedActionCurrentState	Текущее состояние рекомендуемого действия выполняется. Некоторые часто используемые состояния: активные —> рекомендуемые действия активны, и никаких действий еще не было сделано. Ожидание —> рекомендуемое действие утверждено и ожидает выполнения. Выполнение —> рекомендуемое действие применяется к пользовательской базе данных. Проверка —> рекомендуемое действие было применено и проверяется его полезность системой. Успех —> рекомендуемое действие было применено и улучшено во время проверки. Ожидание возврата —> проверка обнаружила мало или не улучшилась, поэтому рекомендуемое действие помещается в очередь для восстановления или пользователя вручную отменяется. Отмена —> изменения, внесенные при применении рекомендуемого действия, удаляются в пользовательской базе данных. Отменено —> успешно отменяется изменения, внесенные рекомендуемым действием в пользовательской базе данных. Игнорируется—> пользователя явно проигнорировали или отбросили рекомендуемое действие.
lastModified	string (date-time)	Возвращает время последнего изменения состояния

Поделиться через

Database Recommended Actions - Update

Параметры URI

Текст запроса

Ответы

Примеры

Update database recommended action

Образец запроса

Пример ответа

Определения

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ImplementationMethod

IsRetryable

RecommendedAction

RecommendedActionCurrentState

RecommendedActionErrorInfo

RecommendedActionImpactRecord

RecommendedActionImplementationInfo

RecommendedActionInitiatedBy

RecommendedActionMetricInfo

RecommendedActionStateInfo