Server Automatic Tuning - Update

Service:

SQL Database

API Version:

2021-11-01

Atualize as opções de ajuste automático no 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 URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio 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.

Corpo da solicitação

Nome	Tipo	Description
properties.desiredState	AutomaticTuningServerMode	Estado desejado de ajuste automático.
properties.options	<string,  AutomaticTuningServerOptions>	Definição de opções de ajuste automático.

Respostas

Nome	Tipo	Description
200 OK	ServerAutomaticTuning	Atualizou com êxito as opções de ajuste automático no nível do servidor.
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 InvalidAutomaticTuningUpsertRequest – o corpo da solicitação de ajuste automático de atualização não existe ou não tem nenhum objeto properties. 400 InvalidAdvisorAutoExecuteStatus – Não é permitido executar automaticamente o status especificado para o assistente. 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 Sem suporte - Não há suporte para essa funcionalidade. 409 Conflito – A solicitação não pôde ser processada devido a conflitos na solicitação. 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 DefaultAdvisorStateNotAllowedInCustomServerMode – Estado do assistente PADRÃO não permitido no modo PERSONALIZADO 409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress – As configurações de ajuste automático da solicitação anterior não foram propagadas para todos os bancos de dados de usuário. 429 SubscriptionTooManyCreateUpdateRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Tente executar a operação novamente. 503 ServiceTemporarilyUnavailable – Recurso temporariamente indisponível. 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

Exemplos

Updates server automatic tuning settings with all properties

Updates server automatic tuning settings with minimal properties

Updates server automatic tuning settings with all properties

Sample Request

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.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

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

Definições

Nome	Description
AutomaticTuningOptionModeActual	Estado real da opção de ajuste automático.
AutomaticTuningOptionModeDesired	Estado desejado da opção de ajuste automático.
AutomaticTuningServerMode	Estado desejado de ajuste automático.
AutomaticTuningServerOptions	Propriedades de ajuste automático para assistentes individuais.
AutomaticTuningServerReason	Descrição do motivo se desejado e estado real forem diferentes.
ServerAutomaticTuning	Ajuste automático no nível do servidor.

AutomaticTuningOptionModeActual

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

Nome	Tipo	Description
Off	string
On	string

AutomaticTuningOptionModeDesired

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

Nome	Tipo	Description
Default	string
Off	string
On	string

AutomaticTuningServerMode

Estado desejado de ajuste automático.

Nome	Tipo	Description
Auto	string
Custom	string
Unspecified	string

AutomaticTuningServerOptions

Propriedades de ajuste automático para assistentes individuais.

Nome	Tipo	Description
actualState	AutomaticTuningOptionModeActual	Estado real da opção de ajuste automático.
desiredState	AutomaticTuningOptionModeDesired	Estado desejado da opção de ajuste automático.
reasonCode	integer	Código de motivo se desejado e estado real são diferentes.
reasonDesc	AutomaticTuningServerReason	Descrição do motivo se desejado e estado real forem diferentes.

AutomaticTuningServerReason

Descrição do motivo se desejado e estado real forem diferentes.

Nome	Tipo	Description
AutoConfigured	string
Default	string
Disabled	string

ServerAutomaticTuning

Ajuste automático no nível do servidor.

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