Database Recommended Actions - Update

Tjänst:: SQL Database

API-version:: 2023-08-01

Uppdaterar en databas som rekommenderas.

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-parametrar

Name	I	Obligatorisk	Typ	Description
advisorName	path	True	string	Namnet på Database Advisor.
databaseName	path	True	string	Namnet på databasen.
recommendedActionName	path	True	string	Namnet på rekommenderad databasåtgärd.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string	Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.state	True	RecommendedActionStateInfo	Hämtar information om det aktuella tillståndet som den rekommenderade åtgärden finns i.

Svar

Name	Typ	Description
200 OK	RecommendedAction	Den rekommenderade åtgärden har uppdaterats.
Other Status Codes	ErrorResponse	Felsvar: *** 400 FeatureDisabledOnSelectedEdition – Användaren försökte använda en funktion som är inaktiverad i den aktuella databasutgåvan. 400 InvalidIdentifier – Identifieraren innehåller NULL eller ett ogiltigt unicode-tecken. 400 InvalidRecommendedActionUpsertRequest – Den rekommenderade begärandetexten för uppdateringen finns inte eller har inga egenskaper eller tillståndsobjekt. 400 InvalidRecommendedActionState – det angivna tillståndet för rekommenderad åtgärd är ogiltigt 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte 404 DatabaseDoesNotExist – Den begärda databasen hittades inte 404 SubscriptionDoesNotHaveElasticPool – Den begärda elastiska poolen hittades inte 404 AdvisorNotFound – Den begärda rådgivaren hittades inte. 404 RecommendedActionNotFound – Den begärda rekommenderade åtgärden hittades inte. 404 AdvisorNotFound – Den begärda rådgivaren hittades inte. 404 RecommendedActionNotFound – Den begärda rekommenderade åtgärden hittades inte. 405 Stöds inte – den här funktionen stöds inte. 409 Konflikt – Begäran kunde inte bearbetas på grund av en konflikt i begäran. 503 ServiceTemporarilyUnavailable – Funktionen är inte tillgänglig för tillfället.

Name

Typ

Description

200 OK

RecommendedAction

Den rekommenderade åtgärden har uppdaterats.

Other Status Codes

ErrorResponse

Felsvar: ***

400 FeatureDisabledOnSelectedEdition – Användaren försökte använda en funktion som är inaktiverad i den aktuella databasutgåvan.
400 InvalidIdentifier – Identifieraren innehåller NULL eller ett ogiltigt unicode-tecken.
400 InvalidRecommendedActionUpsertRequest – Den rekommenderade begärandetexten för uppdateringen finns inte eller har inga egenskaper eller tillståndsobjekt.
400 InvalidRecommendedActionState – det angivna tillståndet för rekommenderad åtgärd är ogiltigt
404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte
404 DatabaseDoesNotExist – Den begärda databasen hittades inte
404 SubscriptionDoesNotHaveElasticPool – Den begärda elastiska poolen hittades inte
404 AdvisorNotFound – Den begärda rådgivaren hittades inte.
404 RecommendedActionNotFound – Den begärda rekommenderade åtgärden hittades inte.
404 AdvisorNotFound – Den begärda rådgivaren hittades inte.
404 RecommendedActionNotFound – Den begärda rekommenderade åtgärden hittades inte.
405 Stöds inte – den här funktionen stöds inte.
409 Konflikt – Begäran kunde inte bearbetas på grund av en konflikt i begäran.
503 ServiceTemporarilyUnavailable – Funktionen är inte tillgänglig för tillfället.

Exempel

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://free.blessedness.top/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

Exempelsvar

