Database Recommended Actions - Get

Serviço:: SQL Database

Versão da API:: 2025-01-01

Obtém uma ação recomendada do banco de dados.

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 do URI

Name	Em	Obrigatório	Tipo	Descrição
advisorName	path	True	string	O nome do Consultor de Banco de Dados.
databaseName	path	True	string	O nome do banco de dados.
recommendedActionName	path	True	string	O nome da Ação Recomendada do Banco de Dados.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Descrição
200 OK	RecommendedAction	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get database recommended action

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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]"
    }
  }
}

Definições

Name	Descrição
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ImplementationMethod	Obtém o método no qual essa ação recomendada pode ser implementada manualmente. por exemplo, TSql, AzurePowerShell.
IsRetryable	Obtém se o erro pode ser ignorado e se a ação recomendada pode ser repetida. Os valores possíveis são: Sim/Não
RecommendedAction	Ação recomendada de banco de dados, servidor ou pool elástico.
RecommendedActionCurrentState	Estado atual em que a ação recomendada se encontra. Alguns estados comumente usados são: Ativo -> ação recomendada está ativa e nenhuma ação foi tomada ainda. Pendente -> ação recomendada foi aprovada e aguarda execução. Execução -> ação recomendada está sendo aplicada no banco de dados do usuário. Verificação -> ação recomendada foi aplicada e está sendo verificada de sua utilidade pelo sistema. Sucesso -> ação recomendada foi aplicada e melhorias encontradas durante a verificação. Reverter pendente -> verificação encontrou pouca ou nenhuma melhoria, portanto, a ação recomendada é enfileirada para reversão ou o usuário reverteu manualmente. Reverter -> alterações feitas durante a aplicação da ação recomendada estão sendo revertidas no banco de dados do usuário. Revertido -> reverteu com êxito as alterações feitas pela ação recomendada no banco de dados do usuário. Ignorado -> usuário explicitamente ignorou/descartou a ação recomendada.
RecommendedActionErrorInfo	Contém informação de erro para uma Ação Recomendada da Base de Dados SQL do Azure, Server ou Elastic Pool.
RecommendedActionImpactRecord	Contém informações sobre impacto estimado ou observado em várias métricas para uma Ação Recomendada do Base de Dados SQL do Azure, Server ou Elastic Pool.
RecommendedActionImplementationInfo	Contém informação para implementação manual para uma Ação Recomendada da Base de Dados SQL do Azure, Server ou Elastic Pool.
RecommendedActionInitiatedBy	Obtém se a aprovação para aplicar esta ação recomendada foi dada pelo usuário/sistema.
RecommendedActionMetricInfo	Contém séries temporais de várias métricas impactadas para uma Ação Recomendada da Base de Dados SQL do Azure, Server ou Elastic Pool.
RecommendedActionStateInfo	Contém informação do estado atual para uma Ação Recomendada da Base de Dados SQL do Azure, Server ou Elastic Pool.
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Descrição
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

ImplementationMethod

Enumeração

Obtém o método no qual essa ação recomendada pode ser implementada manualmente. por exemplo, TSql, AzurePowerShell.

Valor	Descrição
TSql	TSql
AzurePowerShell	AzurePowerShell

IsRetryable

Enumeração

Obtém se o erro pode ser ignorado e se a ação recomendada pode ser repetida. Os valores possíveis são: Sim/Não

Valor	Descrição
Yes	Sim
No	No

RecommendedAction

Object

Ação recomendada de banco de dados, servidor ou pool elástico.

