Server Automatic Tuning - Update

Service:

SQL Database

API Version:

2021-11-01

Sunucudaki otomatik ayarlama seçeneklerini güncelleştirin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kaynağı içeren kaynak grubunun adı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz.
serverName	path	True	string	Sunucunun adı.
subscriptionId	path	True	string	Azure aboneliğini tanımlayan abonelik kimliği.
api-version	query	True	string	İstek için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
properties.desiredState	AutomaticTuningServerMode	otomatik ayarlama istenen durum.
properties.options	<string,  AutomaticTuningServerOptions>	Otomatik ayarlama seçenekleri tanımı.

Yanıtlar

Name	Tür	Description
200 OK	ServerAutomaticTuning	Sunucu düzeyinde otomatik ayarlama seçenekleri başarıyla güncelleştirildi.
Other Status Codes		Hata Yanıtları: *** 400 FeatureDisabledOnSelectedEdition - Kullanıcı geçerli veritabanı sürümünde devre dışı bırakılmış bir özelliği kullanmaya çalıştı. 400 InvalidIdentifier - Tanımlayıcı NULL veya geçersiz unicode karakter içeriyor. 400 InvalidAutomaticTuningUpsertRequest - Güncelleştirme otomatik ayarlama isteği gövdesi yok veya özellik nesnesi yok. 400 InvalidAdvisorAutoExecuteStatus - Danışman için belirtilen otomatik yürütme durumuna izin verilmiyor. 404 DatabaseDoesNotExist - İstenen veritabanı bulunamadı 404 SubscriptionDoesNotHaveServer - İstenen sunucu bulunamadı 404 SubscriptionDoesNotHaveElasticPool - İstenen elastik havuz bulunamadı 404 OperationIdNotFound - Kimlikli işlem yok. 404 AutomaticTuningOptionNotFound - İstenen otomatik ayarlama seçeneği bulunamadı. 405 Desteklenmiyor - Bu işlev desteklenmiyor. 409 Çakışma - İstekteki çakışma nedeniyle istek işlenemedi. 409 OperationCancelled - İşlem kullanıcı tarafından iptal edildi. 409 İşlem Kesildi - Aynı kaynakta başka bir işlem tarafından kesildiği için kaynak üzerindeki işlem tamamlanamadı. 409 DefaultAdvisorStateNotAllowedInCustomServerMode - ÖZEL modda VARSAYıLAN danışman durumuna izin verilmiyor 409 UpdateNotAllowedIfServerAutotuningUpdateOperationInProgress - Önceki istekten otomatik ayarlama ayarları tüm kullanıcı veritabanlarına yayılmadı. 429 SubscriptionTooManyCreateUpdateRequests - Kullanılabilir kaynaklar tarafından işlenebilen maksimum isteklerin ötesindeki istekler. 429 SubscriptionTooManyRequests - Kullanılabilir kaynaklar tarafından işlenebilen maksimum isteklerin ötesindeki istekler. 500 OperationTimedOut - İşlem zaman aşımına uğradı ve otomatik olarak geri alındı. Lütfen işlemi yeniden deneyin. 503 ServiceTemporarilyUnavailable - Özellik geçici olarak kullanılamıyor. 503 TooManyRequests - Kullanılabilir kaynaklar tarafından işlenebilen maksimum isteklerin ötesindeki istekler.

Örnekler

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

Tanımlar

Name	Description
AutomaticTuningOptionModeActual	Otomatik ayarlama seçeneği gerçek durumu.
AutomaticTuningOptionModeDesired	Otomatik ayarlama seçeneği istenen durum.
AutomaticTuningServerMode	otomatik ayarlama istenen durum.
AutomaticTuningServerOptions	Tek tek danışmanlar için otomatik ayarlama özellikleri.
AutomaticTuningServerReason	İstenen ve gerçek durum farklıysa neden açıklaması.
ServerAutomaticTuning	Sunucu düzeyinde Otomatik Ayarlama.

AutomaticTuningOptionModeActual

Otomatik ayarlama seçeneği gerçek durumu.

Name	Tür	Description
Off	string
On	string

AutomaticTuningOptionModeDesired

Otomatik ayarlama seçeneği istenen durum.

Name	Tür	Description
Default	string
Off	string
On	string

AutomaticTuningServerMode

otomatik ayarlama istenen durum.

Name	Tür	Description
Auto	string
Custom	string
Unspecified	string

AutomaticTuningServerOptions

Tek tek danışmanlar için otomatik ayarlama özellikleri.

Name	Tür	Description
actualState	AutomaticTuningOptionModeActual	Otomatik ayarlama seçeneği gerçek durumu.
desiredState	AutomaticTuningOptionModeDesired	Otomatik ayarlama seçeneği istenen durum.
reasonCode	integer	İstenen durum ve gerçek durum farklıysa neden kodu.
reasonDesc	AutomaticTuningServerReason	İstenen ve gerçek durum farklıysa neden açıklaması.

AutomaticTuningServerReason

İstenen ve gerçek durum farklıysa neden açıklaması.

Name	Tür	Description
AutoConfigured	string
Default	string
Disabled	string

ServerAutomaticTuning

Sunucu düzeyinde Otomatik Ayarlama.

Name	Tür	Description
id	string	Kaynak Kimliği.
name	string	Kaynak adı.
properties.actualState	AutomaticTuningServerMode	Gerçek durumu otomatik ayarlama.
properties.desiredState	AutomaticTuningServerMode	otomatik ayarlama istenen durum.
properties.options	<string,  AutomaticTuningServerOptions>	Otomatik ayarlama seçenekleri tanımı.
type	string	Kaynak türü.