Database Recommended Actions - Get

Service:: SQL Database

Versione API:: 2025-01-01

Ottiene un'azione consigliata per il database.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
advisorName	path	True	string	Nome di Database Advisor.
databaseName	path	True	string	Nome del database.
recommendedActionName	path	True	string	Nome dell'azione consigliata del database.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
serverName	path	True	string	Il nome del server.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	RecommendedAction	Operazione Azure completata con successo.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get database recommended action

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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]"
    }
  }
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
ImplementationMethod	Ottiene il metodo in cui questa azione consigliata può essere implementata manualmente. ad esempio TSql, AzurePowerShell.
IsRetryable	Ottiene un valore che indica se l'errore può essere ignorato e l'azione consigliata può essere ritentata. I valori possibili sono: Sì/No
RecommendedAction	Azione consigliata per database, server o pool elastico.
RecommendedActionCurrentState	Stato corrente in cui si trova l'azione consigliata. Alcuni stati di uso comune sono: Attivo ->'azione consigliata è attiva e non è stata ancora eseguita alcuna azione. In sospeso:>'azione consigliata viene approvata per ed è in attesa di esecuzione. Esecuzione:>'azione consigliata viene applicata al database utente. Verifica:>'azione consigliata è stata applicata e ne viene verificata l'utilità dal sistema. Esito positivo:>'azione consigliata è stata applicata e il miglioramento rilevati durante la verifica. Ripristino in sospeso:> verifica ha trovato poco o nessun miglioramento, quindi l'azione consigliata viene accodata per il ripristino o l'utente ha ripristinato manualmente. Ripristino:> modifiche apportate durante l'applicazione dell'azione consigliata vengono ripristinate nel database utente. Ripristino:> ripristinato correttamente le modifiche apportate dall'azione consigliata nel database utente. Ignorato:>'utente ha ignorato/ignorato in modo esplicito l'azione consigliata.
RecommendedActionErrorInfo	Contiene informazioni sugli errori per un'azione consigliata database SQL di Azure, Server o Elastic Pool.
RecommendedActionImpactRecord	Contiene informazioni sull'impatto stimato o osservato su varie metriche per un'azione raccomandata database SQL di Azure, Server o Elastic Pool.
RecommendedActionImplementationInfo	Contiene informazioni per l'implementazione manuale di un'azione consigliata per database SQL di Azure, Server o Elastic Pool.
RecommendedActionInitiatedBy	Ottiene se l'approvazione per l'applicazione di questa azione consigliata è stata assegnata dall'utente/sistema.
RecommendedActionMetricInfo	Contiene serie temporali di varie metriche impattate per un'azione consigliata database SQL di Azure, Server o Elastic Pool.
RecommendedActionStateInfo	Contiene informazioni sullo stato attuale per un'azione consigliata database SQL di Azure, Server o Elastic Pool.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ImplementationMethod

Enumerazione

Ottiene il metodo in cui questa azione consigliata può essere implementata manualmente. ad esempio TSql, AzurePowerShell.

Valore	Descrizione
TSql	TSql
AzurePowerShell	AzurePowerShell

IsRetryable

Enumerazione

Ottiene un valore che indica se l'errore può essere ignorato e l'azione consigliata può essere ritentata. I valori possibili sono: Sì/No

Valore	Descrizione
Yes	Sì
No	No

RecommendedAction

Oggetto

