Database Recommended Actions - Get

Ruft eine empfohlene Datenbankaktion ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
advisorName
path True

string

Der Name des Datenbankratgebers.

databaseName
path True

string

Der Name der Datenbank.

recommendedActionName
path True

string

Der Name der empfohlenen Datenbankaktion.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serverName
path True

string

Name des Servers

subscriptionId
path True

string (uuid)

Die ID des Zielabonnements. Der Wert muss eine UUID sein.

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

RecommendedAction

Azure-Operation erfolgreich abgeschlossen.

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
createdByType

Der Identitätstyp, der die Ressource erstellt hat.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

ImplementationMethod

Ruft die Methode ab, in der diese empfohlene Aktion manuell implementiert werden kann. z. B. TSql, AzurePowerShell.

IsRetryable

Ruft ab, ob der Fehler ignoriert werden kann und die empfohlene Aktion erneut ausgeführt werden kann. Mögliche Werte sind: Ja/Nein

RecommendedAction

Empfohlene Aktion für Datenbank, Server oder Elastic Pool.

RecommendedActionCurrentState

Aktueller Zustand, in dem die empfohlene Aktion aktiviert ist. Einige häufig verwendete Zustände sind: Aktiv -> empfohlene Aktion aktiv ist und noch keine Aktion ausgeführt wurde. Ausstehend –> empfohlene Aktion wird genehmigt und wartet auf die Ausführung. Ausführen –> empfohlene Aktion wird auf die Benutzerdatenbank angewendet. Überprüfen –> empfohlene Aktion wurde angewendet und wird vom System auf ihre Nützlichkeit überprüft. Erfolg –> empfohlene Aktion wurde während der Überprüfung angewendet und verbessert. Ausstehende Wiederherstellung –> Überprüfung wenig oder keine Verbesserung gefunden hat, sodass die empfohlene Aktion für die Wiederherstellung in die Warteschlange gestellt wird oder der Benutzer manuell zurückgesetzt wurde. Wiederherstellen –> Änderungen, die beim Anwenden empfohlener Aktionen vorgenommen wurden, werden in der Benutzerdatenbank wiederhergestellt. Wiederherstellen :> die änderungen, die von empfohlener Aktion in der Benutzerdatenbank vorgenommen wurden, erfolgreich zurückgesetzt. Ignoriert –> Benutzer die empfohlene Aktion explizit ignoriert/verworfen hat.

RecommendedActionErrorInfo

Enthält Fehlerinformationen für eine empfohlene Aktion der Azure SQL-Datenbank, eines Servers oder eines Elastic Pools.

RecommendedActionImpactRecord

Enthält Informationen über geschätzte oder beobachtete Auswirkungen auf verschiedene Metriken für eine empfohlene Maßnahme für eine Azure SQL-Datenbank, Server oder Elastic Pool.

RecommendedActionImplementationInfo

Enthält Informationen zur manuellen Implementierung einer empfohlenen Maßnahme für eine Azure SQL-Datenbank, Server oder Elastic Pool.

RecommendedActionInitiatedBy

Ruft ab, wenn die Genehmigung für die Anwendung dieser empfohlenen Aktion von Benutzer/System gegeben wurde.

RecommendedActionMetricInfo

Enthält Zeitreihen verschiedener betroffener Metriken für eine empfohlene Aktion der Azure SQL-Datenbank, eines Servers oder eines Elastic Pools.

RecommendedActionStateInfo

Enthält Informationen zum aktuellen Zustand einer empfohlenen Aktion für eine Azure SQL-Datenbank, Server oder Elastic Pool.

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

ImplementationMethod

Ruft die Methode ab, in der diese empfohlene Aktion manuell implementiert werden kann. z. B. TSql, AzurePowerShell.

Wert Beschreibung
TSql

TSql

AzurePowerShell

AzurePowerShell

IsRetryable

Ruft ab, ob der Fehler ignoriert werden kann und die empfohlene Aktion erneut ausgeführt werden kann. Mögliche Werte sind: Ja/Nein

Wert Beschreibung
Yes

