Server Automatic Tuning - Update

Referência

Serviço:: SQL Database

Versão da API:: 2021-11-01

Atualize as opções de otimização automática 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 do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
api-version	query	True	string	A versão da API a utilizar para o pedido.

Corpo do Pedido

Name	Tipo	Description
properties.desiredState	AutomaticTuningServerMode	Otimização automática do estado pretendido.
properties.options	<string, AutomaticTuningServerOptions>	Definição de opções de otimização automática.

Respostas

Name	Tipo	Description
200 OK	ServerAutomaticTuning	As opções de otimização automática ao nível do servidor foram atualizadas com êxito.
Other Status Codes		Respostas de Erro: *** 400 FeatureDisabledOnSelectedEdition – o utilizador tentou utilizar uma funcionalidade que está desativada na edição atual da base de dados. 400 InvalidIdentifier - O identificador contém NULL ou um caráter unicode inválido. 400 InvalidAutomaticTuningUpsertRequest – o corpo do pedido de otimização automática de atualização não existe ou não tem nenhum objeto de propriedades. 400 InvalidAdvisorAutoExecuteStatus – o estado de execução automática especificado para o assistente não é permitido. 404 DatabaseDoesNotExist - A base de dados pedida não foi encontrada 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado 404 SubscriptionDoesNotHaveElasticPool - O conjunto elástico pedido não foi encontrado 404 OperationIdNotFound - A operação com o ID não existe. 404 AutomaticTuningOptionNotFound – a opção de otimização automática pedida não foi encontrada. 405 NotSupported – esta funcionalidade não é suportada. 409 Conflito – não foi possível processar o pedido devido a um conflito no pedido. 409 OperationCancelled - A operação foi cancelada pelo utilizador. 409 OperationInterrupted - Não foi possível concluir a operação no recurso porque foi interrompida por outra operação no mesmo recurso. 409 DefaultAdvisorStateNotAllowedInCustomServerMode - Estado do assistente PREDEFINido não permitido no modo PERSONALIZADO 409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress – as definições de otimização automática do pedido anterior não foram propagadas para todas as bases de dados de utilizador. 429 SubscriptionTooManyCreateUpdateRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis. 429 SubscriptionTooManyRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis. 500 OperationTimedOut – a operação excedeu o limite de tempo e foi revertida automaticamente. Repita a operação. 503 ServiceTemporarilyUnavailable - Funcionalidade temporariamente indisponível. 503 TooManyRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis.

Name

Tipo

Description

200 OK

ServerAutomaticTuning

As opções de otimização automática ao nível do servidor foram atualizadas com êxito.

Other Status Codes

Respostas de Erro: ***

400 FeatureDisabledOnSelectedEdition – o utilizador tentou utilizar uma funcionalidade que está desativada na edição atual da base de dados.
400 InvalidIdentifier - O identificador contém NULL ou um caráter unicode inválido.
400 InvalidAutomaticTuningUpsertRequest – o corpo do pedido de otimização automática de atualização não existe ou não tem nenhum objeto de propriedades.
400 InvalidAdvisorAutoExecuteStatus – o estado de execução automática especificado para o assistente não é permitido.
404 DatabaseDoesNotExist - A base de dados pedida não foi encontrada
404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado
404 SubscriptionDoesNotHaveElasticPool - O conjunto elástico pedido não foi encontrado
404 OperationIdNotFound - A operação com o ID não existe.
404 AutomaticTuningOptionNotFound – a opção de otimização automática pedida não foi encontrada.
405 NotSupported – esta funcionalidade não é suportada.
409 Conflito – não foi possível processar o pedido devido a um conflito no pedido.
409 OperationCancelled - A operação foi cancelada pelo utilizador.
409 OperationInterrupted - Não foi possível concluir a operação no recurso porque foi interrompida por outra operação no mesmo recurso.
409 DefaultAdvisorStateNotAllowedInCustomServerMode - Estado do assistente PREDEFINido não permitido no modo PERSONALIZADO
409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress – as definições de otimização automática do pedido anterior não foram propagadas para todas as bases de dados de utilizador.
429 SubscriptionTooManyCreateUpdateRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis.
429 SubscriptionTooManyRequests - Pedidos para além dos pedidos máximos que podem ser processados por recursos disponíveis.
500 OperationTimedOut – a operação excedeu o limite de tempo e foi revertida automaticamente. Repita a operação.
503 ServiceTemporarilyUnavailable - Funcionalidade temporariamente indisponível.
503 TooManyRequests - Pedidos para além dos pedidos máximos que podem ser processados 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

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

Resposta da amostra

Código de estado:: 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

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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

Name	Description
AutomaticTuningOptionModeActual	Estado real da opção de otimização automática.
AutomaticTuningOptionModeDesired	O estado pretendido da opção de otimização automática.
AutomaticTuningServerMode	Otimização automática do estado pretendido.
AutomaticTuningServerOptions	Propriedades de otimização automática para consultores individuais.
AutomaticTuningServerReason	Descrição do motivo se o estado pretendido e o estado real forem diferentes.
ServerAutomaticTuning	Otimização Automática ao nível do servidor.

AutomaticTuningOptionModeActual

Estado real da opção de otimização automática.

Name	Tipo	Description
Off	string
On	string

AutomaticTuningOptionModeDesired

O estado pretendido da opção de otimização automática.

Name	Tipo	Description
Default	string
Off	string
On	string

AutomaticTuningServerMode

Otimização automática do estado pretendido.

Name	Tipo	Description
Auto	string
Custom	string
Unspecified	string

AutomaticTuningServerOptions

Propriedades de otimização automática para consultores individuais.

Name	Tipo	Description
actualState	AutomaticTuningOptionModeActual	Estado real da opção de otimização automática.
desiredState	AutomaticTuningOptionModeDesired	O estado pretendido da opção de otimização automática.
reasonCode	integer	Código do motivo se o estado pretendido e o estado real forem diferentes.
reasonDesc	AutomaticTuningServerReason	Descrição do motivo se o estado pretendido e o estado real forem diferentes.

AutomaticTuningServerReason

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

Name	Tipo	Description
AutoConfigured	string
Default	string
Disabled	string