Name	Tipo	Descrição
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo de recurso.
location	string	Localização do recurso.
name	string	O nome do recurso
properties.details	object	Obtém detalhes adicionais específicos para esta ação recomendada.
properties.errorDetails	RecommendedActionErrorInfo	Obtém os detalhes do erro se e por que essa ação recomendada é colocada no estado de erro.
properties.estimatedImpact	RecommendedActionImpactRecord[]	Obtém as informações de impacto estimadas para esta ação recomendada, por exemplo, Ganho estimado de CPU, Alteração estimada de espaço em disco
properties.executeActionDuration	string (duration)	Obtém o tempo necessário para aplicar essa ação recomendada no recurso do usuário. Por exemplo, tempo necessário para a criação do índice
properties.executeActionInitiatedBy	RecommendedActionInitiatedBy	Obtém se a aprovação para aplicar esta ação recomendada foi dada pelo usuário/sistema.
properties.executeActionInitiatedTime	string (date-time)	Obtém o tempo em que essa ação recomendada foi aprovada para execução.
properties.executeActionStartTime	string (date-time)	Obtém a hora em que o sistema começou a aplicar essa ação recomendada no recurso do usuário. por exemplo, hora de início da criação do índice
properties.implementationDetails	RecommendedActionImplementationInfo	Obtém os detalhes de implementação dessa ação recomendada para o usuário aplicá-la manualmente.
properties.isArchivedAction	boolean	Obtém se essa ação recomendada foi sugerida há algum tempo, mas o usuário optou por ignorar isso e o sistema adicionou uma nova ação recomendada novamente.
properties.isExecutableAction	boolean	Obtém se esta ação recomendada for acionável pelo usuário
properties.isRevertableAction	boolean	Obtém se as alterações aplicadas por esta ação recomendada podem ser revertidas pelo usuário
properties.lastRefresh	string (date-time)	Obtém o tempo em que essa ação recomendada foi atualizada pela última vez.
properties.linkedObjects	string[]	Obtém os objetos vinculados, se houver.
properties.observedImpact	RecommendedActionImpactRecord[]	Obtém as informações de impacto observado/real para esta ação recomendada, por exemplo, ganho real de CPU, alteração de espaço em disco real
properties.recommendationReason	string	Obtém o motivo para recomendar esta ação. por exemplo, DuplicateIndex
properties.revertActionDuration	string (duration)	Obtém o tempo necessário para reverter as alterações dessa ação recomendada no recurso do usuário. por exemplo, tempo necessário para descartar o índice criado.
properties.revertActionInitiatedBy	RecommendedActionInitiatedBy	Obtém se a aprovação para reverter esta ação recomendada foi dada pelo usuário/sistema.
properties.revertActionInitiatedTime	string (date-time)	Obtém o tempo em que essa ação recomendada foi aprovada para reversão.
properties.revertActionStartTime	string (date-time)	Obtém a hora em que o sistema começou a reverter as alterações dessa ação recomendada no recurso do usuário. por exemplo, momento em que a queda do índice é executada.
properties.score	integer (int32)	Obtém o impacto desta ação recomendada. Os valores possíveis são 1 - Baixo impacto, 2 - Médio Impacto e 3 - Alto Impacto
properties.state	RecommendedActionStateInfo	Obtém as informações do estado atual em que a ação recomendada está.
properties.timeSeries	RecommendedActionMetricInfo[]	Obtém as informações de séries temporais de métricas para esta ação recomendada, por exemplo, séries temporais de consumo de CPU
properties.validSince	string (date-time)	Obtém o tempo desde quando essa ação recomendada é válida.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

RecommendedActionCurrentState

Enumeração

Estado atual em que a ação recomendada se encontra. Alguns estados comumente usados são: Ativo -> ação recomendada está ativa e nenhuma ação foi tomada ainda. Pendente -> ação recomendada foi aprovada e aguarda execução. Execução -> ação recomendada está sendo aplicada no banco de dados do usuário. Verificação -> ação recomendada foi aplicada e está sendo verificada de sua utilidade pelo sistema. Sucesso -> ação recomendada foi aplicada e melhorias encontradas durante a verificação. Reverter pendente -> verificação encontrou pouca ou nenhuma melhoria, portanto, a ação recomendada é enfileirada para reversão ou o usuário reverteu manualmente. Reverter -> alterações feitas durante a aplicação da ação recomendada estão sendo revertidas no banco de dados do usuário. Revertido -> reverteu com êxito as alterações feitas pela ação recomendada no banco de dados do usuário. Ignorado -> usuário explicitamente ignorou/descartou a ação recomendada.

Valor	Descrição
Active	Ativos
Pending	Pendente
Executing	A executar
Verifying	Verificação
PendingRevert	PendingRevert
RevertCancelled	RevertCancelled
Reverting	Reverter
Reverted	Revertido
Ignored	Ignorado
Expired	Fora do prazo
Monitoring	Monitorização
Resolved	Resolvido
Success	Sucesso
Error	Erro

RecommendedActionErrorInfo

Object

Contém informação de erro para uma Ação Recomendada da Base de Dados SQL do Azure, Server ou Elastic Pool.