Ja

No

No

RecommendedAction

Empfohlene Aktion für Datenbank, Server oder Elastic Pool.

Name Typ Beschreibung
id

string (arm-id)

Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

kind

string

Ressourcentyp.

location

string

Ressourcenspeicherort.

name

string

Der Name der Ressource

properties.details

object

Ruft zusätzliche Details ab, die für diese empfohlene Aktion spezifisch sind.

properties.errorDetails

RecommendedActionErrorInfo

Ruft die Fehlerdetails ab, wenn und warum diese empfohlene Aktion in den Fehlerzustand versetzt wird.

properties.estimatedImpact

RecommendedActionImpactRecord[]

Ruft die geschätzten Auswirkungsinformationen für diese empfohlene Aktion ab, z. B. geschätzte CPU-Verstärkung, Änderung des geschätzten Speicherplatzes

properties.executeActionDuration

string (duration)

Ruft die Zeit für die Anwendung dieser empfohlenen Aktion für die Benutzerressource ab. z. B. Zeitaufwand für die Indexerstellung

properties.executeActionInitiatedBy

RecommendedActionInitiatedBy

Ruft ab, wenn die Genehmigung für die Anwendung dieser empfohlenen Aktion von Benutzer/System gegeben wurde.

properties.executeActionInitiatedTime

string (date-time)

Ruft die Zeit ab, zu der diese empfohlene Aktion für die Ausführung genehmigt wurde.

properties.executeActionStartTime

string (date-time)

Ruft die Zeit ab, zu der das System mit der Anwendung dieser empfohlenen Aktion auf die Benutzerressource begonnen hat. z. B. Startzeit für die Indexerstellung

properties.implementationDetails

RecommendedActionImplementationInfo

Ruft die Implementierungsdetails dieser empfohlenen Aktion ab, damit benutzer sie manuell anwenden können.

properties.isArchivedAction

boolean

Ruft ab, wenn diese empfohlene Aktion vor einiger Zeit vorgeschlagen wurde, aber der Benutzer hat dies ignoriert und das System eine neue empfohlene Aktion erneut hinzugefügt.

properties.isExecutableAction

boolean

Ruft ab, wenn diese empfohlene Aktion vom Benutzer umsetzbar ist.

properties.isRevertableAction

boolean

Ruft ab, wenn Änderungen, die von dieser empfohlenen Aktion angewendet werden, vom Benutzer wiederhergestellt werden können.

properties.lastRefresh

string (date-time)

Ruft die Zeit ab, zu der diese empfohlene Aktion zuletzt aktualisiert wurde.

properties.linkedObjects

string[]

Ruft ggf. die verknüpften Objekte ab.

properties.observedImpact

RecommendedActionImpactRecord[]

Ruft die beobachteten/tatsächlichen Auswirkungsinformationen für diese empfohlene Aktion ab, z. B. Tatsächliche CPU-Verstärkung, Tatsächliche Speicherplatzänderung

properties.recommendationReason

string

Ruft den Grund für die Empfehlung dieser Aktion ab. z.B. DuplicateIndex

properties.revertActionDuration

string (duration)

Ruft die Zeit für die Wiederherstellung von Änderungen dieser empfohlenen Aktion für die Benutzerressource ab. z. B. zeitaufwand für das Ablegen des erstellten Indexes.

properties.revertActionInitiatedBy

RecommendedActionInitiatedBy

Ruft ab, wenn die Genehmigung für die Wiederherstellung dieser empfohlenen Aktion von Benutzer/System gegeben wurde.

properties.revertActionInitiatedTime

string (date-time)

Ruft den Zeitpunkt ab, zu dem diese empfohlene Aktion für die Wiederherstellung genehmigt wurde.

properties.revertActionStartTime

string (date-time)

Ruft den Zeitpunkt ab, zu dem das System mit dem Zurücksetzen von Änderungen dieser empfohlenen Aktion für die Benutzerressource begonnen hat. z. B. Die Uhrzeit, zu der die Indexablage ausgeführt wird.

properties.score

integer (int32)

