Database Recommended Actions - Get

Servicio:: SQL Database

Versión de la API:: 2025-01-01

Obtiene una acción recomendada de base de datos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
advisorName	path	True	string	Nombre del Asistente para bases de datos.
databaseName	path	True	string	El nombre de la base de datos.
recommendedActionName	path	True	string	Nombre de la acción recomendada de base de datos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	RecommendedAction	Operación de Azure completada con éxito.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get database recommended action

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ImplementationMethod	Obtiene el método en el que se puede implementar manualmente esta acción recomendada. Por ejemplo, TSql, AzurePowerShell.
IsRetryable	Obtiene si se puede omitir el error y se podría reintentar la acción recomendada. Los valores posibles son: Sí/No
RecommendedAction	Acción recomendada de base de datos, servidor o grupo elástico.
RecommendedActionCurrentState	Estado actual en el que se encuentra la acción recomendada. Algunos estados usados habitualmente son: Activo:> acción recomendada está activa y aún no se ha realizado ninguna acción. Pendiente:> acción recomendada se aprueba y está esperando la ejecución. Ejecución:> acción recomendada se aplica en la base de datos de usuario. Comprobación:> acción recomendada se aplicó y se comprueba su utilidad por parte del sistema. Correcto:> acción recomendada se aplicó y se encontró una mejora durante la comprobación. Reversión pendiente:> comprobación encontró poca o ninguna mejora, por lo que la acción recomendada se pone en cola para revertir o el usuario se ha revertido manualmente. Reversión:> cambios realizados mientras se aplica la acción recomendada se revierte en la base de datos de usuario. Revertida:> revierte correctamente los cambios realizados por la acción recomendada en la base de datos de usuario. Omitido:> usuario omite o descarta explícitamente la acción recomendada.
RecommendedActionErrorInfo	Contiene información de error para una acción recomendada de Azure SQL Database, Server o Elastic Pool.
RecommendedActionImpactRecord	Contiene información sobre el impacto estimado u observado en diversas métricas para una Acción Recomendada de Azure SQL Database, Server o Elastic Pool.
RecommendedActionImplementationInfo	Contiene información para la implementación manual de una acción recomendada de Azure SQL Database, Server o Elastic Pool.
RecommendedActionInitiatedBy	Obtiene si el usuario o el sistema han proporcionado la aprobación para aplicar esta acción recomendada.
RecommendedActionMetricInfo	Contiene series temporales de varias métricas afectadas para una Acción Recomendada de Azure SQL Database, Server o Elastic Pool.
RecommendedActionStateInfo	Contiene información del estado actual para una acción recomendada de Azure SQL Database, Server o Elastic Pool.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ImplementationMethod

Enumeración

Obtiene el método en el que se puede implementar manualmente esta acción recomendada. Por ejemplo, TSql, AzurePowerShell.

Valor	Description
TSql	TSql
AzurePowerShell	AzurePowerShell

IsRetryable

Enumeración

Obtiene si se puede omitir el error y se podría reintentar la acción recomendada. Los valores posibles son: Sí/No

Valor	Description
Yes	Sí
No	No

RecommendedAction

Objeto

