Database Advisors - Get

Obtém um consultor de banco de dados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}?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.

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

Advisor

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 advisor

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?api-version=2025-01-01

Resposta da amostra

{
  "name": "CreateIndex",
  "type": "Microsoft.Sql/servers/databases/advisors",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/databases/IndexAdvisor_test_3/advisors/CreateIndex",
  "properties": {
    "advisorStatus": "GA",
    "autoExecuteStatus": "Disabled",
    "lastChecked": "2017-06-20T00:24:39Z",
    "recommendationsStatus": "Ok"
  }
}

Definições

Name Descrição
Advisor

Banco de dados, servidor ou Elastic Pool Advisor.

AdvisorStatus

Obtém o status de disponibilidade deste consultor para os clientes. Os valores possíveis são 'GA', 'PublicPreview', 'LimitedPublicPreview' e 'PrivatePreview'.

AutoExecuteStatus

Obtém o status de execução automática (se o sistema deve executar as recomendações) deste consultor. Os valores possíveis são 'Enabled' e 'Disabled'

AutoExecuteStatusInheritedFrom

Obtém o recurso do qual o valor atual do status de execução automática é herdado. O status de execução automática pode ser definido em (e herdado de) diferentes níveis na hierarquia de recursos. Os valores possíveis são 'Subscription', 'Server', 'ElasticPool', 'Database' e 'Default' (quando o status não é explicitamente definido em nenhum nível).

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.

Advisor

Banco de dados, servidor ou Elastic Pool Advisor.

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.advisorStatus

AdvisorStatus

Obtém o status de disponibilidade deste consultor para os clientes. Os valores possíveis são 'GA', 'PublicPreview', 'LimitedPublicPreview' e 'PrivatePreview'.

properties.autoExecuteStatus

AutoExecuteStatus

Obtém o status de execução automática (se o sistema deve executar as recomendações) deste consultor. Os valores possíveis são 'Enabled' e 'Disabled'

properties.autoExecuteStatusInheritedFrom

AutoExecuteStatusInheritedFrom

Obtém o recurso do qual o valor atual do status de execução automática é herdado. O status de execução automática pode ser definido em (e herdado de) diferentes níveis na hierarquia de recursos. Os valores possíveis são 'Subscription', 'Server', 'ElasticPool', 'Database' e 'Default' (quando o status não é explicitamente definido em nenhum nível).

properties.lastChecked

string (date-time)

Obtém o tempo em que o recurso atual foi analisado para recomendações por este orientador.

properties.recommendationsStatus

string

Obtém esse status de recomendações para este conselheiro e motivo para não ter nenhuma recomendação. Os valores possíveis incluem, mas não estão limitados a, 'Ok' (Recomendações disponíveis), LowActivity (carga de trabalho insuficiente para analisar), 'DbSeemsTuned' (O banco de dados está indo bem), etc.

properties.recommendedActions

RecommendedAction[]

Obtém as ações recomendadas para este orientador.

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"

AdvisorStatus

Obtém o status de disponibilidade deste consultor para os clientes. Os valores possíveis são 'GA', 'PublicPreview', 'LimitedPublicPreview' e 'PrivatePreview'.

Valor Descrição
GA

disponibilidade geral

PublicPreview

Pré-visualização Pública

LimitedPublicPreview

Pré-visualização PúblicaLimitada

PrivatePreview

Pré-visualização privada

AutoExecuteStatus

Obtém o status de execução automática (se o sistema deve executar as recomendações) deste consultor. Os valores possíveis são 'Enabled' e 'Disabled'

Valor Descrição
Enabled

Ativado

Disabled

Disabled

Default

Predefinição

AutoExecuteStatusInheritedFrom

Obtém o recurso do qual o valor atual do status de execução automática é herdado. O status de execução automática pode ser definido em (e herdado de) diferentes níveis na hierarquia de recursos. Os valores possíveis são 'Subscription', 'Server', 'ElasticPool', 'Database' e 'Default' (quando o status não é explicitamente definido em nenhum nível).

Valor Descrição
Default

Predefinição

Subscription

Subscription

Server

Server

ElasticPool

Piscina Elástica

Database

Base de dados

createdByType

O tipo de identidade que criou o recurso.

Valor Descrição
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

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

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

Resposta de erro

Name Tipo Descrição
error

ErrorDetail

O objeto de erro.

ImplementationMethod

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

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

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

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

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

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

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

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

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

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

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.