Ruft die Auswirkungen dieser empfohlenen Aktion ab. Mögliche Werte sind 1 - Niedrige Auswirkungen, 2 - Mittlere Auswirkung und 3 - Hohe Auswirkung

properties.state

RecommendedActionStateInfo

Ruft die Informationen des aktuellen Zustands ab, in dem die empfohlene Aktion enthalten ist.

properties.timeSeries

RecommendedActionMetricInfo[]

Ruft die Zeitreiheninformationen der Metriken für diese empfohlene Aktion ab, z. B. CPU-Verbrauchszeitreihe

properties.validSince

string (date-time)

Ruft den Zeitpunkt ab, zu dem diese empfohlene Aktion gültig ist.

systemData

systemData

Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.

type

string

Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

RecommendedActionCurrentState

Aktueller Zustand, in dem die empfohlene Aktion aktiviert ist. Einige häufig verwendete Zustände sind: Aktiv -> empfohlene Aktion aktiv ist und noch keine Aktion ausgeführt wurde. Ausstehend –> empfohlene Aktion wird genehmigt und wartet auf die Ausführung. Ausführen –> empfohlene Aktion wird auf die Benutzerdatenbank angewendet. Überprüfen –> empfohlene Aktion wurde angewendet und wird vom System auf ihre Nützlichkeit überprüft. Erfolg –> empfohlene Aktion wurde während der Überprüfung angewendet und verbessert. Ausstehende Wiederherstellung –> Überprüfung wenig oder keine Verbesserung gefunden hat, sodass die empfohlene Aktion für die Wiederherstellung in die Warteschlange gestellt wird oder der Benutzer manuell zurückgesetzt wurde. Wiederherstellen –> Änderungen, die beim Anwenden empfohlener Aktionen vorgenommen wurden, werden in der Benutzerdatenbank wiederhergestellt. Wiederherstellen :> die änderungen, die von empfohlener Aktion in der Benutzerdatenbank vorgenommen wurden, erfolgreich zurückgesetzt. Ignoriert –> Benutzer die empfohlene Aktion explizit ignoriert/verworfen hat.

Wert Beschreibung
Active

Aktiv

Pending

Ausstehend

Executing

Wird ausgeführt

Verifying

Verifizierung

PendingRevert

PendingRevert

RevertCancelled

RevertCancelled

Reverting

Rückgängig machen

Reverted

Zurückgesetzt

Ignored

Ignoriert

Expired

Abgelaufen

Monitoring

Überwachung

Resolved

Gelöst

Success

Success

Error

Fehler

RecommendedActionErrorInfo

Enthält Fehlerinformationen für eine empfohlene Aktion der Azure SQL-Datenbank, eines Servers oder eines Elastic Pools.

Name Typ Beschreibung
errorCode

string

Ruft den Grund ab, warum die empfohlene Aktion auf den Fehlerzustand gesetzt wurde. z.B. DatabaseHasQdsOff, IndexAlreadyExists

isRetryable

IsRetryable

Ruft ab, ob der Fehler ignoriert werden kann und die empfohlene Aktion erneut ausgeführt werden kann. Mögliche Werte sind: Ja/Nein

RecommendedActionImpactRecord

Enthält Informationen über geschätzte oder beobachtete Auswirkungen auf verschiedene Metriken für eine empfohlene Maßnahme für eine Azure SQL-Datenbank, Server oder Elastic Pool.

Name Typ Beschreibung
absoluteValue

number (double)

Ruft den absoluten Wert dieser Dimension ab, falls zutreffend. z. B. Anzahl betroffener Abfragen

changeValueAbsolute

number (double)

Ruft die absolute Änderung des Werts dieser Dimension ab. z. B. absoluter Speicherplatzwechsel in Megabyte

changeValueRelative

number (double)

Ruft die relative Änderung des Werts dieser Dimension ab. z. B. Änderung des relativen Speicherplatzes in Prozent

dimensionName

string

Ruft den Namen der Auswirkungsdimension ab. z. B. CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

unit

string

