Database Advisors - Update

Atualiza um orientador de banco de dados.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}?api-version=2025-01-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
advisorName
path True

string

O nome do Orientador 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 uma UUID.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome Obrigatório Tipo Description
properties.autoExecuteStatus True

AutoExecuteStatus

Obtém o status de execução automática (se deseja permitir que o sistema execute as recomendações) desse assistente. Os valores possíveis são 'Habilitado' e 'Desabilitado'

Respostas

Nome Tipo Description
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
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Update database advisor

Solicitação de exemplo

PATCH 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

{
  "properties": {
    "autoExecuteStatus": "Disabled"
  }
}

Resposta de exemplo

{
  "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

Nome Description
Advisor

Orientador de Banco de Dados, Servidor ou Pool Elástico.

AdvisorStatus

Obtém o status de disponibilidade desse assistente 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 deseja permitir que o sistema execute as recomendações) desse assistente. Os valores possíveis são 'Habilitado' e 'Desabilitado'

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 níveis diferentes (e herdados) na hierarquia de recursos. Os valores possíveis são 'Subscription', 'Server', 'ElasticPool', 'Database' e 'Default' (quando o status não é definido explicitamente em nenhum nível).

createdByType

O tipo de identidade que criou o recurso.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

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 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 está. Alguns estados comumente usados são: Ativo –> ação recomendada está ativa e nenhuma ação foi tomada ainda. Pendente –> ação recomendada é aprovada e aguarda a 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. Êxito -> ação recomendada foi aplicada e a melhoria encontrada durante a verificação. Pending Revert -> verificação encontrou pouca ou nenhuma melhoria, portanto, a ação recomendada é enfileirada para reverter ou o usuário foi revertido 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 ignorou/descartou explicitamente a ação recomendada.

RecommendedActionErrorInfo

Contém informações de erro para uma ação recomendada do Banco 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 Banco de Dados SQL do Azure, Server ou Elastic Pool.

RecommendedActionImplementationInfo

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

RecommendedActionInitiatedBy

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

RecommendedActionMetricInfo

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

RecommendedActionStateInfo

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

systemData

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

Advisor

Orientador de Banco de Dados, Servidor ou Pool Elástico.

Nome Tipo Description
id

string (arm-id)

ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

kind

string

Tipo de recurso.

location

string

Local do recurso.

name

string

O nome do recurso

properties.advisorStatus

AdvisorStatus

