Database Recommended Actions - Get

Service:: SQL Database

Version d’API:: 2025-01-01

Obtient une action recommandée par la base de données.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
advisorName	path	True	string	Nom de l’Assistant Base de données.
databaseName	path	True	string	Nom de la base de données.
recommendedActionName	path	True	string	Nom de l’action recommandée de base de données.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	RecommendedAction	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get database recommended action

Exemple de requête

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

Exemple de réponse

Code d’état:: 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]"
    }
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ImplementationMethod	Obtient la méthode dans laquelle cette action recommandée peut être implémentée manuellement. Par exemple, TSql, AzurePowerShell.
IsRetryable	Obtient si l’erreur peut être ignorée et que l’action recommandée peut être retentée. Les valeurs possibles sont les suivantes : Oui/Non
RecommendedAction	Action recommandée pour la base de données, le serveur ou le pool élastique.
RecommendedActionCurrentState	État actuel dans lequel se trouve l’action recommandée. Certains états couramment utilisés sont : Actif -> action recommandée est active et aucune action n’a encore été effectuée. En attente :> action recommandée est approuvée et attend l’exécution. Exécution :> action recommandée est appliquée à la base de données utilisateur. Vérification :> action recommandée a été appliquée et est vérifiée de son utilité par le système. Réussite :> action recommandée a été appliquée et une amélioration a été trouvée lors de la vérification. Restauration en attente :> vérification a trouvé peu ou pas d’amélioration afin que l’action recommandée soit mise en file d’attente pour le rétablissement ou l’utilisateur a rétabli manuellement. Restauration :> modifications apportées lors de l’application de l’action recommandée sont rétablies sur la base de données utilisateur. Rétabli :> a rétabli les modifications apportées par l’action recommandée sur la base de données utilisateur. Ignoré :>'utilisateur a explicitement ignoré/ignoré l’action recommandée.
RecommendedActionErrorInfo	Contient des informations d’erreur pour une action recommandée d’Azure SQL Database, Server ou Elastic Pool.
RecommendedActionImpactRecord	Contient des informations sur l’impact estimé ou observé sur divers indicateurs pour une action recommandée de Azure SQL Database, Server ou Elastic Pool.
RecommendedActionImplementationInfo	Contient des informations pour l’implémentation manuelle d’une action recommandée Azure SQL Database, Server ou Elastic Pool.
RecommendedActionInitiatedBy	Obtient si l’approbation de l’application de cette action recommandée a été donnée par l’utilisateur/le système.
RecommendedActionMetricInfo	Contient des séries temporelles de diverses métriques impactées pour une action recommandée dans Azure SQL Database, Server ou Elastic Pool.
RecommendedActionStateInfo	Contient des informations sur l’état actuel pour une action recommandée dans Azure SQL Database, Server ou Elastic Pool.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ImplementationMethod

Énumération

Obtient la méthode dans laquelle cette action recommandée peut être implémentée manuellement. Par exemple, TSql, AzurePowerShell.

Valeur	Description
TSql	TSql
AzurePowerShell	AzurePowerShell

IsRetryable

Énumération

Obtient si l’erreur peut être ignorée et que l’action recommandée peut être retentée. Les valeurs possibles sont les suivantes : Oui/Non

Valeur	Description
Yes	Oui
No	Non

RecommendedAction

Objet

