Database Automatic Tuning - Update

Servicio:

SQL Database

Versión de la API:

2021-11-01

Actualice las propiedades de ajuste automático de la base de datos de destino.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	El nombre de la base de datos.
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	AutomaticTuningMode	Ajuste automático del estado deseado.
properties.options	<string,  AutomaticTuningOptions>	Definición de opciones de ajuste automático.

Respuestas

Nombre	Tipo	Description
200 OK	DatabaseAutomaticTuning	Se actualizó correctamente la configuración de ajuste automático de la base de datos especificada.
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 SystemDatabasesNotSupported: el usuario intentó obtener información de ajuste automático en las bases de datos del sistema. 400 DataWarehouseNotSupported: no se admite el ajuste automático para SQL Data Warehouse. 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 DisabledBySystem: esta opción está deshabilitada por el sistema 409 DefaultAdvisorStateNotAllowedInCustomDbMode: no se permite el estado del asesor DEFAULT en modo PERSONALIZADO 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 database automatic tuning settings with all properties

Updates database automatic tuning settings with minimal properties

Updates database automatic tuning settings with all properties

Solicitud de ejemplo

HTTP

PATCH https://management.azure.com/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/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.DatabaseAutomaticTuningInner;
import com.azure.resourcemanager.sql.models.AutomaticTuningMode;
import com.azure.resourcemanager.sql.models.AutomaticTuningOptionModeDesired;
import com.azure.resourcemanager.sql.models.AutomaticTuningOptions;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for DatabaseAutomaticTuning Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseAutomaticTuningUpdateMax.json
     */
    /**
     * Sample code: Updates database automatic tuning settings with all properties.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updatesDatabaseAutomaticTuningSettingsWithAllProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseAutomaticTunings().updateWithResponse(
            "default-sql-onebox", "testsvr11", "db1",
            new DatabaseAutomaticTuningInner().withDesiredState(AutomaticTuningMode.AUTO)
                .withOptions(mapOf("createIndex",
                    new AutomaticTuningOptions().withDesiredState(AutomaticTuningOptionModeDesired.OFF), "dropIndex",
                    new AutomaticTuningOptions().withDesiredState(AutomaticTuningOptionModeDesired.ON),
                    "forceLastGoodPlan",
                    new AutomaticTuningOptions().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

Respuesta de muestra

status code:

200

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

Updates database automatic tuning settings with minimal properties

Solicitud de ejemplo

HTTP

PATCH https://management.azure.com/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/databases/db1/automaticTuning/current?api-version=2021-11-01

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

Java

import com.azure.resourcemanager.sql.fluent.models.DatabaseAutomaticTuningInner;
import com.azure.resourcemanager.sql.models.AutomaticTuningMode;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for DatabaseAutomaticTuning Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseAutomaticTuningUpdateMin.json
     */
    /**
     * Sample code: Updates database automatic tuning settings with minimal properties.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updatesDatabaseAutomaticTuningSettingsWithMinimalProperties(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseAutomaticTunings().updateWithResponse(
            "default-sql-onebox", "testsvr11", "db1",
            new DatabaseAutomaticTuningInner().withDesiredState(AutomaticTuningMode.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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
AutomaticTuningDisabledReason	Descripción del motivo si el estado deseado y real son diferentes.
AutomaticTuningMode	Ajuste automático del estado deseado.
AutomaticTuningOptionModeActual	Estado real de la opción de ajuste automático.
AutomaticTuningOptionModeDesired	Estado deseado de la opción de ajuste automático.
AutomaticTuningOptions	Propiedades de ajuste automático para asesores individuales.
DatabaseAutomaticTuning	Ajuste automático de nivel de base de datos.

AutomaticTuningDisabledReason

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

Nombre	Tipo	Description
AutoConfigured	string
Default	string
Disabled	string
InheritedFromServer	string
NotSupported	string
QueryStoreOff	string
QueryStoreReadOnly	string

AutomaticTuningMode

Ajuste automático del estado deseado.

Nombre	Tipo	Description
Auto	string
Custom	string
Inherit	string
Unspecified	string

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

AutomaticTuningOptions

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	AutomaticTuningDisabledReason	Descripción del motivo si el estado deseado y real son diferentes.

DatabaseAutomaticTuning

Ajuste automático de nivel de base de datos.

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.actualState	AutomaticTuningMode	Estado real de ajuste automático.
properties.desiredState	AutomaticTuningMode	Ajuste automático del estado deseado.
properties.options	<string,  AutomaticTuningOptions>	Definición de opciones de ajuste automático.
type	string	Tipo de recurso.