Statuskod:: 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]"
    }
  }
}

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ImplementationMethod	Hämtar den metod där den här rekommenderade åtgärden kan implementeras manuellt. t.ex. TSql, AzurePowerShell.
IsRetryable	Hämtar om felet kan ignoreras och rekommenderad åtgärd kan göras om. Möjliga värden är: Ja/Nej
RecommendedAction	Rekommenderad åtgärd för databas, server eller elastisk pool.
RecommendedActionCurrentState	Aktuellt tillstånd som den rekommenderade åtgärden är i. Några vanliga tillstånd är: Aktiv –> rekommenderade åtgärden är aktiv och ingen åtgärd har vidtagits ännu. Väntar –> rekommenderade åtgärden godkänns för och väntar på körning. Kör –> rekommenderad åtgärd tillämpas på användardatabasen. Verifiera –> rekommenderade åtgärden har tillämpats och verifieras av systemets användbarhet. Lyckades –> rekommenderade åtgärden tillämpades och förbättringar hittades under verifieringen. Väntar på återställning –> verifieringen hittade liten eller ingen förbättring, så den rekommenderade åtgärden placeras i kö för återställning eller så har användaren återställts manuellt. Återställ –> ändringar som görs vid användning av rekommenderad åtgärd återställs i användardatabasen. Återställd –> återställt ändringarna som gjorts genom rekommenderad åtgärd i användardatabasen. Ignorerad –> användare uttryckligen ignorerat/ignorerat den rekommenderade åtgärden.
RecommendedActionErrorInfo	Innehåller felinformation för en rekommenderad åtgärd för Azure SQL Database, server eller elastisk pool.
RecommendedActionImpactRecord	Innehåller information om uppskattad eller observerad påverkan på olika mått för en rekommenderad Åtgärd för Azure SQL Database, Server eller Elastisk pool.
RecommendedActionImplementationInfo	Innehåller information för manuell implementering för en rekommenderad åtgärd för Azure SQL Database, server eller elastisk pool.
RecommendedActionInitiatedBy	Hämtar vem som initierade körningen av den här rekommenderade åtgärden. Möjliga värden är: Användare –> När användaren uttryckligen meddelade systemet att tillämpa den rekommenderade åtgärden. System –> När statusen för automatisk körning av den här rådgivaren var inställd på "Aktiverad", i vilket fall systemet tillämpade den.
RecommendedActionMetricInfo	Innehåller tidsserier med olika mått som påverkas för en rekommenderad åtgärd för Azure SQL Database, server eller elastisk pool.
RecommendedActionStateInfo	Innehåller information om aktuellt tillstånd för en rekommenderad åtgärd för Azure SQL Database, server eller elastisk pool.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ImplementationMethod

Uppräkning

Hämtar den metod där den här rekommenderade åtgärden kan implementeras manuellt. t.ex. TSql, AzurePowerShell.

Värde	Description
TSql
AzurePowerShell

IsRetryable

Uppräkning

Hämtar om felet kan ignoreras och rekommenderad åtgärd kan göras om. Möjliga värden är: Ja/Nej

Värde	Description
Yes
No

RecommendedAction

Objekt

Rekommenderad åtgärd för databas, server eller elastisk pool.

