Server Automatic Tuning - Update

Referentie

Service:: SQL Database

API Version:: 2021-11-01

Opties voor automatisch afstemmen op de server bijwerken.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.

Aanvraagbody

Name	Type	Description
properties.desiredState	AutomaticTuningServerMode	Automatische afstemming van de gewenste status.
properties.options	<string, AutomaticTuningServerOptions>	Definitie van opties voor automatisch afstemmen.

Antwoorden

Name	Type	Description
200 OK	ServerAutomaticTuning	De opties voor automatisch afstemmen op serverniveau zijn bijgewerkt.
Other Status Codes		Foutreacties: *** 400 FeatureDisabledOnSelectedEdition - Gebruiker heeft geprobeerd een functie te gebruiken die is uitgeschakeld in de huidige database-editie. 400 InvalidIdentifier: de id bevat NULL of een ongeldig Unicode-teken. 400 InvalidAutomaticTuningUpsertRequest - De aanvraagtekst voor automatisch afstemmen van updates bestaat niet of heeft geen eigenschappenobject. 400 InvalidAdvisorAutoExecuteStatus - Opgegeven status voor automatisch uitvoeren voor de advisor is niet toegestaan. 404 DatabaseDoesNotExist - De aangevraagde database is niet gevonden 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden 404 SubscriptionDoesNotHaveElasticPool - De aangevraagde elastische pool is niet gevonden 404 OperationIdNotFound - De bewerking met id bestaat niet. 404 AutomaticTuningOptionNotFound - De aangevraagde optie voor automatisch afstemmen is niet gevonden. 405 Niet ondersteund : deze functionaliteit wordt niet ondersteund. 409 Conflict - Aanvraag kan niet worden verwerkt vanwege een conflict in de aanvraag. 409 OperationCancelled : de bewerking is geannuleerd door de gebruiker. 409 Bewerking onderbroken: de bewerking op de resource kan niet worden voltooid omdat deze is onderbroken door een andere bewerking op dezelfde resource. 409 DefaultAdvisorStateNotAllowedInCustomServerMode - DEFAULT advisor-status niet toegestaan in aangepaste modus 409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress - Instellingen voor automatisch afstemmen van de vorige aanvraag zijn niet doorgegeven aan alle gebruikersdatabases. 429 SubscriptionTooManyCreateUpdateRequests - Aanvragen die verder gaan dan het maximumaantal aanvragen dat kan worden verwerkt door beschikbare resources. 429 SubscriptionTooManyRequests : aanvragen die verder gaan dan het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources. 500 OperationTimedOut: er is een time-out opgetreden voor de bewerking en deze is automatisch teruggedraaid. Probeer de bewerking opnieuw uit te voeren. 503 ServiceTemporarilyUnavailable - Functie tijdelijk niet beschikbaar. 503 TooManyRequests : aanvragen die verder gaan dan het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources.

Name

Type

Description

200 OK

ServerAutomaticTuning

De opties voor automatisch afstemmen op serverniveau zijn bijgewerkt.

Other Status Codes

Foutreacties: ***

400 FeatureDisabledOnSelectedEdition - Gebruiker heeft geprobeerd een functie te gebruiken die is uitgeschakeld in de huidige database-editie.
400 InvalidIdentifier: de id bevat NULL of een ongeldig Unicode-teken.
400 InvalidAutomaticTuningUpsertRequest - De aanvraagtekst voor automatisch afstemmen van updates bestaat niet of heeft geen eigenschappenobject.
400 InvalidAdvisorAutoExecuteStatus - Opgegeven status voor automatisch uitvoeren voor de advisor is niet toegestaan.
404 DatabaseDoesNotExist - De aangevraagde database is niet gevonden
404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden
404 SubscriptionDoesNotHaveElasticPool - De aangevraagde elastische pool is niet gevonden
404 OperationIdNotFound - De bewerking met id bestaat niet.
404 AutomaticTuningOptionNotFound - De aangevraagde optie voor automatisch afstemmen is niet gevonden.
405 Niet ondersteund : deze functionaliteit wordt niet ondersteund.
409 Conflict - Aanvraag kan niet worden verwerkt vanwege een conflict in de aanvraag.
409 OperationCancelled : de bewerking is geannuleerd door de gebruiker.
409 Bewerking onderbroken: de bewerking op de resource kan niet worden voltooid omdat deze is onderbroken door een andere bewerking op dezelfde resource.
409 DefaultAdvisorStateNotAllowedInCustomServerMode - DEFAULT advisor-status niet toegestaan in aangepaste modus
409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress - Instellingen voor automatisch afstemmen van de vorige aanvraag zijn niet doorgegeven aan alle gebruikersdatabases.
429 SubscriptionTooManyCreateUpdateRequests - Aanvragen die verder gaan dan het maximumaantal aanvragen dat kan worden verwerkt door beschikbare resources.
429 SubscriptionTooManyRequests : aanvragen die verder gaan dan het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources.
500 OperationTimedOut: er is een time-out opgetreden voor de bewerking en deze is automatisch teruggedraaid. Probeer de bewerking opnieuw uit te voeren.
503 ServiceTemporarilyUnavailable - Functie tijdelijk niet beschikbaar.
503 TooManyRequests : aanvragen die verder gaan dan het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources.

