Server Automatic Tuning - Update

Tjänst:

SQL Database

API-version:

2021-11-01

Uppdatera alternativen för automatisk justering på servern.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string	Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.

Begärandetext

Name	Typ	Description
properties.desiredState	AutomaticTuningServerMode	Önskat tillstånd för automatisk justering.
properties.options	<string,  AutomaticTuningServerOptions>	Definition av alternativ för automatisk justering.

Svar

Name	Typ	Description
200 OK	ServerAutomaticTuning	Uppdaterade alternativen för automatisk justering på servernivå.
Other Status Codes		Felsvar: *** 400 FeatureDisabledOnSelectedEdition – Användaren försökte använda en funktion som är inaktiverad i den aktuella databasutgåvan. 400 InvalidIdentifier – identifieraren innehåller NULL eller ett ogiltigt unicode-tecken. 400 InvalidAutomaticTuningUpsertRequest – Begärandetexten för automatisk justering av uppdateringar finns inte eller har inget egenskapsobjekt. 400 InvalidAdvisorAutoExecuteStatus – Angiven status för automatisk körning för rådgivaren tillåts inte. 404 DatabaseDoesNotExist – Den begärda databasen hittades inte 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte 404 SubscriptionDoesNotHaveElasticPool – Den begärda elastiska poolen hittades inte 404 OperationIdNotFound – åtgärden med ID finns inte. 404 AutomaticTuningOptionNotFound – Det begärda alternativet för automatisk justering hittades inte. 405 NotSupported – den här funktionen stöds inte. 409 Konflikt – Begäran kunde inte bearbetas på grund av en konflikt i begäran. 409 OperationCancelled – Åtgärden har avbrutits av användaren. 409 OperationInterrupted – Det gick inte att slutföra åtgärden på resursen eftersom den avbröts av en annan åtgärd på samma resurs. 409 DefaultAdvisorStateNotAllowedInCustomServerMode – STANDARDkontrolltillstånd tillåts inte i ANPASSAT läge 409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress – Inställningar för automatisk justering från tidigare begäran har inte spridits till alla användardatabaser. 429 SubscriptionTooManyCreateUpdateRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 429 SubscriptionTooManyRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 500 OperationTimedOut – Tidsgränsen för åtgärden uppnåddes och återställdes automatiskt. Försök att utföra åtgärden igen. 503 ServiceTemporarilyUnavailable – Funktionen är inte tillgänglig för tillfället. 503 TooManyRequests – begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Exempel

Updates server automatic tuning settings with all properties

Updates server automatic tuning settings with minimal properties

Updates server automatic tuning settings with all properties

Exempelbegäran

HTTP

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

Java

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))),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @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

Exempelsvar

Statuskod:

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

Exempelbegäran

HTTP

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

Java

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),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
AutomaticTuningOptionModeActual	Det faktiska tillståndet för alternativet automatisk justering.
AutomaticTuningOptionModeDesired	Önskat tillstånd för alternativ för automatisk justering.
AutomaticTuningServerMode	Önskat tillstånd för automatisk justering.
AutomaticTuningServerOptions	Egenskaper för automatisk justering för enskilda rådgivare.
AutomaticTuningServerReason	Orsaksbeskrivning om önskat och faktiskt tillstånd skiljer sig.
ServerAutomaticTuning	Automatisk justering på servernivå.

AutomaticTuningOptionModeActual

Det faktiska tillståndet för alternativet automatisk justering.

Name	Typ	Description
Off	string
On	string

AutomaticTuningOptionModeDesired

Önskat tillstånd för alternativ för automatisk justering.

Name	Typ	Description
Default	string
Off	string
On	string

AutomaticTuningServerMode

Önskat tillstånd för automatisk justering.

Name	Typ	Description
Auto	string
Custom	string
Unspecified	string

AutomaticTuningServerOptions

Egenskaper för automatisk justering för enskilda rådgivare.

Name	Typ	Description
actualState	AutomaticTuningOptionModeActual	Det faktiska tillståndet för alternativet automatisk justering.
desiredState	AutomaticTuningOptionModeDesired	Önskat tillstånd för alternativ för automatisk justering.
reasonCode	integer	Orsakskoden om önskat och faktiskt tillstånd skiljer sig.
reasonDesc	AutomaticTuningServerReason	Orsaksbeskrivning om önskat och faktiskt tillstånd skiljer sig.

AutomaticTuningServerReason

Orsaksbeskrivning om önskat och faktiskt tillstånd skiljer sig.

Name	Typ	Description
AutoConfigured	string
Default	string
Disabled	string

ServerAutomaticTuning

Automatisk justering på servernivå.

Name	Typ	Description
id	string	Resurs-ID.
name	string	Resursnamn.
properties.actualState	AutomaticTuningServerMode	Automatisk justering av det faktiska tillståndet.
properties.desiredState	AutomaticTuningServerMode	Önskat tillstånd för automatisk justering.
properties.options	<string,  AutomaticTuningServerOptions>	Definition av alternativ för automatisk justering.
type	string	Resurstyp.