Condividi tramite


Database Recommended Actions - Update

Aggiornamenti un'azione consigliata per il database.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
advisorName
path True

string

Nome di Database Advisor.

databaseName
path True

string

Nome del database.

recommendedActionName
path True

string

Nome dell'azione consigliata del database.

resourceGroupName
path True

string

Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.

serverName
path True

string

Nome del server.

subscriptionId
path True

string

ID sottoscrizione che identifica una sottoscrizione di Azure.

api-version
query True

string

Versione dell'API da usare per la richiesta.

Corpo della richiesta

Nome Necessario Tipo Descrizione
properties.state True

RecommendedActionStateInfo

Ottiene le informazioni dello stato corrente in cui si trova l'azione consigliata.

Risposte

Nome Tipo Descrizione
200 OK

RecommendedAction

Aggiornamento corretto dell'azione consigliata del database specificato.

Other Status Codes

Risposte agli errori: **

  • 400 FeatureDisabledOnSelectedEdition - Utente ha tentato di usare una funzionalità disabilitata nell'edizione del database corrente.

  • 400 InvalidIdentifier: l'identificatore contiene NULL o un carattere unicode non valido.

  • 400 InvalidRecommendedActionUpsertRequest: il corpo della richiesta di azione consigliata di aggiornamento non esiste o non ha proprietà o oggetto state.

  • 400 InvalidRecommendedActionState - Lo stato specificato per l'azione consigliata non è valido

  • 404 DatabaseDoesNotExist - Il database richiesto non è stato trovato

  • 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato

  • 404 SubscriptionDoesNotHaveElasticPool - Il pool elastico richiesto non è stato trovato

  • 404 AdvisorNotFound - Il consulente richiesto non è stato trovato.

  • 404 RecommendedActionNotFound : l'azione consigliata richiesta non è stata trovata.

  • 404 AdvisorNotFound - Il consulente richiesto non è stato trovato.

  • 404 RecommendedActionNotFound : l'azione consigliata richiesta non è stata trovata.

  • 405 NotSupported : questa funzionalità non è supportata.

  • 409 Conflitto - Impossibile elaborare la richiesta a causa del conflitto nella richiesta.

  • 503 ServiceTemporarilyUnavailable - Funzionalità temporaneamente non disponibile.

Esempio

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
ImplementationMethod

Ottiene il metodo in cui è possibile implementare manualmente questa azione consigliata. Ad esempio, TSql, AzurePowerShell.

IsRetryable

Ottiene se l'errore potrebbe essere ignorato e l'azione consigliata potrebbe essere riprovata. I valori possibili sono: Sì/No

RecommendedAction

Azione consigliata database, server o pool elastico.

RecommendedActionCurrentState

Lo stato corrente in cui si trova l'azione consigliata. Alcuni stati comunemente usati sono: l'azione attiva-> consigliata è attiva e non è ancora stata eseguita alcuna azione. In sospeso:> l'azione consigliata è approvata per ed è in attesa dell'esecuzione. Esecuzione:> l'azione consigliata viene applicata nel database utente. Verifica:> l'azione consigliata è stata applicata e viene verificata la relativa utilità dal sistema. Esito positivo:> l'azione consigliata è stata applicata e migliorata durante la verifica. Ripristino in sospeso:> la verifica ha trovato un minimo o nessun miglioramento in modo che l'azione consigliata venga accodata per ripristinare o che l'utente abbia ripristinato manualmente. Ripristino:> le modifiche apportate durante l'applicazione dell'azione consigliata vengono ripristinate nel database utente. Ripristinato:> è stato ripristinato correttamente le modifiche apportate dall'azione consigliata nel database utente. Ignorato:> l'utente ha ignorato/ignorato in modo esplicito l'azione consigliata.

RecommendedActionErrorInfo

Contiene informazioni sugli errori per un'azione consigliata Azure SQL database, server o pool elastico.

RecommendedActionImpactRecord

Contiene informazioni sull'impatto stimato o osservato su varie metriche per un'azione consigliata per un database, Azure SQL un server o un pool elastico.

RecommendedActionImplementationInfo

Contiene informazioni per l'implementazione manuale per un'azione consigliata Azure SQL database, server o pool elastico.

RecommendedActionInitiatedBy

Ottiene chi ha avviato l'esecuzione di questa azione consigliata. Il valore possibile è: utente -> Quando il sistema di notifica esplicito dell'utente deve applicare l'azione consigliata. Sistema:> quando lo stato di esecuzione automatica di questo advisor è stato impostato su "Abilitato", nel qual caso il sistema l'ha applicata.

RecommendedActionMetricInfo

Contiene serie temporali di diverse metriche interessate per un'azione consigliata di database, server o pool elastici Azure SQL.

RecommendedActionStateInfo

Contiene informazioni sullo stato corrente per un'azione consigliata Azure SQL database, server o pool elastico.

ImplementationMethod

Ottiene il metodo in cui è possibile implementare manualmente questa azione consigliata. Ad esempio, TSql, AzurePowerShell.