Voorbeelden

Updates server automatic tuning settings with all properties

Updates server automatic tuning settings with minimal properties

Updates server automatic tuning settings with all properties

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

{
  "properties": {
    "desiredState": "Auto",
    "options": {
      "createIndex": {
        "desiredState": "Off"
      },
      "dropIndex": {
        "desiredState": "On"
      },
      "forceLastGoodPlan": {
        "desiredState": "Default"
      }
    }
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerAutomaticTuningInner;
import com.azure.resourcemanager.sql.models.AutomaticTuningOptionModeDesired;
import com.azure.resourcemanager.sql.models.AutomaticTuningServerMode;
import com.azure.resourcemanager.sql.models.AutomaticTuningServerOptions;
import java.util.HashMap;
import java.util.Map;

/** Samples for ServerAutomaticTuning Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerAutomaticTuningUpdateMax.json
     */
    /**
     * Sample code: Updates server automatic tuning settings with all properties.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updatesServerAutomaticTuningSettingsWithAllProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerAutomaticTunings().updateWithResponse(
            "default-sql-onebox", "testsvr11",
            new ServerAutomaticTuningInner().withDesiredState(AutomaticTuningServerMode.AUTO)
                .withOptions(mapOf("createIndex",
                    new AutomaticTuningServerOptions().withDesiredState(AutomaticTuningOptionModeDesired.OFF),
                    "dropIndex",
                    new AutomaticTuningServerOptions().withDesiredState(AutomaticTuningOptionModeDesired.ON),
                    "forceLastGoodPlan",
                    new AutomaticTuningServerOptions().withDesiredState(AutomaticTuningOptionModeDesired.DEFAULT))),
            Context.NONE);
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

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

HTTP
Java

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

{
  "properties": {
    "desiredState": "Auto"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerAutomaticTuningInner;
import com.azure.resourcemanager.sql.models.AutomaticTuningServerMode;
import java.util.HashMap;
import java.util.Map;

/** Samples for ServerAutomaticTuning Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerAutomaticTuningUpdateMin.json
     */
    /**
     * Sample code: Updates server automatic tuning settings with minimal properties.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updatesServerAutomaticTuningSettingsWithMinimalProperties(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerAutomaticTunings().updateWithResponse(
            "default-sql-onebox", "testsvr11",
            new ServerAutomaticTuningInner().withDesiredState(AutomaticTuningServerMode.AUTO), Context.NONE);
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

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

Definities

Name	Description
AutomaticTuningOptionModeActual	Automatische afstemmingsoptie werkelijke status.
AutomaticTuningOptionModeDesired	Gewenste status van optie voor automatisch afstemmen.
AutomaticTuningServerMode	Automatische afstemming van de gewenste status.
AutomaticTuningServerOptions	Automatische afstemming van eigenschappen voor individuele adviseurs.
AutomaticTuningServerReason	De beschrijving van de reden, indien gewenst, en de werkelijke status verschillen.
ServerAutomaticTuning	Automatisch afstemmen op serverniveau.

AutomaticTuningOptionModeActual

Automatische afstemmingsoptie werkelijke status.

Name	Type	Description
Off	string
On	string

AutomaticTuningOptionModeDesired

Gewenste status van optie voor automatisch afstemmen.

Name	Type	Description
Default	string
Off	string
On	string

AutomaticTuningServerMode

Automatische afstemming van de gewenste status.

Name	Type	Description
Auto	string
Custom	string
Unspecified	string

AutomaticTuningServerOptions

Automatische afstemming van eigenschappen voor individuele adviseurs.

Name	Type	Description
actualState	AutomaticTuningOptionModeActual	Automatische afstemmingsoptie werkelijke status.
desiredState	AutomaticTuningOptionModeDesired	Gewenste status van optie voor automatisch afstemmen.
reasonCode	integer	De redencode, indien gewenst, en de werkelijke status verschillen.
reasonDesc	AutomaticTuningServerReason	De beschrijving van de reden, indien gewenst, en de werkelijke status verschillen.

AutomaticTuningServerReason

De beschrijving van de reden, indien gewenst, en de werkelijke status verschillen.

Name	Type	Description
AutoConfigured	string
Default	string
Disabled	string