Database Recommended Actions - Get

Tjänst:: SQL Database

API-version:: 2025-01-01

Hämtar en rekommenderad databasåtgärd.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}?api-version=2025-01-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 minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	RecommendedAction	Azure-operationen slutfördes framgångsrikt.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get database recommended action

Exempelbegäran

GET 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=2025-01-01


/**
 * Samples for DatabaseRecommendedActions Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/DatabaseRecommendedActionGet.json
     */
    /**
     * Sample code: Get database recommended action.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void getDatabaseRecommendedAction(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getDatabaseRecommendedActions().getWithResponse("workloadinsight-demos", "misosisvr",
            "IndexAdvisor_test_3", "CreateIndex", "IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB",
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python database_recommended_action_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.database_recommended_actions.get(
        resource_group_name="workloadinsight-demos",
        server_name="misosisvr",
        database_name="IndexAdvisor_test_3",
        advisor_name="CreateIndex",
        recommended_action_name="IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB",
    )
    print(response)


# x-ms-original-file: 2025-01-01/DatabaseRecommendedActionGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets a database recommended action.
 *
 * @summary gets a database recommended action.
 * x-ms-original-file: 2025-01-01/DatabaseRecommendedActionGet.json
 */
async function getDatabaseRecommendedAction() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.databaseRecommendedActions.get(
    "workloadinsight-demos",
    "misosisvr",
    "IndexAdvisor_test_3",
    "CreateIndex",
    "IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB",
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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/SQL/stable/2025-01-01/examples/DatabaseRecommendedActionGet.json
// this example is just showing the usage of "DatabaseRecommendedActions_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 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
RecommendedActionResource result = await recommendedAction.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
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

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

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Resurshanteringsfelet ytterligare information.
ErrorDetail	Detaljerna om felet.
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 Azure SQL Database, Server eller Elastic Pool Recommended Action.
RecommendedActionImpactRecord	Innehåller information om uppskattad eller observerad påverkan på olika mätvärden för en Azure SQL Database, Server eller Elastic Pool Recommended Action.
RecommendedActionImplementationInfo	Innehåller information för manuell implementering av en Azure SQL Database, Server eller Elastic Pool Recommended Action.
RecommendedActionInitiatedBy	Hämtar om godkännande för att tillämpa den här rekommenderade åtgärden gavs av användare/system.
RecommendedActionMetricInfo	Innehåller tidsserier av olika påverkade mätvärden för en Azure SQL Database, Server eller Elastic Pool Recommended Action.
RecommendedActionStateInfo	Innehåller information om aktuellt tillstånd för en Azure SQL Database, Server eller Elastic Pool Recommended Action.
systemData	Metadata som rör skapande och senaste ändring av resursen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Resurshanteringsfelet ytterligare information.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Detaljerna om felet.

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

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felet objektet.

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	TSql
AzurePowerShell	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	Ja
No	No

RecommendedAction

Objekt

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

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Resurstyp.
location	string	Resursplats.
name	string	Namnet på resursen
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.
systemData	systemData	Azure Resource Manager-metadata som innehåller creationBy och modifiedBy-information.
type	string	Resurstypen. T.ex. "Microsoft. Compute/virtualMachines" eller "Microsoft. Storage/storageAccounts"

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	Aktivt
Pending	Avvaktan
Executing	Körs
Verifying	Verifiering
PendingRevert	PendingRevert
RevertCancelled	RevertCancelled
Reverting	Återgång
Reverted	Återställd
Ignored	Ignored
Expired	Expired
Monitoring	Övervakning
Resolved	Löst
Success	Success
Error	Error

RecommendedActionErrorInfo

Objekt

Innehåller felinformation för en Azure SQL Database, Server eller Elastic Pool Recommended Action.

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ätvärden för en Azure SQL Database, Server eller Elastic Pool Recommended Action.

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 av en Azure SQL Database, Server eller Elastic Pool Recommended Action.

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 om godkännande för att tillämpa den här rekommenderade åtgärden gavs av användare/system.

Värde	Description
User	User
System	System

RecommendedActionMetricInfo

Objekt

Innehåller tidsserier av olika påverkade mätvärden för en Azure SQL Database, Server eller Elastic Pool Recommended Action.

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 Azure SQL Database, Server eller Elastic Pool Recommended Action.

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

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.