Nome Tipo Descrizione
AzurePowerShell

string

TSql

string

IsRetryable

Ottiene se l'errore potrebbe essere ignorato e l'azione consigliata potrebbe essere riprovata. I valori possibili sono: Sì/No

Nome Tipo Descrizione
No

string

Yes

string

RecommendedAction

Azione consigliata database, server o pool elastico.

Nome Tipo Descrizione
id

string

ID risorsa.

kind

string

Tipo di risorsa.

location

string

Percorso della risorsa.

name

string

Nome risorsa.

properties.details

object

Ottiene dettagli aggiuntivi specifici di questa azione consigliata.

properties.errorDetails

RecommendedActionErrorInfo

Ottiene i dettagli dell'errore se e perché questa azione consigliata viene inserita nello stato di errore.

properties.estimatedImpact

RecommendedActionImpactRecord[]

Ottiene le informazioni di impatto stimate per questa azione consigliata, ad esempio, aumento stimato della CPU, modifica dello spazio su disco stimato

properties.executeActionDuration

string

Ottiene il tempo necessario per applicare questa azione consigliata nella risorsa utente. Ad esempio, tempo impiegato per la creazione dell'indice

properties.executeActionInitiatedBy

RecommendedActionInitiatedBy

Ottiene se l'approvazione per l'applicazione di questa azione consigliata è stata fornita dall'utente/sistema.

properties.executeActionInitiatedTime

string

Ottiene l'ora in cui questa azione consigliata è stata approvata per l'esecuzione.

properties.executeActionStartTime

string

Ottiene l'ora in cui il sistema ha avviato l'applicazione di questa azione consigliata nella risorsa utente. Ad esempio, ora di inizio della creazione dell'indice

properties.implementationDetails

RecommendedActionImplementationInfo

Ottiene i dettagli dell'implementazione di questa azione consigliata per l'applicazione manuale dell'utente.

properties.isArchivedAction

boolean

Ottiene se questa azione consigliata è stata suggerita qualche tempo fa, ma l'utente ha scelto di ignorare questo e il sistema ha aggiunto di nuovo una nuova azione consigliata.

properties.isExecutableAction

boolean

Ottiene se questa azione consigliata è utilizzabile dall'utente

properties.isRevertableAction

boolean

Ottiene se le modifiche applicate da questa azione consigliata possono essere ripristinate dall'utente

properties.lastRefresh

string

Ottiene l'ora dell'ultimo aggiornamento dell'azione consigliata.

properties.linkedObjects

string[]

Ottiene gli oggetti collegati, se presenti.

properties.observedImpact

RecommendedActionImpactRecord[]

Ottiene le informazioni sull'impatto osservato/effettivo per questa azione consigliata, ad esempio il guadagno effettivo della CPU, la modifica dello spazio su disco effettivo

properties.recommendationReason

string

Ottiene il motivo per la raccomandazione di questa azione. Ad esempio, DuplicateIndex

properties.revertActionDuration

string

Ottiene il tempo necessario per ripristinare le modifiche di questa azione consigliata nella risorsa utente. Ad esempio, tempo impiegato per eliminare l'indice creato.

properties.revertActionInitiatedBy

RecommendedActionInitiatedBy

Ottiene se l'approvazione per ripristinare questa azione consigliata è stata fornita dall'utente/sistema.

properties.revertActionInitiatedTime

string

Ottiene l'ora in cui questa azione consigliata è stata approvata per il ripristino.

properties.revertActionStartTime

string

Ottiene l'ora in cui il sistema ha iniziato a ripristinare le modifiche di questa azione consigliata nella risorsa utente. Ad esempio, ora in cui viene eseguita l'eliminazione dell'indice.

properties.score

integer

Ottiene l'impatto di questa azione consigliata. I valori possibili sono 1 - Impatto basso, 2 - Impatto medio e 3 - Impatto elevato

properties.state

RecommendedActionStateInfo

Ottiene le informazioni dello stato corrente in cui si trova l'azione consigliata.

properties.timeSeries

RecommendedActionMetricInfo[]

Ottiene le informazioni sulle serie temporali delle metriche per questa azione consigliata, ad esempio, serie di tempo di utilizzo della CPU

properties.validSince

string

Ottiene il tempo da quando questa azione consigliata è valida.

type

string

Tipo di risorsa.

RecommendedActionCurrentState

Lo stato corrente in cui si trova l'azione consigliata. Alcuni stati comunemente usati sono: l'azione attiva-> consigliata è attiva e non è ancora stata eseguita alcuna azione. In sospeso:> l'azione consigliata è approvata per ed è in attesa dell'esecuzione. Esecuzione:> l'azione consigliata viene applicata nel database utente. Verifica:> l'azione consigliata è stata applicata e viene verificata la relativa utilità dal sistema. Esito positivo:> l'azione consigliata è stata applicata e migliorata durante la verifica. Ripristino in sospeso:> la verifica ha trovato un minimo o nessun miglioramento in modo che l'azione consigliata venga accodata per ripristinare o che l'utente abbia ripristinato manualmente. Ripristino:> le modifiche apportate durante l'applicazione dell'azione consigliata vengono ripristinate nel database utente. Ripristinato:> è stato ripristinato correttamente le modifiche apportate dall'azione consigliata nel database utente. Ignorato:> l'utente ha ignorato/ignorato in modo esplicito l'azione consigliata.