Azione consigliata per database, server o pool elastico.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo di risorsa.
location	string	Percorso della risorsa.
name	string	Nome della risorsa
properties.details	object	Ottiene dettagli aggiuntivi specifici di questa azione consigliata.
properties.errorDetails	RecommendedActionErrorInfo	Ottiene i dettagli dell'errore se e perché questa azione consigliata viene inserita nello stato di errore.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Ottiene le informazioni sull'impatto stimato per questa azione consigliata, ad esempio il guadagno stimato della CPU, la modifica dello spazio su disco stimato
properties.executeActionDuration	string (duration)	Ottiene il tempo impiegato per applicare questa azione consigliata alla risorsa utente. ad esempio, tempo impiegato per la creazione dell'indice
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	Ottiene se l'approvazione per l'applicazione di questa azione consigliata è stata assegnata dall'utente/sistema.
properties.executeActionInitiatedTime	string (date-time)	Ottiene l'ora in cui questa azione consigliata è stata approvata per l'esecuzione.
properties.executeActionStartTime	string (date-time)	Ottiene l'ora in cui il sistema ha iniziato ad applicare questa azione consigliata alla risorsa utente. ad esempio, ora di inizio della creazione dell'indice
properties.implementationDetails	RecommendedActionImplementationInfo	Ottiene i dettagli di implementazione di questa azione consigliata per l'applicazione manuale da parte dell'utente.
properties.isArchivedAction	boolean	Ottiene se questa azione consigliata è stata suggerita qualche tempo fa, ma l'utente ha scelto di ignorare questo e il sistema ha aggiunto di nuovo una nuova azione consigliata.
properties.isExecutableAction	boolean	Ottiene se questa azione consigliata può essere eseguita dall'utente
properties.isRevertableAction	boolean	Ottiene se le modifiche applicate da questa azione consigliata possono essere ripristinate dall'utente
properties.lastRefresh	string (date-time)	Ottiene l'ora dell'ultimo aggiornamento dell'azione consigliata.
properties.linkedObjects	string[]	Ottiene gli oggetti collegati, se presenti.
properties.observedImpact	RecommendedActionImpactRecord[]	Ottiene le informazioni sull'impatto osservato/effettivo per questa azione consigliata, ad esempio il guadagno effettivo della CPU, la modifica dello spazio su disco effettivo
properties.recommendationReason	string	Ottiene il motivo della raccomandazione di questa azione. ad esempio DuplicateIndex
properties.revertActionDuration	string (duration)	Ottiene il tempo impiegato per ripristinare le modifiche di questa azione consigliata sulla risorsa utente. Ad esempio, tempo impiegato per eliminare l'indice creato.
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	Ottiene se l'approvazione per il ripristino di questa azione consigliata è stata assegnata dall'utente/sistema.
properties.revertActionInitiatedTime	string (date-time)	Ottiene l'ora in cui questa azione consigliata è stata approvata per il ripristino.
properties.revertActionStartTime	string (date-time)	Ottiene l'ora in cui il sistema ha iniziato a ripristinare le modifiche di questa azione consigliata sulla risorsa utente. ad esempio l'ora in cui viene eseguita l'eliminazione dell'indice.
properties.score	integer (int32)	Ottiene l'impatto di questa azione consigliata. I valori possibili sono 1 - Impatto basso, 2 - Impatto medio e 3 - Impatto elevato
properties.state	RecommendedActionStateInfo	Ottiene le informazioni dello stato corrente in cui si trova l'azione consigliata.
properties.timeSeries	RecommendedActionMetricInfo[]	Ottiene le informazioni sulle serie temporali delle metriche per questa azione consigliata, ad esempio le serie temporali di utilizzo della CPU
properties.validSince	string (date-time)	Ottiene l'ora da quando questa azione consigliata è valida.
systemData	systemData	Azure Resource Manager metadati contenenti informazioni createBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio: "Microsoft. Compute/virtualMachines" oppure "Microsoft. Storage/storageAccounts"

RecommendedActionCurrentState

Enumerazione

Stato corrente in cui si trova l'azione consigliata. Alcuni stati di uso comune sono: Attivo ->'azione consigliata è attiva e non è stata ancora eseguita alcuna azione. In sospeso:>'azione consigliata viene approvata per ed è in attesa di esecuzione. Esecuzione:>'azione consigliata viene applicata al database utente. Verifica:>'azione consigliata è stata applicata e ne viene verificata l'utilità dal sistema. Esito positivo:>'azione consigliata è stata applicata e il miglioramento rilevati durante la verifica. Ripristino in sospeso:> verifica ha trovato poco o nessun miglioramento, quindi l'azione consigliata viene accodata per il ripristino o l'utente ha ripristinato manualmente. Ripristino:> modifiche apportate durante l'applicazione dell'azione consigliata vengono ripristinate nel database utente. Ripristino:> ripristinato correttamente le modifiche apportate dall'azione consigliata nel database utente. Ignorato:>'utente ha ignorato/ignorato in modo esplicito l'azione consigliata.

Valore	Descrizione
Active	Active
Pending	In sospeso
Executing	Esecuzione
Verifying	Verifica
PendingRevert	PendingRevert
RevertCancelled	RevertCancelled
Reverting	Ritorno
Reverted	Ritorno
Ignored	Ignorato
Expired	Scaduto
Monitoring	Monitoraggio
Resolved	Risolto
Success	Success
Error	Error

RecommendedActionErrorInfo

Oggetto

Contiene informazioni sugli errori per un'azione consigliata database SQL di Azure, Server o Elastic Pool.