Ruft den Namen der Auswirkungsdimension ab. z. B. CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

RecommendedActionImplementationInfo

Enthält Informationen zur manuellen Implementierung einer empfohlenen Maßnahme für eine Azure SQL-Datenbank, Server oder Elastic Pool.

Name Typ Beschreibung
method

ImplementationMethod

Ruft die Methode ab, in der diese empfohlene Aktion manuell implementiert werden kann. z. B. TSql, AzurePowerShell.

script

string

Ruft das manuelle Implementierungsskript ab. z. B. T-SQL-Skript, das in der Datenbank ausgeführt werden kann.

RecommendedActionInitiatedBy

Ruft ab, wenn die Genehmigung für die Anwendung dieser empfohlenen Aktion von Benutzer/System gegeben wurde.

Wert Beschreibung
User

Benutzer

System

System

RecommendedActionMetricInfo

Enthält Zeitreihen verschiedener betroffener Metriken für eine empfohlene Aktion der Azure SQL-Datenbank, eines Servers oder eines Elastic Pools.

Name Typ Beschreibung
metricName

string

Ruft den Namen der Metrik ab. z. B. CPU, Anzahl der Abfragen.

startTime

string (date-time)

Ruft die Startzeit des Zeitintervalls ab, das von dieser MetricInfo angegeben wird.

timeGrain

string

Ruft die Dauer des Zeitintervalls für den von dieser MetricInfo angegebenen Wert ab. z.B. PT1H (1 Stunde)

unit

string

Ruft die Einheit ab, in der die Metrik gemessen wird. z.B. DTU, Frequenz

value

number (double)

Ruft den Wert der Metrik im von dieser MetricInfo angegebenen Zeitintervall ab.

RecommendedActionStateInfo

Enthält Informationen zum aktuellen Zustand einer empfohlenen Aktion für eine Azure SQL-Datenbank, Server oder Elastic Pool.

Name Typ Beschreibung
actionInitiatedBy

RecommendedActionInitiatedBy

Ruft ab, wer die Ausführung dieser empfohlenen Aktion initiiert hat. Mögliche Werte sind: Benutzer -> Wenn das vom Benutzer explizit benachrichtigte System, um die empfohlene Aktion anzuwenden. System –> Wenn der Status der automatischen Ausführung dieses Beraters auf "Aktiviert" festgelegt wurde, in diesem Fall wurde es vom System angewendet.

currentValue

RecommendedActionCurrentState

Aktueller Zustand, in dem die empfohlene Aktion aktiviert ist. Einige häufig verwendete Zustände sind: Aktiv -> empfohlene Aktion aktiv ist und noch keine Aktion ausgeführt wurde. Ausstehend –> empfohlene Aktion wird genehmigt und wartet auf die Ausführung. Ausführen –> empfohlene Aktion wird auf die Benutzerdatenbank angewendet. Überprüfen –> empfohlene Aktion wurde angewendet und wird vom System auf ihre Nützlichkeit überprüft. Erfolg –> empfohlene Aktion wurde während der Überprüfung angewendet und verbessert. Ausstehende Wiederherstellung –> Überprüfung wenig oder keine Verbesserung gefunden hat, sodass die empfohlene Aktion für die Wiederherstellung in die Warteschlange gestellt wird oder der Benutzer manuell zurückgesetzt wurde. Wiederherstellen –> Änderungen, die beim Anwenden empfohlener Aktionen vorgenommen wurden, werden in der Benutzerdatenbank wiederhergestellt. Wiederherstellen :> die änderungen, die von empfohlener Aktion in der Benutzerdatenbank vorgenommen wurden, erfolgreich zurückgesetzt. Ignoriert –> Benutzer die empfohlene Aktion explizit ignoriert/verworfen hat.

lastModified

string (date-time)

Ruft den Zeitpunkt der letzten Änderung des Zustands ab.

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string (date-time)

Der Zeitstempel der Ressourcenerstellung (UTC).

createdBy

string

Die Identität, die die Ressource erstellt hat.

createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

lastModifiedAt

string (date-time)

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.

lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.