Obtém o status de disponibilidade desse assistente 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 deseja permitir que o sistema execute as recomendações) desse assistente. Os valores possíveis são 'Habilitado' e 'Desabilitado'

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 níveis diferentes (e herdados) na hierarquia de recursos. Os valores possíveis são 'Subscription', 'Server', 'ElasticPool', 'Database' e 'Default' (quando o status não é definido explicitamente 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 assistente.

properties.recommendationsStatus

string

Obtém esse status de recomendações para esse assistente e motivo para não ter nenhuma recomendação. Os valores possíveis incluem, mas não se limitam 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 assistente.

systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.

type

string

O tipo do recurso. Por exemplo, "Microsoft. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"

AdvisorStatus

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

Valor Description
GA

GA

PublicPreview

PublicPreview

LimitedPublicPreview

Prévia Pública Limitada

PrivatePreview

PrivatePreview

AutoExecuteStatus

Obtém o status de execução automática (se deseja permitir que o sistema execute as recomendações) desse assistente. Os valores possíveis são 'Habilitado' e 'Desabilitado'

Valor Description
Enabled

Habilitado

Disabled

Desactivado

Default

Default

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 níveis diferentes (e herdados) na hierarquia de recursos. Os valores possíveis são 'Subscription', 'Server', 'ElasticPool', 'Database' e 'Default' (quando o status não é definido explicitamente em nenhum nível).

Valor Description
Default

Default

Subscription

Subscription

Server

Servidor

ElasticPool

Elasticpool

Database

Banco de dados

createdByType

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
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 Description
TSql

TSql

AzurePowerShell

AzurePowerShell

IsRetryable

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

Valor Description
Yes

Sim

No

No

RecommendedAction

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

Nome Tipo Description
id

string (arm-id)

ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

kind

string

Tipo de recurso.

location

string

Local 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 essa ação recomendada, por exemplo, ganho estimado de CPU, alteração estimada do 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 essa ação recomendada foi fornecida pelo usuário/sistema.

properties.executeActionInitiatedTime

string (date-time)

Obtém a hora 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 essa ação recomendada é acionável pelo usuário

properties.isRevertableAction

boolean

Obtém se as alterações aplicadas por essa ação recomendada podem ser revertidas pelo usuário

properties.lastRefresh

string (date-time)

Obtém tempo quando 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 observadas/reais para esta ação recomendada, por exemplo, ganho real da CPU, alteração real do espaço em disco

properties.recommendationReason

string

Obtém o motivo para recomendar essa 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, o tempo necessário para remover o índice criado.

properties.revertActionInitiatedBy

RecommendedActionInitiatedBy

Obtém se a aprovação para reverter essa ação recomendada foi fornecida pelo usuário/sistema.

properties.revertActionInitiatedTime

string (date-time)

Obtém a hora em que essa ação recomendada foi aprovada para reverter.

properties.revertActionStartTime

string (date-time)

Obtém o tempo em que o sistema começou a reverter as alterações dessa ação recomendada no recurso do usuário. por exemplo, a hora em que a queda do índice é executada.

properties.score

integer (int32)

Obtém o impacto dessa ação recomendada. Os valores possíveis são 1 – Baixo impacto, 2 – Impacto Médio 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érie temporal de métricas para esta ação recomendada, por exemplo, série temporal 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. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"

RecommendedActionCurrentState

Estado atual em que a ação recomendada está. Alguns estados comumente usados são: Ativo –> ação recomendada está ativa e nenhuma ação foi tomada ainda. Pendente –> ação recomendada é aprovada e aguarda a 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. Êxito -> ação recomendada foi aplicada e a melhoria encontrada durante a verificação. Pending Revert -> verificação encontrou pouca ou nenhuma melhoria, portanto, a ação recomendada é enfileirada para reverter ou o usuário foi revertido 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 ignorou/descartou explicitamente a ação recomendada.

Valor Description
Active

Ativo

Pending

Pendente

Executing

Execução

Verifying

Verificação

PendingRevert

PendingRevert

RevertCancelled

RevertCancelled

Reverting

Revertendo

Reverted

Revertido

Ignored

Ignorado

Expired

Expirado

Monitoring

Monitorização

Resolved

Resolvido

Success

Êxito

Error

Erro

RecommendedActionErrorInfo

Contém informações de erro para uma ação recomendada do Banco de Dados SQL do Azure, Server ou Elastic Pool.

Nome Tipo Description
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 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 Banco de Dados SQL do Azure, Server ou Elastic Pool.

Nome Tipo Description
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 dessa dimensão. por exemplo, alteração de espaço em disco absoluto em Megabytes

changeValueRelative

number (double)

Obtém a alteração relativa no valor dessa dimensão. por exemplo, alteração de espaço em disco relativo em Porcentagem

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ções para implementação manual de uma Ação Recomendada do Banco de Dados SQL do Azure, Server ou Elastic Pool.

Nome Tipo Description
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 essa ação recomendada foi fornecida pelo usuário/sistema.

Valor Description
User

Usuário

System

System

RecommendedActionMetricInfo

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

Nome Tipo Description
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 dado 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ções sobre o estado atual para uma Ação Recomendada do Banco de Dados SQL do Azure, Server ou Elastic Pool.

Nome Tipo Description
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 notificou explicitamente o sistema para aplicar a ação recomendada. Sistema –> Quando o status de execução automática desse assistente foi definido como "Habilitado", nesse caso, o sistema o aplicou.

currentValue

RecommendedActionCurrentState

Estado atual em que a ação recomendada está. Alguns estados comumente usados são: Ativo –> ação recomendada está ativa e nenhuma ação foi tomada ainda. Pendente –> ação recomendada é aprovada e aguarda a 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. Êxito -> ação recomendada foi aplicada e a melhoria encontrada durante a verificação. Pending Revert -> verificação encontrou pouca ou nenhuma melhoria, portanto, a ação recomendada é enfileirada para reverter ou o usuário foi revertido 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 ignorou/descartou explicitamente a ação recomendada.

lastModified

string (date-time)

Obtém a hora em que o estado foi modificado pela última vez

systemData

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

Nome Tipo Description
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.