Nome	Tipo	Descrizione
errorCode	string	Ottiene il motivo per cui l'azione consigliata è stata inserita nello stato di errore. ad esempio DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Ottiene un valore che indica se l'errore può essere ignorato e l'azione consigliata può essere ritentata. I valori possibili sono: Sì/No

RecommendedActionImpactRecord

Oggetto

Contiene informazioni sull'impatto stimato o osservato su varie metriche per un'azione raccomandata database SQL di Azure, Server o Elastic Pool.

Nome	Tipo	Descrizione
absoluteValue	number (double)	Ottiene il valore assoluto di questa dimensione, se applicabile. Ad esempio, numero di query interessate
changeValueAbsolute	number (double)	Ottiene la modifica assoluta nel valore di questa dimensione. ad esempio, modifica dello spazio su disco assoluto in megabyte
changeValueRelative	number (double)	Ottiene la modifica relativa nel valore di questa dimensione. Ad esempio, variazione dello spazio relativo su disco in Percentuale
dimensionName	string	Ottiene il nome della dimensione di impatto. ad esempio CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Ottiene il nome della dimensione di impatto. ad esempio CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Oggetto

Contiene informazioni per l'implementazione manuale di un'azione consigliata per database SQL di Azure, Server o Elastic Pool.

Nome	Tipo	Descrizione
method	ImplementationMethod	Ottiene il metodo in cui questa azione consigliata può essere implementata manualmente. ad esempio TSql, AzurePowerShell.
script	string	Ottiene lo script di implementazione manuale. Ad esempio, lo script T-SQL che può essere eseguito nel database.

RecommendedActionInitiatedBy

Enumerazione

Ottiene se l'approvazione per l'applicazione di questa azione consigliata è stata assegnata dall'utente/sistema.

Valore	Descrizione
User	User
System	System

RecommendedActionMetricInfo

Oggetto

Contiene serie temporali di varie metriche impattate per un'azione consigliata database SQL di Azure, Server o Elastic Pool.

Nome	Tipo	Descrizione
metricName	string	Ottiene il nome della metrica. ad esempio CPU, Numero di query.
startTime	string (date-time)	Ottiene l'ora di inizio dell'intervallo di tempo specificato da metricinfo.
timeGrain	string	Ottiene la durata dell'intervallo di tempo per il valore specificato da metricinfo. ad esempio PT1H (1 ora)
unit	string	Ottiene l'unità in cui viene misurata la metrica. ad esempio DTU, Frequenza
value	number (double)	Ottiene il valore della metrica nell'intervallo di tempo specificato da metricinfo.

RecommendedActionStateInfo

Oggetto

Contiene informazioni sullo stato attuale per un'azione consigliata database SQL di Azure, Server o Elastic Pool.

Nome	Tipo	Descrizione
actionInitiatedBy	RecommendedActionInitiatedBy	Ottiene chi ha avviato l'esecuzione di questa azione consigliata. Il valore possibile è: User -> When user explicity notified system to apply the recommended action ( Utente -> Quando l'utente riceve una notifica esplicita per applicare l'azione consigliata. Sistema :> Quando lo stato di esecuzione automatica di questo advisor è stato impostato su "Abilitato", nel qual caso il sistema lo ha applicato.
currentValue	RecommendedActionCurrentState	Stato corrente in cui si trova l'azione consigliata. Alcuni stati di uso comune sono: Attivo ->'azione consigliata è attiva e non è stata ancora eseguita alcuna azione. In sospeso:>'azione consigliata viene approvata per ed è in attesa di esecuzione. Esecuzione:>'azione consigliata viene applicata al database utente. Verifica:>'azione consigliata è stata applicata e ne viene verificata l'utilità dal sistema. Esito positivo:>'azione consigliata è stata applicata e il miglioramento rilevati durante la verifica. Ripristino in sospeso:> verifica ha trovato poco o nessun miglioramento, quindi l'azione consigliata viene accodata per il ripristino o l'utente ha ripristinato manualmente. Ripristino:> modifiche apportate durante l'applicazione dell'azione consigliata vengono ripristinate nel database utente. Ripristino:> ripristinato correttamente le modifiche apportate dall'azione consigliata nel database utente. Ignorato:>'utente ha ignorato/ignorato in modo esplicito l'azione consigliata.
lastModified	string (date-time)	Ottiene l'ora dell'ultima modifica dello stato

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Il timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.