Action recommandée pour la base de données, le serveur ou le pool élastique.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
kind	string	Type de ressource.
location	string	Emplacement des ressources.
name	string	Nom de la ressource
properties.details	object	Obtient des détails supplémentaires spécifiques à cette action recommandée.
properties.errorDetails	RecommendedActionErrorInfo	Obtient les détails de l’erreur si et pourquoi cette action recommandée est mise à l’état d’erreur.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Obtient les informations d’impact estimées pour cette action recommandée, par exemple, Gain estimé du processeur, Modification estimée de l’espace disque
properties.executeActionDuration	string (duration)	Obtient le temps nécessaire pour appliquer cette action recommandée sur la ressource utilisateur. Par exemple, le temps nécessaire à la création d’index
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	Obtient si l’approbation de l’application de cette action recommandée a été donnée par l’utilisateur/le système.
properties.executeActionInitiatedTime	string (date-time)	Obtient l’heure à laquelle cette action recommandée a été approuvée pour l’exécution.
properties.executeActionStartTime	string (date-time)	Obtient l’heure à laquelle le système a commencé à appliquer cette action recommandée sur la ressource utilisateur. Par exemple, heure de début de la création d’index
properties.implementationDetails	RecommendedActionImplementationInfo	Obtient les détails de l’implémentation de cette action recommandée pour que l’utilisateur l’applique manuellement.
properties.isArchivedAction	boolean	Obtient si cette action recommandée a été suggérée il y a un certain temps, mais l’utilisateur a choisi d’ignorer cette action et le système a ajouté une nouvelle action recommandée à nouveau.
properties.isExecutableAction	boolean	Obtient si cette action recommandée peut être actionnable par l’utilisateur
properties.isRevertableAction	boolean	Obtient si les modifications appliquées par cette action recommandée peuvent être annulées par l’utilisateur
properties.lastRefresh	string (date-time)	Obtient l’heure à laquelle cette action recommandée a été actualisée pour la dernière fois.
properties.linkedObjects	string[]	Obtient les objets liés, le cas échéant.
properties.observedImpact	RecommendedActionImpactRecord[]	Obtient les informations d’impact observées/réelles pour cette action recommandée, par exemple, gain réel du processeur, modification de l’espace disque réel
properties.recommendationReason	string	Obtient la raison de recommander cette action. Par exemple, DuplicateIndex
properties.revertActionDuration	string (duration)	Obtient le temps nécessaire pour rétablir les modifications de cette action recommandée sur la ressource utilisateur. Par exemple, le temps nécessaire à la suppression de l’index créé.
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	Obtient si l’approbation de la restauration de cette action recommandée a été donnée par l’utilisateur/le système.
properties.revertActionInitiatedTime	string (date-time)	Obtient l’heure à laquelle cette action recommandée a été approuvée pour restauration.
properties.revertActionStartTime	string (date-time)	Obtient l’heure à laquelle le système a commencé à rétablir les modifications de cette action recommandée sur la ressource utilisateur. Par exemple, l’heure d’exécution de la suppression d’index.
properties.score	integer (int32)	Obtient l’impact de cette action recommandée. Les valeurs possibles sont 1 - Impact faible, 2 - Impact moyen et 3 - Impact élevé
properties.state	RecommendedActionStateInfo	Obtient les informations de l’état actuel dans lequel se trouve l’action recommandée.
properties.timeSeries	RecommendedActionMetricInfo[]	Obtient les informations de série chronologique des métriques pour cette action recommandée, par exemple, la série chronologique de consommation du processeur
properties.validSince	string (date-time)	Obtient l’heure depuis laquelle cette action recommandée est valide.
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

RecommendedActionCurrentState

Énumération

État actuel dans lequel se trouve l’action recommandée. Certains états couramment utilisés sont : Actif -> action recommandée est active et aucune action n’a encore été effectuée. En attente :> action recommandée est approuvée et attend l’exécution. Exécution :> action recommandée est appliquée à la base de données utilisateur. Vérification :> action recommandée a été appliquée et est vérifiée de son utilité par le système. Réussite :> action recommandée a été appliquée et une amélioration a été trouvée lors de la vérification. Restauration en attente :> vérification a trouvé peu ou pas d’amélioration afin que l’action recommandée soit mise en file d’attente pour le rétablissement ou l’utilisateur a rétabli manuellement. Restauration :> modifications apportées lors de l’application de l’action recommandée sont rétablies sur la base de données utilisateur. Rétabli :> a rétabli les modifications apportées par l’action recommandée sur la base de données utilisateur. Ignoré :>'utilisateur a explicitement ignoré/ignoré l’action recommandée.

Valeur	Description
Active	Activé
Pending	En attente
Executing	Exécution
Verifying	Vérification
PendingRevert	PendingRevert
RevertCancelled	RevertCancelled
Reverting	Retour en arrière
Reverted	Réédité
Ignored	Ignoré
Expired	Expiré
Monitoring	Supervision
Resolved	Résolu
Success	Success
Error	Error

RecommendedActionErrorInfo

Objet

Contient des informations d’erreur pour une action recommandée d’Azure SQL Database, Server ou Elastic Pool.