Name	Typ	Description
id	string	Resurs-ID.
kind	string	Resurstyp.
location	string	Resursplats.
name	string	Resursnamn.
properties.details	object	Hämtar ytterligare information som är specifik för den här rekommenderade åtgärden.
properties.errorDetails	RecommendedActionErrorInfo	Hämtar felinformationen om och varför den här rekommenderade åtgärden sätts till feltillstånd.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Hämtar den uppskattade effektinformationen för den här rekommenderade åtgärden, t.ex. uppskattad cpu-vinst, uppskattad diskutrymmesändring
properties.executeActionDuration	string (duration)	Hämtar den tid det tar att tillämpa den här rekommenderade åtgärden på användarresursen. t.ex. tidsåtgång för att skapa index
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	Hämtar om godkännande för att tillämpa den här rekommenderade åtgärden gavs av användare/system.
properties.executeActionInitiatedTime	string (date-time)	Hämtar den tid då den här rekommenderade åtgärden godkändes för körning.
properties.executeActionStartTime	string (date-time)	Hämtar den tid då systemet började tillämpa den här rekommenderade åtgärden på användarresursen. t.ex. starttid för indexskapande
properties.implementationDetails	RecommendedActionImplementationInfo	Hämtar implementeringsinformationen för den här rekommenderade åtgärden så att användaren kan tillämpa den manuellt.
properties.isArchivedAction	boolean	Hämtar om den här rekommenderade åtgärden föreslogs för en tid sedan, men användaren valde att ignorera detta och systemet lade till en ny rekommenderad åtgärd igen.
properties.isExecutableAction	boolean	Hämtar om den här rekommenderade åtgärden kan användas av användaren
properties.isRevertableAction	boolean	Hämtar om ändringar som tillämpas av den här rekommenderade åtgärden kan återställas av användaren
properties.lastRefresh	string (date-time)	Hämtar tid när den rekommenderade åtgärden senast uppdaterades.
properties.linkedObjects	string[]	Hämtar eventuella länkade objekt.
properties.observedImpact	RecommendedActionImpactRecord[]	Hämtar den observerade/faktiska effektinformationen för den här rekommenderade åtgärden, t.ex. faktisk cpu-vinst, ändring av verkligt diskutrymme
properties.recommendationReason	string	Hämtar anledningen till att rekommendera den här åtgärden. t.ex. DuplicateIndex
properties.revertActionDuration	string (duration)	Hämtar den tid det tar för att återställa ändringar av den här rekommenderade åtgärden på användarresursen. t.ex. tidsåtgång för att ta bort det skapade indexet.
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	Hämtar om godkännande för att återställa den här rekommenderade åtgärden gavs av användare/system.
properties.revertActionInitiatedTime	string (date-time)	Hämtar den tid då den här rekommenderade åtgärden godkändes för återställning.
properties.revertActionStartTime	string (date-time)	Hämtar den tid då systemet började återställa ändringar av den här rekommenderade åtgärden på användarresursen. t.ex. tid när indexsänkningen körs.
properties.score	integer (int32)	Hämtar effekten av den här rekommenderade åtgärden. Möjliga värden är 1 – Låg påverkan, 2 – Medelpåverkan och 3 – Hög påverkan
properties.state	RecommendedActionStateInfo	Hämtar information om det aktuella tillståndet som den rekommenderade åtgärden finns i.
properties.timeSeries	RecommendedActionMetricInfo[]	Hämtar tidsserieinformationen för mått för den här rekommenderade åtgärden, t.ex. tidsserier för CPU-förbrukning
properties.validSince	string (date-time)	Hämtar tiden sedan när den här rekommenderade åtgärden är giltig.
type	string	Resurstyp.

RecommendedActionCurrentState

Uppräkning

Aktuellt tillstånd som den rekommenderade åtgärden är i. Några vanliga tillstånd är: Aktiv –> rekommenderade åtgärden är aktiv och ingen åtgärd har vidtagits ännu. Väntar –> rekommenderade åtgärden godkänns för och väntar på körning. Kör –> rekommenderad åtgärd tillämpas på användardatabasen. Verifiera –> rekommenderade åtgärden har tillämpats och verifieras av systemets användbarhet. Lyckades –> rekommenderade åtgärden tillämpades och förbättringar hittades under verifieringen. Väntar på återställning –> verifieringen hittade liten eller ingen förbättring, så den rekommenderade åtgärden placeras i kö för återställning eller så har användaren återställts manuellt. Återställ –> ändringar som görs vid användning av rekommenderad åtgärd återställs i användardatabasen. Återställd –> återställt ändringarna som gjorts genom rekommenderad åtgärd i användardatabasen. Ignorerad –> användare uttryckligen ignorerat/ignorerat den rekommenderade åtgärden.

Värde	Description
Active
Pending
Executing
Verifying
PendingRevert
RevertCancelled
Reverting
Reverted
Ignored
Expired
Monitoring
Resolved
Success
Error

RecommendedActionErrorInfo

Objekt

Innehåller felinformation för en rekommenderad åtgärd för Azure SQL Database, server eller elastisk pool.

Name	Typ	Description
errorCode	string	Hämtar orsaken till att den rekommenderade åtgärden har försatts i feltillstånd. t.ex. DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Hämtar om felet kan ignoreras och rekommenderad åtgärd kan göras om. Möjliga värden är: Ja/Nej

RecommendedActionImpactRecord

Objekt

Innehåller information om uppskattad eller observerad påverkan på olika mått för en rekommenderad Åtgärd för Azure SQL Database, Server eller Elastisk pool.