Acción recomendada de base de datos, servidor o grupo elástico.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo de recurso.
location	string	Ubicación del recurso.
name	string	Nombre del recurso
properties.details	object	Obtiene detalles adicionales específicos de esta acción recomendada.
properties.errorDetails	RecommendedActionErrorInfo	Obtiene los detalles del error si y por qué esta acción recomendada se coloca en estado de error.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Obtiene la información de impacto estimada para esta acción recomendada, por ejemplo, Ganancia estimada de CPU, Cambio estimado del espacio en disco.
properties.executeActionDuration	string (duration)	Obtiene el tiempo necesario para aplicar esta acción recomendada en el recurso de usuario. Por ejemplo, tiempo necesario para la creación de índices
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	Obtiene si el usuario o el sistema han proporcionado la aprobación para aplicar esta acción recomendada.
properties.executeActionInitiatedTime	string (date-time)	Obtiene la hora en que se aprobó esta acción recomendada para su ejecución.
properties.executeActionStartTime	string (date-time)	Obtiene la hora en que el sistema comenzó a aplicar esta acción recomendada en el recurso de usuario. Por ejemplo, hora de inicio de creación de índices
properties.implementationDetails	RecommendedActionImplementationInfo	Obtiene los detalles de implementación de esta acción recomendada para que el usuario la aplique manualmente.
properties.isArchivedAction	boolean	Obtiene si esta acción recomendada se sugirió hace algún tiempo, pero el usuario eligió omitir esto y el sistema agregó una nueva acción recomendada de nuevo.
properties.isExecutableAction	boolean	Obtiene si el usuario puede realizar esta acción recomendada
properties.isRevertableAction	boolean	Obtiene si el usuario puede revertir los cambios aplicados por esta acción recomendada.
properties.lastRefresh	string (date-time)	Obtiene la hora en que esta acción recomendada se actualizó por última vez.
properties.linkedObjects	string[]	Obtiene los objetos vinculados, si los hay.
properties.observedImpact	RecommendedActionImpactRecord[]	Obtiene la información de impacto real o observada para esta acción recomendada, por ejemplo, ganancia de CPU real, cambio de espacio en disco real
properties.recommendationReason	string	Obtiene el motivo para recomendar esta acción. Por ejemplo, DuplicateIndex
properties.revertActionDuration	string (duration)	Obtiene el tiempo necesario para revertir los cambios de esta acción recomendada en el recurso de usuario. Por ejemplo, tiempo necesario para quitar el índice creado.
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	Obtiene si el usuario o el sistema proporcionan la aprobación para revertir esta acción recomendada.
properties.revertActionInitiatedTime	string (date-time)	Obtiene la hora en que se aprobó esta acción recomendada para revertir.
properties.revertActionStartTime	string (date-time)	Obtiene la hora en que el sistema comenzó a revertir los cambios de esta acción recomendada en el recurso de usuario. Por ejemplo, la hora en que se ejecuta la eliminación de índices.
properties.score	integer (int32)	Obtiene el impacto de esta acción recomendada. Los valores posibles son 1 - Bajo impacto, 2 - Impacto medio y 3 - Alto impacto
properties.state	RecommendedActionStateInfo	Obtiene la información del estado actual en el que se encuentra la acción recomendada.
properties.timeSeries	RecommendedActionMetricInfo[]	Obtiene la información de serie temporal de métricas para esta acción recomendada, por ejemplo, series temporales de consumo de CPU.
properties.validSince	string (date-time)	Obtiene la hora desde que esta acción recomendada es válida.
systemData	systemData	Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft. Compute/virtualMachines" o "Microsoft. CuentasAlmacenamiento/Almacenamiento"

RecommendedActionCurrentState

Enumeración

Estado actual en el que se encuentra la acción recomendada. Algunos estados usados habitualmente son: Activo:> acción recomendada está activa y aún no se ha realizado ninguna acción. Pendiente:> acción recomendada se aprueba y está esperando la ejecución. Ejecución:> acción recomendada se aplica en la base de datos de usuario. Comprobación:> acción recomendada se aplicó y se comprueba su utilidad por parte del sistema. Correcto:> acción recomendada se aplicó y se encontró una mejora durante la comprobación. Reversión pendiente:> comprobación encontró poca o ninguna mejora, por lo que la acción recomendada se pone en cola para revertir o el usuario se ha revertido manualmente. Reversión:> cambios realizados mientras se aplica la acción recomendada se revierte en la base de datos de usuario. Revertida:> revierte correctamente los cambios realizados por la acción recomendada en la base de datos de usuario. Omitido:> usuario omite o descarta explícitamente la acción recomendada.

Valor	Description
Active	Activo
Pending	Pending
Executing	Ejecutar
Verifying	Verificación
PendingRevert	PendingRevert
RevertCancelled	RevertCancelled
Reverting	Revertiendo
Reverted	Revertido
Ignored	Ignored
Expired	Caducado
Monitoring	Supervisión
Resolved	Resuelto
Success	Success
Error	Error

RecommendedActionErrorInfo

Objeto

Contiene información de error para una acción recomendada de Azure SQL Database, Server o Elastic Pool.

