Server Automatic Tuning - Update

Aktualisieren Sie die Optionen für die automatische Optimierung auf dem Server.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/automaticTuning/current?api-version=2021-02-01-preview

URI-Parameter

Name In Required Type Description
resourceGroupName
path True
  • string

Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

serverName
path True
  • string

Der Name des Servers.

subscriptionId
path True
  • string

Abonnement-ID für ein Azure-Abonnement.

api-version
query True
  • string

API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name Type Description
properties.desiredState

Automatischer Optimierungszustand.

properties.options

Definition der Automatischen Optimierungsoptionen.

Antworten

Name Type Description
200 OK

Die Optionen für die automatische Optimierung auf Serverebene wurden erfolgreich aktualisiert.

Other Status Codes

Fehlerantworten:

  • 400 FeatureDisabledOnSelectedEdition: Der Benutzer hat versucht, ein Feature zu verwenden, das für die aktuelle Datenbankedition deaktiviert ist.

  • 400 InvalidIdentifier: Der Bezeichner enthält NULL oder ein ungültiges Unicode-Zeichen.

  • 400 InvalidAutomaticTuningUpsertRequest: Der Anforderungsteil für die automatische Optimierung des Updates ist nicht vorhanden oder verfügt über kein Eigenschaftenobjekt.

  • 400 InvalidExecuteStatus : Der angegebene Status der automatischen Ausführung für den Ratgeber ist nicht zulässig.

  • 404 DatabaseDoesNotExist: Die angeforderte Datenbank wurde nicht gefunden.

  • 404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden.

  • 404 SubscriptionDoesNotHaveElasticPool: Der angeforderte Pool für elastische Datenbanken wurde nicht gefunden.

  • 404 OperationIdNotFound: Der Vorgang mit der ID ist nicht vorhanden.

  • 404 AutomaticTuningOptionNotFound: Die angeforderte Automatische Optimierungsoption wurde nicht gefunden.

  • 405 Nicht unterstützt: Diese Funktion wird nicht unterstützt.

  • 409-Konflikt: Die Anforderung konnte aufgrund eines Konflikts in der Anforderung nicht verarbeitet werden.

  • 409 OperationCancelled: Der Vorgang wurde vom Benutzer abgebrochen.

  • 409 Vorgang unterbrochen: Der Vorgang für die Ressource konnte nicht abgeschlossen werden, da er von einem anderen Vorgang für dieselbe Ressource unterbrochen wurde.

  • 409 DefaultStateStateNotAllowedInCustomServerMode – DEFAULT Advisor-Status im BENUTZERDEFINIERTEN Modus nicht zulässig

  • 409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress: Die Einstellungen für die automatische Optimierung aus der vorherigen Anforderung wurden nicht an alle Benutzerdatenbanken propagiert.

  • 500 OperationTimedOut: Für den Vorgang ist ein Timeout und automatisch ein Rollback erfolgt. Wiederholen Sie den Vorgang.

  • 503 ServiceTemporarilyUnavailable: Feature vorübergehend nicht verfügbar.

Beispiele

Updates server automatic tuning settings with all properties
Updates server automatic tuning settings with minimal properties

Updates server automatic tuning settings with all properties

Sample Request

PATCH https://management.azure.com/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/automaticTuning/current?api-version=2021-02-01-preview
{
  "properties": {
    "desiredState": "Auto",
    "options": {
      "createIndex": {
        "desiredState": "Off"
      },
      "dropIndex": {
        "desiredState": "On"
      },
      "forceLastGoodPlan": {
        "desiredState": "Default"
      }
    }
  }
}

Sample Response

{
  "id": "/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/automaticTuning/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/automaticTuning",
  "properties": {
    "desiredState": "Auto",
    "actualState": "Auto",
    "options": {
      "createIndex": {
        "desiredState": "Off",
        "actualState": "Off"
      },
      "dropIndex": {
        "desiredState": "On",
        "actualState": "On"
      },
      "forceLastGoodPlan": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "maintainIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      }
    }
  }
}

Updates server automatic tuning settings with minimal properties

Sample Request

PATCH https://management.azure.com/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/automaticTuning/current?api-version=2021-02-01-preview
{
  "properties": {
    "desiredState": "Auto"
  }
}

Sample Response

{
  "id": "/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/automaticTuning/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/automaticTuning",
  "properties": {
    "desiredState": "Auto",
    "actualState": "Auto",
    "options": {
      "createIndex": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "dropIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "forceLastGoodPlan": {
        "desiredState": "Default",
        "actualState": "On",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      },
      "maintainIndex": {
        "desiredState": "Default",
        "actualState": "Off",
        "reasonCode": 2,
        "reasonDesc": "AutoConfigured"
      }
    }
  }
}

Definitionen

AutomaticTuningOptionModeActual

Status der automatischen Optimierungsoption.

AutomaticTuningOptionModeDesired

Gewünschter Status der automatischen Optimierungsoption.

AutomaticTuningServerMode

Automatischer Optimierungszustand.

AutomaticTuningServerOptions

Eigenschaften der automatischen Optimierung für einzelne Ratgeber.

AutomaticTuningServerReason

Beschreibung des Grunds, falls gewünscht und tatsächlicher Zustand unterschiedlich.

ServerAutomaticTuning

Automatische Optimierung auf Serverebene.

AutomaticTuningOptionModeActual

Status der automatischen Optimierungsoption.

Name Type Description
Off
  • string
On
  • string

AutomaticTuningOptionModeDesired

Gewünschter Status der automatischen Optimierungsoption.

Name Type Description
Default
  • string
Off
  • string
On
  • string

AutomaticTuningServerMode

Automatischer Optimierungszustand.

Name Type Description
Auto
  • string
Custom
  • string
Unspecified
  • string

AutomaticTuningServerOptions

Eigenschaften der automatischen Optimierung für einzelne Ratgeber.

Name Type Description
actualState

Status der automatischen Optimierungsoption.

desiredState

Gewünschter Status der automatischen Optimierungsoption.

reasonCode
  • integer

Der Grundcode bei Bedarf und der tatsächliche Zustand unterscheiden sich.

reasonDesc

Beschreibung des Grunds, falls gewünscht und tatsächlicher Zustand unterschiedlich.

AutomaticTuningServerReason

Beschreibung des Grunds, falls gewünscht und tatsächlicher Zustand unterschiedlich.

Name Type Description
AutoConfigured
  • string
Default
  • string
Disabled
  • string

ServerAutomaticTuning

Automatische Optimierung auf Serverebene.

Name Type Description
id
  • string

Ressourcen-ID

name
  • string

Name der Ressource.

properties.actualState

Automatische Optimierung des tatsächlichen Zustands.

properties.desiredState

Automatischer Optimierungszustand.

properties.options

Definition der Automatischen Optimierungsoptionen.

type
  • string

Der Ressourcentyp.