Name	Typ	Description
absoluteValue	number (double)	Hämtar det absoluta värdet för den här dimensionen om det är tillämpligt. t.ex. antal frågor som påverkas
changeValueAbsolute	number (double)	Hämtar den absoluta ändringen i värdet för den här dimensionen. t.ex., Absolut diskutrymmesändring i Megabyte
changeValueRelative	number (double)	Hämtar den relativa ändringen i värdet för den här dimensionen. t.ex. relativ diskutrymmesändring i procent
dimensionName	string	Hämtar namnet på effektdimensionen. t.ex. CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Hämtar namnet på effektdimensionen. t.ex. CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Objekt

Innehåller information för manuell implementering för en rekommenderad åtgärd för Azure SQL Database, server eller elastisk pool.

Name	Typ	Description
method	ImplementationMethod	Hämtar den metod där den här rekommenderade åtgärden kan implementeras manuellt. t.ex. TSql, AzurePowerShell.
script	string	Hämtar det manuella implementeringsskriptet. T.ex. T-SQL-skript som kan köras på databasen.

RecommendedActionInitiatedBy

Uppräkning

Hämtar vem som initierade körningen av den här rekommenderade åtgärden. Möjliga värden är: Användare –> När användaren uttryckligen meddelade systemet att tillämpa den rekommenderade åtgärden. System –> När statusen för automatisk körning av den här rådgivaren var inställd på "Aktiverad", i vilket fall systemet tillämpade den.

Värde	Description
User
System

RecommendedActionMetricInfo

Objekt

Innehåller tidsserier med olika mått som påverkas för en rekommenderad åtgärd för Azure SQL Database, server eller elastisk pool.

Name	Typ	Description
metricName	string	Hämtar namnet på måttet. t.ex. CPU, antal frågor.
startTime	string (date-time)	Hämtar starttiden för tidsintervallet som anges av denna MetricInfo.
timeGrain	string	Hämtar varaktigheten för tidsintervallet för det värde som anges av denna MetricInfo. t.ex. PT1H (1 timme)
unit	string	Hämtar den enhet där mått mäts. t.ex. DTU, frekvens
value	number (double)	Hämtar värdet för måttet i tidsintervallet som anges av denna MetricInfo.

RecommendedActionStateInfo

Objekt

Innehåller information om aktuellt tillstånd för en rekommenderad åtgärd för Azure SQL Database, server eller elastisk pool.

Name	Typ	Description
actionInitiatedBy	RecommendedActionInitiatedBy	Hämtar vem som initierade körningen av den här rekommenderade åtgärden. Möjliga värden är: Användare –> När användaren uttryckligen meddelade systemet att tillämpa den rekommenderade åtgärden. System –> När statusen för automatisk körning av den här rådgivaren var inställd på "Aktiverad", i vilket fall systemet tillämpade den.
currentValue	RecommendedActionCurrentState	Aktuellt tillstånd som den rekommenderade åtgärden är i. Några vanliga tillstånd är: Aktiv –> rekommenderade åtgärden är aktiv och ingen åtgärd har vidtagits ännu. Väntar –> rekommenderade åtgärden godkänns för och väntar på körning. Kör –> rekommenderad åtgärd tillämpas på användardatabasen. Verifiera –> rekommenderade åtgärden har tillämpats och verifieras av systemets användbarhet. Lyckades –> rekommenderade åtgärden tillämpades och förbättringar hittades under verifieringen. Väntar på återställning –> verifieringen hittade liten eller ingen förbättring, så den rekommenderade åtgärden placeras i kö för återställning eller så har användaren återställts manuellt. Återställ –> ändringar som görs vid användning av rekommenderad åtgärd återställs i användardatabasen. Återställd –> återställt ändringarna som gjorts genom rekommenderad åtgärd i användardatabasen. Ignorerad –> användare uttryckligen ignorerat/ignorerat den rekommenderade åtgärden.
lastModified	string (date-time)	Hämtar den tid då tillståndet senast ändrades

Dela via

Database Recommended Actions - Update

URI-parametrar

Begärandetext

Svar

Exempel

Update database recommended action

Exempelbegäran

Exempelsvar

Definitioner

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ImplementationMethod

IsRetryable

RecommendedAction

RecommendedActionCurrentState

RecommendedActionErrorInfo

RecommendedActionImpactRecord

RecommendedActionImplementationInfo

RecommendedActionInitiatedBy

RecommendedActionMetricInfo

RecommendedActionStateInfo