Nombre	Tipo	Description
errorCode	string	Obtiene el motivo por el que la acción recomendada se puso en estado de error. Por ejemplo, DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Obtiene si se puede omitir el error y se podría reintentar la acción recomendada. Los valores posibles son: Sí/No

RecommendedActionImpactRecord

Objeto

Contiene información sobre el impacto estimado u observado en diversas métricas para una Acción Recomendada de Azure SQL Database, Server o Elastic Pool.

Nombre	Tipo	Description
absoluteValue	number (double)	Obtiene el valor absoluto de esta dimensión si procede. Por ejemplo, número de consultas afectadas
changeValueAbsolute	number (double)	Obtiene el cambio absoluto en el valor de esta dimensión. Por ejemplo, cambio de espacio en disco absoluto en Megabytes
changeValueRelative	number (double)	Obtiene el cambio relativo en el valor de esta dimensión. Por ejemplo, cambio de espacio en disco relativo en porcentaje
dimensionName	string	Obtiene el nombre de la dimensión de impacto. Por ejemplo, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Obtiene el nombre de la dimensión de impacto. Por ejemplo, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Objeto

Contiene información para la implementación manual de una acción recomendada de Azure SQL Database, Server o Elastic Pool.

Nombre	Tipo	Description
method	ImplementationMethod	Obtiene el método en el que se puede implementar manualmente esta acción recomendada. Por ejemplo, TSql, AzurePowerShell.
script	string	Obtiene el script de implementación manual. Por ejemplo, script de T-SQL que se podría ejecutar en la base de datos.

RecommendedActionInitiatedBy

Enumeración

Obtiene si el usuario o el sistema han proporcionado la aprobación para aplicar esta acción recomendada.

Valor	Description
User	Usuario
System	Sistema

RecommendedActionMetricInfo

Objeto

Contiene series temporales de varias métricas afectadas para una Acción Recomendada de Azure SQL Database, Server o Elastic Pool.

Nombre	Tipo	Description
metricName	string	Obtiene el nombre de la métrica. Por ejemplo, CPU, número de consultas.
startTime	string (date-time)	Obtiene la hora de inicio del intervalo de tiempo proporcionado por este MetricInfo.
timeGrain	string	Obtiene la duración del intervalo de tiempo para el valor proporcionado por este MetricInfo. Por ejemplo, PT1H (1 hora)
unit	string	Obtiene la unidad en la que se mide la métrica. Por ejemplo, DTU, Frecuencia
value	number (double)	Obtiene el valor de la métrica en el intervalo de tiempo proporcionado por este MetricInfo.

RecommendedActionStateInfo

Objeto

Contiene información del estado actual para una acción recomendada de Azure SQL Database, Server o Elastic Pool.

Nombre	Tipo	Description
actionInitiatedBy	RecommendedActionInitiatedBy	Obtiene quién inició la ejecución de esta acción recomendada. El valor posible es: Usuario:> Cuando el sistema notificado explícitamente por el usuario aplica la acción recomendada. Sistema:> Cuando el estado de ejecución automática de este asesor se estableció en "Habilitado", en cuyo caso el sistema lo aplicó.
currentValue	RecommendedActionCurrentState	Estado actual en el que se encuentra la acción recomendada. Algunos estados usados habitualmente son: Activo:> acción recomendada está activa y aún no se ha realizado ninguna acción. Pendiente:> acción recomendada se aprueba y está esperando la ejecución. Ejecución:> acción recomendada se aplica en la base de datos de usuario. Comprobación:> acción recomendada se aplicó y se comprueba su utilidad por parte del sistema. Correcto:> acción recomendada se aplicó y se encontró una mejora durante la comprobación. Reversión pendiente:> comprobación encontró poca o ninguna mejora, por lo que la acción recomendada se pone en cola para revertir o el usuario se ha revertido manualmente. Reversión:> cambios realizados mientras se aplica la acción recomendada se revierte en la base de datos de usuario. Revertida:> revierte correctamente los cambios realizados por la acción recomendada en la base de datos de usuario. Omitido:> usuario omite o descarta explícitamente la acción recomendada.
lastModified	string (date-time)	Obtiene la hora en que se modificó por última vez el estado.

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	La marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.