Name	Tipo	Descrição
errorCode	string	Obtém o motivo pelo qual a ação recomendada foi colocada no estado de erro. por exemplo, DatabaseHasQdsOff, IndexAlreadyExists
isRetryable	IsRetryable	Obtém se o erro pode ser ignorado e se a ação recomendada pode ser repetida. Os valores possíveis são: Sim/Não

RecommendedActionImpactRecord

Object

Contém informações sobre impacto estimado ou observado em várias métricas para uma Ação Recomendada do Base de Dados SQL do Azure, Server ou Elastic Pool.

Name	Tipo	Descrição
absoluteValue	number (double)	Obtém o valor absoluto dessa dimensão, se aplicável. por exemplo, número de consultas afetadas
changeValueAbsolute	number (double)	Obtém a alteração absoluta no valor desta dimensão. por exemplo, alteração absoluta de espaço em disco em Megabytes
changeValueRelative	number (double)	Obtém a alteração relativa no valor dessa dimensão. por exemplo, alteração relativa do espaço em disco em percentagem
dimensionName	string	Obtém o nome da dimensão de impacto. por exemplo, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.
unit	string	Obtém o nome da dimensão de impacto. por exemplo, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Object

Contém informação para implementação manual para uma Ação Recomendada da Base de Dados SQL do Azure, Server ou Elastic Pool.

Name	Tipo	Descrição
method	ImplementationMethod	Obtém o método no qual essa ação recomendada pode ser implementada manualmente. por exemplo, TSql, AzurePowerShell.
script	string	Obtém o script de implementação manual. por exemplo, script T-SQL que pode ser executado no banco de dados.

RecommendedActionInitiatedBy

Enumeração

Obtém se a aprovação para aplicar esta ação recomendada foi dada pelo usuário/sistema.

Valor	Descrição
User	User
System	Sistema

RecommendedActionMetricInfo

Object

Contém séries temporais de várias métricas impactadas para uma Ação Recomendada da Base de Dados SQL do Azure, Server ou Elastic Pool.

Name	Tipo	Descrição
metricName	string	Obtém o nome da métrica. por exemplo, CPU, número de consultas.
startTime	string (date-time)	Obtém a hora de início do intervalo de tempo dada por este MetricInfo.
timeGrain	string	Obtém a duração do intervalo de tempo para o valor fornecido por este MetricInfo. por exemplo, PT1H (1 hora)
unit	string	Obtém a unidade na qual a métrica é medida. por exemplo, DTU, Frequência
value	number (double)	Obtém o valor da métrica no intervalo de tempo fornecido por este MetricInfo.

RecommendedActionStateInfo

Object

Contém informação do estado atual para uma Ação Recomendada da Base de Dados SQL do Azure, Server ou Elastic Pool.

Name	Tipo	Descrição
actionInitiatedBy	RecommendedActionInitiatedBy	Obtém quem iniciou a execução desta ação recomendada. Os valores possíveis são: Usuário -> Quando o usuário explicitamente notificado sistema para aplicar a ação recomendada. Sistema -> Quando o estado de execução automática deste consultor foi definido como 'Ativado', caso em que o sistema o aplicou.
currentValue	RecommendedActionCurrentState	Estado atual em que a ação recomendada se encontra. Alguns estados comumente usados são: Ativo -> ação recomendada está ativa e nenhuma ação foi tomada ainda. Pendente -> ação recomendada foi aprovada e aguarda execução. Execução -> ação recomendada está sendo aplicada no banco de dados do usuário. Verificação -> ação recomendada foi aplicada e está sendo verificada de sua utilidade pelo sistema. Sucesso -> ação recomendada foi aplicada e melhorias encontradas durante a verificação. Reverter pendente -> verificação encontrou pouca ou nenhuma melhoria, portanto, a ação recomendada é enfileirada para reversão ou o usuário reverteu manualmente. Reverter -> alterações feitas durante a aplicação da ação recomendada estão sendo revertidas no banco de dados do usuário. Revertido -> reverteu com êxito as alterações feitas pela ação recomendada no banco de dados do usuário. Ignorado -> usuário explicitamente ignorou/descartou a ação recomendada.
lastModified	string (date-time)	Obtém a hora em que o estado foi modificado pela última vez

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Descrição
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.