Compartilhar via

Database Recommended Actions - Update

  • Referência
Serviço:
SQL Database
Versão da API:
2021-11-01

Atualizações uma ação recomendada do banco de dados.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}?api-version=2021-11-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.
recommendedActionName
 path True

string

O nome da Ação Recomendada do Banco de Dados.
resourceGroupName
 path True

string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
serverName
 path True

string

O nome do servidor.
subscriptionId
 path True

string

A ID de assinatura que identifica uma assinatura do Azure.
api-version
 query True

string

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

Corpo da solicitação

Nome Obrigatório Tipo Description
properties.state True

RecommendedActionStateInfo

Obtém as informações do estado atual em que a ação recomendada está.

Respostas

Nome Tipo Description
200 OK

RecommendedAction

Atualizou com êxito a ação recomendada do banco de dados especificado.
Other Status Codes

Respostas de erro: ***

  • 400 FeatureDisabledOnSelectedEdition - O usuário tentou usar um recurso que está desabilitado na edição atual do banco de dados.

  • 400 InvalidIdentifier - O identificador contém NULL ou um caractere unicode inválido.

  • 400 InvalidRecommendedActionUpsertRequest - O corpo da solicitação de ação recomendada de atualização não existe ou não tem nenhuma propriedade ou objeto de estado.

  • 400 InvalidRecommendedActionState - O estado especificado para a ação recomendada é inválido

  • 404 DatabaseDoesNotExist - O banco de dados solicitado não foi encontrado

  • 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado

  • 404 SubscriptionDoesNotHaveElasticPool - O pool elástico solicitado não foi encontrado

  • 404 AdvisorNotFound - O assistente solicitado não foi encontrado.

  • 404 RecommendedActionNotFound - A ação recomendada solicitada não foi encontrada.

  • 404 AdvisorNotFound - O assistente solicitado não foi encontrado.

  • 404 RecommendedActionNotFound - A ação recomendada solicitada não foi encontrada.

  • 405 NotSupported – não há suporte para essa funcionalidade.

  • Conflito 409 – A solicitação não pôde ser processada devido a conflitos na solicitação.

  • 503 ServiceTemporarilyUnavailable - Recurso temporariamente indisponível.

Exemplos

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/recommendedActions/IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB?api-version=2021-11-01

{
  "properties": {
    "state": {
      "currentValue": "Pending"
    }
  }
}

Resposta de exemplo

Código de status:
200 
{
  "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",
  "name": "IR_[CRM]_[DataPoints]_4821CD2F9510D98184BB",
  "type": "Microsoft.Sql/servers/databases/advisors/recommendedActions",
  "location": "East Asia",
  "kind": "",
  "properties": {
    "recommendationReason": "",
    "validSince": "2017-03-01T14:38:04Z",
    "lastRefresh": "2017-03-01T14:38:04Z",
    "state": {
      "currentValue": "Pending",
      "actionInitiatedBy": "User",
      "lastModified": "2017-06-20T15:11:15Z"
    },
    "isExecutableAction": true,
    "isRevertableAction": true,
    "isArchivedAction": false,
    "executeActionInitiatedBy": "User",
    "executeActionInitiatedTime": "2017-06-20T15:11:15Z",
    "score": 1,
    "implementationDetails": {
      "method": "TSql",
      "script": "CREATE NONCLUSTERED INDEX [nci_wi_DataPoints_B892614093BAC56295EF6018BD4CB51B] ON [CRM].[DataPoints] ([Name],[Money],[Power]) INCLUDE ([Hour], [System], [LastChanged]) WITH (ONLINE = ON)"
    },
    "errorDetails": {},
    "estimatedImpact": [
      {
        "dimensionName": "ActionDuration",
        "unit": "Seconds",
        "absoluteValue": 1440
      },
      {
        "dimensionName": "SpaceChange",
        "unit": "Megabytes",
        "absoluteValue": 209.3125
      }
    ],
    "observedImpact": [],
    "timeSeries": [],
    "details": {
      "indexName": "nci_wi_DataPoints_B892614093BAC56295EF6018BD4CB51B",
      "indexType": "NONCLUSTERED",
      "schema": "[CRM]",
      "table": "[DataPoints]",
      "indexColumns": "[Name],[Money],[Power]",
      "includedColumns": "[Hour], [System], [LastChanged]"
    }
  }
}

Definições

Nome Description
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 ação recomendada está ativa e nenhuma ação foi tomada ainda. Pendente –> a ação recomendada é aprovada para e está aguardando a execução. Execução –> a ação recomendada está sendo aplicada no banco de dados do usuário. Verificação –> a ação recomendada foi aplicada e está sendo verificada de sua utilidade pelo sistema. Êxito –> a ação recomendada foi aplicada e a melhoria encontrada durante a verificação. Reverter pendente –> a verificação encontrou pouca ou nenhuma melhoria, portanto, a ação recomendada é enfileirada para reverter ou o usuário foi revertido manualmente. Revertendo –> as 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 –> o usuário ignorou/descartou explicitamente a ação recomendada.
RecommendedActionErrorInfo