Nom	Type	Description
errorCode	string	Obtient la raison pour laquelle l’action recommandée a été mise à l’état d’erreur. Par exemple, DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Obtient si l’erreur peut être ignorée et que l’action recommandée peut être retentée. Les valeurs possibles sont les suivantes : Oui/Non

RecommendedActionImpactRecord

Objet

Contient des informations sur l’impact estimé ou observé sur divers indicateurs pour une action recommandée de Azure SQL Database, Server ou Elastic Pool.

Nom	Type	Description
absoluteValue	number (double)	Obtient la valeur absolue de cette dimension le cas échéant. Par exemple, nombre de requêtes affectées
changeValueAbsolute	number (double)	Obtient la modification absolue de la valeur de cette dimension. Par exemple, changement d’espace disque absolu en mégaoctets
changeValueRelative	number (double)	Obtient la modification relative de la valeur de cette dimension. Par exemple, modification de l’espace disque relatif en pourcentage
dimensionName	string	Obtient le nom de la dimension d’impact. Par exemple, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Obtient le nom de la dimension d’impact. Par exemple, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Objet

Contient des informations pour l’implémentation manuelle d’une action recommandée Azure SQL Database, Server ou Elastic Pool.

Nom	Type	Description
method	ImplementationMethod	Obtient la méthode dans laquelle cette action recommandée peut être implémentée manuellement. Par exemple, TSql, AzurePowerShell.
script	string	Obtient le script d’implémentation manuelle. Par exemple, un script T-SQL qui peut être exécuté sur la base de données.

RecommendedActionInitiatedBy

Énumération

Obtient si l’approbation de l’application de cette action recommandée a été donnée par l’utilisateur/le système.

Valeur	Description
User	Utilisateur
System	Système

RecommendedActionMetricInfo

Objet

Contient des séries temporelles de diverses métriques impactées pour une action recommandée dans Azure SQL Database, Server ou Elastic Pool.

Nom	Type	Description
metricName	string	Obtient le nom de la métrique. Par exemple, processeur, nombre de requêtes.
startTime	string (date-time)	Obtient l’heure de début de l’intervalle de temps donné par cette MetricInfo.
timeGrain	string	Obtient la durée de l’intervalle de temps pour la valeur donnée par cette MetricInfo. par exemple, PT1H (1 heure)
unit	string	Obtient l’unité dans laquelle la métrique est mesurée. par exemple, DTU, Frequency
value	number (double)	Obtient la valeur de la métrique dans l’intervalle de temps donné par cette MetricInfo.

RecommendedActionStateInfo

Objet

Contient des informations sur l’état actuel pour une action recommandée dans Azure SQL Database, Server ou Elastic Pool.

Nom	Type	Description
actionInitiatedBy	RecommendedActionInitiatedBy	Obtient qui a lancé l’exécution de cette action recommandée. La valeur possible est : Utilisateur -> Lorsque le système averti explicite par l’utilisateur doit appliquer l’action recommandée. Système -> Lorsque l’état d’exécution automatique de ce conseiller a été défini sur « Activé », auquel cas le système l’a appliqué.
currentValue	RecommendedActionCurrentState	État actuel dans lequel se trouve l’action recommandée. Certains états couramment utilisés sont : Actif -> action recommandée est active et aucune action n’a encore été effectuée. En attente :> action recommandée est approuvée et attend l’exécution. Exécution :> action recommandée est appliquée à la base de données utilisateur. Vérification :> action recommandée a été appliquée et est vérifiée de son utilité par le système. Réussite :> action recommandée a été appliquée et une amélioration a été trouvée lors de la vérification. Restauration en attente :> vérification a trouvé peu ou pas d’amélioration afin que l’action recommandée soit mise en file d’attente pour le rétablissement ou l’utilisateur a rétabli manuellement. Restauration :> modifications apportées lors de l’application de l’action recommandée sont rétablies sur la base de données utilisateur. Rétabli :> a rétabli les modifications apportées par l’action recommandée sur la base de données utilisateur. Ignoré :>'utilisateur a explicitement ignoré/ignoré l’action recommandée.
lastModified	string (date-time)	Obtient l’heure de la dernière modification de l’état

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.