Nome Tipo Descrizione
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

Contiene informazioni sugli errori per un'azione consigliata Azure SQL database, server o pool elastico.

Nome Tipo Descrizione
errorCode

string

Ottiene il motivo per cui l'azione consigliata è stata inserita nello stato di errore. Ad esempio, DatabaseHasQdsOff, IndexAlreadyExists

isRetryable

IsRetryable

Ottiene se l'errore potrebbe essere ignorato e l'azione consigliata potrebbe essere riprovata. I valori possibili sono: Sì/No

RecommendedActionImpactRecord

Contiene informazioni sull'impatto stimato o osservato su varie metriche per un'azione consigliata per un database, Azure SQL un server o un pool elastico.

Nome Tipo Descrizione
absoluteValue

number

Ottiene il valore assoluto di questa dimensione, se applicabile. Ad esempio, numero di query interessate

changeValueAbsolute

number

Ottiene la modifica assoluta del valore di questa dimensione. Ad esempio, la modifica dello spazio su disco assoluto in Megabyte

changeValueRelative

number

Ottiene la modifica relativa nel valore di questa dimensione. Ad esempio, la modifica dello spazio su disco relativo in Percentuale

dimensionName

string

Ottiene il nome della dimensione di impatto. Ad esempio, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

unit

string

Ottiene il nome della dimensione di impatto. Ad esempio, CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Contiene informazioni per l'implementazione manuale per un'azione consigliata Azure SQL database, server o pool elastico.

Nome Tipo Descrizione
method

ImplementationMethod

Ottiene il metodo in cui è possibile implementare manualmente questa azione consigliata. Ad esempio, TSql, AzurePowerShell.

script

string

Ottiene lo script di implementazione manuale. Ad esempio, script T-SQL che possono essere eseguiti nel database.

RecommendedActionInitiatedBy

Ottiene chi ha avviato l'esecuzione di questa azione consigliata. Il valore possibile è: utente -> Quando il sistema di notifica esplicito dell'utente deve applicare l'azione consigliata. Sistema:> quando lo stato di esecuzione automatica di questo advisor è stato impostato su "Abilitato", nel qual caso il sistema l'ha applicata.

Nome Tipo Descrizione
System

string

User

string

RecommendedActionMetricInfo

Contiene serie temporali di diverse metriche interessate per un'azione consigliata di database, server o pool elastici Azure SQL.

Nome Tipo Descrizione
metricName

string

Ottiene il nome della metrica. Ad esempio, CPU, Numero di query.

startTime

string

Ottiene l'ora di inizio dell'intervallo di tempo specificato da metricInfo.

timeGrain

string

Ottiene la durata dell'intervallo di tempo per il valore specificato da metricInfo. ad esempio PT1H (1 ora)

unit

string

Ottiene l'unità in cui viene misurata la metrica. Ad esempio, DTU, Frequenza

value

number

Ottiene il valore della metrica nell'intervallo di tempo specificato da MetricInfo.

RecommendedActionStateInfo

Contiene informazioni sullo stato corrente per un'azione consigliata Azure SQL database, server o pool elastico.

Nome Tipo Descrizione
actionInitiatedBy

RecommendedActionInitiatedBy

Ottiene chi ha avviato l'esecuzione di questa azione consigliata. Il valore possibile è: utente -> Quando il sistema di notifica esplicito dell'utente deve applicare l'azione consigliata. Sistema:> quando lo stato di esecuzione automatica di questo advisor è stato impostato su "Abilitato", nel qual caso il sistema l'ha applicata.

currentValue

RecommendedActionCurrentState

Lo stato corrente in cui si trova l'azione consigliata. Alcuni stati comunemente usati sono: l'azione attiva-> consigliata è attiva e non è ancora stata eseguita alcuna azione. In sospeso:> l'azione consigliata è approvata per ed è in attesa dell'esecuzione. Esecuzione:> l'azione consigliata viene applicata nel database utente. Verifica:> l'azione consigliata è stata applicata e viene verificata la relativa utilità dal sistema. Esito positivo:> l'azione consigliata è stata applicata e migliorata durante la verifica. Ripristino in sospeso:> la verifica ha trovato un minimo o nessun miglioramento in modo che l'azione consigliata venga accodata per ripristinare o che l'utente abbia ripristinato manualmente. Ripristino:> le modifiche apportate durante l'applicazione dell'azione consigliata vengono ripristinate nel database utente. Ripristinato:> è stato ripristinato correttamente le modifiche apportate dall'azione consigliata nel database utente. Ignorato:> l'utente ha ignorato/ignorato in modo esplicito l'azione consigliata.

lastModified

string

Ottiene l'ora dell'ultima modifica dello stato