Server Automatic Tuning - Update

Referencia

Service:: SQL Database

API Version:: 2021-11-01

Actualice las opciones de ajuste automático en el servidor.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.desiredState	AutomaticTuningServerMode	Ajuste automático del estado deseado.
properties.options	<string, AutomaticTuningServerOptions>	Definición de opciones de ajuste automático.

Respuestas

Nombre	Tipo	Description
200 OK	ServerAutomaticTuning	Se han actualizado correctamente las opciones de ajuste automático de nivel de servidor.
Other Status Codes		Respuestas de error: *** 400 FeatureDisabledOnSelectedEdition: el usuario intentó usar una característica que está deshabilitada en la edición actual de la base de datos. 400 InvalidIdentifier: el identificador contiene NULL o un carácter unicode no válido. 400 InvalidAutomaticTuningUpsertRequest: el cuerpo de la solicitud de ajuste automático de actualización no existe o no tiene ningún objeto de propiedades. 400 InvalidAdvisorAutoExecuteStatus: no se permite el estado de ejecución automática especificado para el asesor. 404 DatabaseDoesNotExist: no se encontró la base de datos solicitada 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado 404 SubscriptionDoesNotHaveElasticPool: no se encontró el grupo elástico solicitado. 404 OperationIdNotFound: la operación con id. no existe. 404 AutomaticTuningOptionNotFound: no se encontró la opción de ajuste automático solicitada. 405 NotSupported: esta funcionalidad no se admite. 409 Conflicto: no se pudo procesar la solicitud debido a un conflicto en la solicitud. 409 OperationCancelled: el usuario ha cancelado la operación. 409 OperationInterrupted: no se pudo completar la operación en el recurso porque se interrumpió por otra operación en el mismo recurso. 409 DefaultAdvisorStateNotAllowedInCustomServerMode: el estado del asesor DEFAULT no está permitido en modo PERSONALIZADO 409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress: la configuración de ajuste automático de la solicitud anterior no se ha propagado a todas las bases de datos de usuario. 429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 500 OperationTimedOut: la operación agota el tiempo de espera y se revierte automáticamente. Vuelva a intentar la operación y, 503 ServiceTemporarilyUnavailable: característica no disponible temporalmente. 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar.

Nombre

Tipo

Description

200 OK

ServerAutomaticTuning

Se han actualizado correctamente las opciones de ajuste automático de nivel de servidor.

Other Status Codes

Respuestas de error: ***

400 FeatureDisabledOnSelectedEdition: el usuario intentó usar una característica que está deshabilitada en la edición actual de la base de datos.
400 InvalidIdentifier: el identificador contiene NULL o un carácter unicode no válido.
400 InvalidAutomaticTuningUpsertRequest: el cuerpo de la solicitud de ajuste automático de actualización no existe o no tiene ningún objeto de propiedades.
400 InvalidAdvisorAutoExecuteStatus: no se permite el estado de ejecución automática especificado para el asesor.
404 DatabaseDoesNotExist: no se encontró la base de datos solicitada
404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado
404 SubscriptionDoesNotHaveElasticPool: no se encontró el grupo elástico solicitado.
404 OperationIdNotFound: la operación con id. no existe.
404 AutomaticTuningOptionNotFound: no se encontró la opción de ajuste automático solicitada.
405 NotSupported: esta funcionalidad no se admite.
409 Conflicto: no se pudo procesar la solicitud debido a un conflicto en la solicitud.
409 OperationCancelled: el usuario ha cancelado la operación.
409 OperationInterrupted: no se pudo completar la operación en el recurso porque se interrumpió por otra operación en el mismo recurso.
409 DefaultAdvisorStateNotAllowedInCustomServerMode: el estado del asesor DEFAULT no está permitido en modo PERSONALIZADO
409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress: la configuración de ajuste automático de la solicitud anterior no se ha propagado a todas las bases de datos de usuario.
429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar.
429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar.
500 OperationTimedOut: la operación agota el tiempo de espera y se revierte automáticamente. Vuelva a intentar la operación y,
503 ServiceTemporarilyUnavailable: característica no disponible temporalmente.
503 TooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar.

Ejemplos

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

Definiciones

Nombre	Description
AutomaticTuningOptionModeActual	Estado real de la opción de ajuste automático.
AutomaticTuningOptionModeDesired	Estado deseado de la opción de ajuste automático.
AutomaticTuningServerMode	Ajuste automático del estado deseado.
AutomaticTuningServerOptions	Propiedades de ajuste automático para asesores individuales.
AutomaticTuningServerReason	Descripción del motivo si el estado deseado y real son diferentes.
ServerAutomaticTuning	Ajuste automático de nivel de servidor.

AutomaticTuningOptionModeActual

Estado real de la opción de ajuste automático.

Nombre	Tipo	Description
Off	string
On	string

AutomaticTuningOptionModeDesired

Estado deseado de la opción de ajuste automático.

Nombre	Tipo	Description
Default	string
Off	string
On	string

AutomaticTuningServerMode

Ajuste automático del estado deseado.

Nombre	Tipo	Description
Auto	string
Custom	string
Unspecified	string

AutomaticTuningServerOptions

Propiedades de ajuste automático para asesores individuales.

Nombre	Tipo	Description
actualState	AutomaticTuningOptionModeActual	Estado real de la opción de ajuste automático.
desiredState	AutomaticTuningOptionModeDesired	Estado deseado de la opción de ajuste automático.
reasonCode	integer	Código de motivo si el estado deseado y real son diferentes.
reasonDesc	AutomaticTuningServerReason	Descripción del motivo si el estado deseado y real son diferentes.

AutomaticTuningServerReason

Descripción del motivo si el estado deseado y real son diferentes.

Nombre	Tipo	Description
AutoConfigured	string
Default	string
Disabled	string