Contém informações de erro para uma ação recomendada de banco de dados SQL do Azure, servidor ou pool elástico.
RecommendedActionImpactRecord

Contém informações de impacto estimado ou observado em várias métricas para uma ação recomendada de banco de dados SQL do Azure, servidor ou pool elástico.
RecommendedActionImplementationInfo

Contém informações para implementação manual para uma ação recomendada de banco de dados SQL do Azure, servidor ou pool elástico.
RecommendedActionInitiatedBy

Obtém quem iniciou a execução dessa ação recomendada. 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.
RecommendedActionMetricInfo

Contém séries temporais de várias métricas afetadas para uma ação recomendada de banco de dados SQL do Azure, servidor ou pool elástico.
RecommendedActionStateInfo

Contém informações do estado atual para uma ação recomendada de banco de dados SQL do Azure, servidor ou pool elástico.

ImplementationMethod

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

Nome Tipo Description
AzurePowerShell

string

TSql

string

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

Nome Tipo Description
No

string

Yes

string

RecommendedAction

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

Nome Tipo Description
id

string

ID do recurso.
kind

string

Tipo de recurso.
location

string

Local do recurso.
name

string

Nome do recurso.
properties.details

object

Obtém detalhes adicionais específicos para essa 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 da CPU, Alteração estimada do espaço em disco
properties.executeActionDuration

string

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

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

string

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

Obtém a hora 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 observadas/reais para essa 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

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

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

string

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, a hora em que a queda do índice é executada.
properties.score

integer

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 essa ação recomendada, por exemplo, série temporal de consumo de CPU
properties.validSince

string

Obtém o tempo desde quando essa ação recomendada é válida.
type

string

Tipo de recurso.

RecommendedActionCurrentState

Estado atual em que a ação recomendada está. Alguns estados comumente usados são: Ativo –> a ação recomendada está ativa e nenhuma ação foi tomada ainda. Pendente –> a ação recomendada é aprovada para e está aguardando a execução. Execução –> a ação recomendada está sendo aplicada no banco de dados do usuário. Verificação –> a ação recomendada foi aplicada e está sendo verificada de sua utilidade pelo sistema. Êxito –> a ação recomendada foi aplicada e a melhoria encontrada durante a verificação. Reverter pendente –> a verificação encontrou pouca ou nenhuma melhoria, portanto, a ação recomendada é enfileirada para reverter ou o usuário foi revertido manualmente. Revertendo –> as 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 –> o usuário ignorou/descartou explicitamente a ação recomendada.

Nome Tipo Description
Active

string

Error

string

Executing

string

Expired

string

Ignored

string

Monitoring

string

Pending

string

PendingRevert

string

Resolved

string

RevertCancelled

string

Reverted

string

Reverting

string

Success

string

Verifying

string

RecommendedActionErrorInfo

Contém informações de erro para uma ação recomendada de banco de dados SQL do Azure, servidor ou pool elástico.

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 de impacto estimado ou observado em várias métricas para uma ação recomendada de banco de dados SQL do Azure, servidor ou pool elástico.

Nome Tipo Description
absoluteValue

number

Obtém o valor absoluto dessa dimensão, se aplicável. por exemplo, número de consultas afetadas
changeValueAbsolute

number

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

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 para uma ação recomendada de banco de dados SQL do Azure, servidor ou pool elástico.

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 quem iniciou a execução dessa ação recomendada. 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.

Nome Tipo Description
System

string

User

string

RecommendedActionMetricInfo

Contém séries temporais de várias métricas afetadas para uma ação recomendada de banco de dados SQL do Azure, servidor ou pool elástico.

Nome Tipo Description
metricName

string

Obtém o nome da métrica. por exemplo, CPU, Número de Consultas.
startTime

string

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

Obtém o valor da métrica no intervalo de tempo fornecido por este MetricInfo.

RecommendedActionStateInfo

Contém informações do estado atual para uma ação recomendada de banco de dados SQL do Azure, servidor ou pool elástico.

Nome Tipo Description
actionInitiatedBy

RecommendedActionInitiatedBy

Obtém quem iniciou a execução dessa ação recomendada. 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 ação recomendada está ativa e nenhuma ação foi tomada ainda. Pendente –> a ação recomendada é aprovada para e está aguardando a execução. Execução –> a ação recomendada está sendo aplicada no banco de dados do usuário. Verificação –> a ação recomendada foi aplicada e está sendo verificada de sua utilidade pelo sistema. Êxito –> a ação recomendada foi aplicada e a melhoria encontrada durante a verificação. Reverter pendente –> a verificação encontrou pouca ou nenhuma melhoria, portanto, a ação recomendada é enfileirada para reverter ou o usuário foi revertido manualmente. Revertendo –> as 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 –> o usuário ignorou/descartou explicitamente a ação recomendada.
lastModified

string

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