Database Automatic Tuning - Update

Serviço:

SQL Database

Versão API:

2021-11-01

Atualize as propriedades de ajuste automático para o banco de dados 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 URI

Nome	Em	Necessário	Tipo	Descrição
databaseName	path	True	string	O nome do banco de dados.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Órgão do Pedido

Nome	Tipo	Descrição
properties.desiredState	AutomaticTuningMode	Ajuste automático do estado desejado.
properties.options	<string,  AutomaticTuningOptions>	Definição automática de opções de ajuste.

Respostas

Nome	Tipo	Descrição
200 OK	DatabaseAutomaticTuning	Atualizadas com êxito as configurações de ajuste automático do banco de dados especificadas.
Other Status Codes		Respostas de erro: *** 400 FeatureDisabledOnSelectedEdition - O usuário tentou usar um recurso que está desabilitado na edição atual do banco de dados. 400 InvalidIdentifier - O identificador contém NULL ou um caractere unicode inválido. 400 SystemDatabasesNotSupported - O usuário tentou obter informações de ajuste automático nos bancos de dados do sistema. 400 DataWarehouseNotSupported - O ajuste automático não é suportado para o SQL Data Warehouse. 400 InvalidAutomaticTuningUpsertRequest - O corpo da solicitação de ajuste automático de atualização não existe ou não tem nenhum objeto de propriedades. 400 InvalidAdvisorAutoExecuteStatus - O status de execução automática especificado para o consultor não é permitido. 404 DatabaseDoesNotExist - O banco de dados solicitado não foi encontrado 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado 404 SubscriptionDoesNotHaveElasticPool - O pool elástico solicitado não foi encontrado 404 OperationIdNotFound - A operação com Id não existe. 404 AutomaticTuningOptionNotFound - A opção de ajuste automático solicitada não foi encontrada. 405 NotSupported - Esta funcionalidade não é suportada. 409 Conflito - O pedido não pôde ser processado devido a conflito no pedido. 409 OperationCancelled - A operação foi cancelada pelo usuário. 409 OperationInterrupted - A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso. 409 DisabledBySystem - Esta opção é desativada pelo sistema 409 DefaultAdvisorStateNotAllowedInCustomDbMode - O estado do consultor DEFAULT não é permitido no modo CUSTOM 429 SubscriptionTooManyCreateUpdateRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis. 429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis. 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Por favor, tente novamente a operação. 503 ServiceTemporariamenteIndisponível - Recurso temporariamente indisponível. 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

Exemplos

Updates database automatic tuning settings with all properties

Updates database automatic tuning settings with minimal properties

Updates database automatic tuning settings with all properties

Pedido de exemplo

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

Resposta de exemplo

Código de estado:

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

Pedido de exemplo

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

Resposta de exemplo

Código de estado:

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

Definições

Nome	Descrição
AutomaticTuningDisabledReason	A descrição do motivo, se desejado, e o estado real são diferentes.
AutomaticTuningMode	Ajuste automático do estado desejado.
AutomaticTuningOptionModeActual	Estado real da opção de ajuste automático.
AutomaticTuningOptionModeDesired	Opção de ajuste automático estado desejado.
AutomaticTuningOptions	Propriedades de ajuste automático para consultores individuais.
DatabaseAutomaticTuning	Sintonização automática no nível do banco de dados.

AutomaticTuningDisabledReason

Enumeração

A descrição do motivo, se desejado, e o estado real são diferentes.

Valor	Descrição
Default
Disabled
AutoConfigured
InheritedFromServer
QueryStoreOff
QueryStoreReadOnly
NotSupported

AutomaticTuningMode

Enumeração

Ajuste automático do estado desejado.

Valor	Descrição
Inherit
Custom
Auto
Unspecified

AutomaticTuningOptionModeActual

Enumeração

Estado real da opção de ajuste automático.

Valor	Descrição
Off
On

AutomaticTuningOptionModeDesired

Enumeração

Opção de ajuste automático estado desejado.

Valor	Descrição
Off
On
Default

AutomaticTuningOptions

Objetivo

Propriedades de ajuste automático para consultores individuais.

Nome	Tipo	Descrição
actualState	AutomaticTuningOptionModeActual	Estado real da opção de ajuste automático.
desiredState	AutomaticTuningOptionModeDesired	Opção de ajuste automático estado desejado.
reasonCode	integer (int32)	O código de razão, se desejado, e o estado real são diferentes.
reasonDesc	AutomaticTuningDisabledReason	A descrição do motivo, se desejado, e o estado real são diferentes.

DatabaseAutomaticTuning

Objetivo

Sintonização automática no nível do banco de dados.

Nome	Tipo	Descrição
id	string	ID do recurso.
name	string	Nome do recurso.
properties.actualState	AutomaticTuningMode	Ajuste automático do estado real.
properties.desiredState	AutomaticTuningMode	Ajuste automático do estado desejado.
properties.options	<string,  AutomaticTuningOptions>	Definição automática de opções de ajuste.
type	string	Tipo de recurso.