Database Automatic Tuning - Update

Služba:

SQL Database

Verze rozhraní API:

2023-08-01

Aktualizujte vlastnosti automatického ladění pro cílovou databázi.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
databaseName	path	True	string	Název databáze.
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Text požadavku

Name	Typ	Description
properties.desiredState	AutomaticTuningMode	Požadovaný stav automatického ladění
properties.options	<string,  AutomaticTuningOptions>	Definice možností automatického ladění

Odpovědi

Name	Typ	Description
200 OK	DatabaseAutomaticTuning	Nastavení automatického ladění zadané databáze bylo úspěšně aktualizováno.
Other Status Codes	ErrorResponse	Chybové odpovědi: *** 400 FeatureDisabledOnSelectedEdition – Uživatel se pokusil použít funkci, která je v aktuální edici databáze zakázaná. 400 InvalidIdentifier – identifikátor obsahuje hodnotu NULL nebo neplatný znak unicode. 400 SystemDatabasesNotSupported – Uživatel se pokusil získat informace o automatickém ladění systémových databází. 400 DataWarehouseNotSupported – Sql Data Warehouse nepodporuje automatické ladění. 400 InvalidAutomaticTuningUpsertRequest – tělo požadavku automatického ladění aktualizace neexistuje nebo nemá žádný objekt vlastností. 400 InvalidAdvisorAutoExecuteStatus – Zadaný stav automatického spuštění pro poradce není povolený. 404 SubscriptionDoesNotHaveServer – Požadovaný server nebyl nalezen. 404 DatabaseDoesNotExist – Požadovaná databáze nebyla nalezena. 404 SubscriptionDoesNotHaveElasticPool – Požadovaný elastický fond nebyl nalezen. 404 OperationIdNotFound – operace s ID neexistuje. 404 AutomaticTuningOptionNotFound – Požadovaná možnost automatického ladění nebyla nalezena. 405 NotSupported – Tato funkce není podporována. 409 Konflikt – Požadavek nelze zpracovat kvůli konfliktu v požadavku. 409 CannotCancelOperation – Operace správy je ve stavu, který nelze zrušit. 409 OperationCancelled - Operace byla zrušena uživatelem. 409 OperationInterrupted – operaci s prostředkem nebylo možné dokončit, protože byla přerušena jinou operací na stejném prostředku. 409 DefaultAdvisorStateNotAllowedInCustomDbMode – výchozí stav poradce není v vlastním režimu povolený 409 DisabledBySystem – Tato možnost je zakázána systémem. 429 SubscriptionTooManyCreateUpdateRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 429 SubscriptionTooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky. 500 OperationTimedOut – Vypršel časový limit operace a automaticky se vrátil zpět. Zkuste operaci zopakovat. 503 ServiceTemporarilyUnavailable – Funkce je dočasně nedostupná. 503 TooManyRequests – Požadavky nad rámec maximálních požadavků, které je možné zpracovat dostupnými prostředky.

Příklady

Updates database automatic tuning settings with all properties

Updates database automatic tuning settings with minimal properties

Updates database automatic tuning settings with all properties

Ukázkový požadavek

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=2023-08-01

{
  "properties": {
    "desiredState": "Auto",
    "options": {
      "createIndex": {
        "desiredState": "Off"
      },
      "dropIndex": {
        "desiredState": "On"
      },
      "forceLastGoodPlan": {
        "desiredState": "Default"
      }
    }
  }
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/DatabaseAutomaticTuningUpdateMax.json
// this example is just showing the usage of "DatabaseAutomaticTuning_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseAutomaticTuningResource created on azure
// for more information of creating SqlDatabaseAutomaticTuningResource, please refer to the document of SqlDatabaseAutomaticTuningResource
string subscriptionId = "c3aa9078-0000-0000-0000-e36f151182d7";
string resourceGroupName = "default-sql-onebox";
string serverName = "testsvr11";
string databaseName = "db1";
ResourceIdentifier sqlDatabaseAutomaticTuningResourceId = SqlDatabaseAutomaticTuningResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseAutomaticTuningResource sqlDatabaseAutomaticTuning = client.GetSqlDatabaseAutomaticTuningResource(sqlDatabaseAutomaticTuningResourceId);

// invoke the operation
SqlDatabaseAutomaticTuningData data = new SqlDatabaseAutomaticTuningData
{
    DesiredState = AutomaticTuningMode.Auto,
    Options =
    {
    ["createIndex"] = new AutomaticTuningOptions
    {
    DesiredState = AutomaticTuningOptionModeDesired.Off,
    },
    ["dropIndex"] = new AutomaticTuningOptions
    {
    DesiredState = AutomaticTuningOptionModeDesired.On,
    },
    ["forceLastGoodPlan"] = new AutomaticTuningOptions
    {
    DesiredState = AutomaticTuningOptionModeDesired.Default,
    }
    },
};
SqlDatabaseAutomaticTuningResource result = await sqlDatabaseAutomaticTuning.UpdateAsync(data);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlDatabaseAutomaticTuningData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:

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

Ukázkový požadavek

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=2023-08-01

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/DatabaseAutomaticTuningUpdateMin.json
// this example is just showing the usage of "DatabaseAutomaticTuning_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseAutomaticTuningResource created on azure
// for more information of creating SqlDatabaseAutomaticTuningResource, please refer to the document of SqlDatabaseAutomaticTuningResource
string subscriptionId = "c3aa9078-0000-0000-0000-e36f151182d7";
string resourceGroupName = "default-sql-onebox";
string serverName = "testsvr11";
string databaseName = "db1";
ResourceIdentifier sqlDatabaseAutomaticTuningResourceId = SqlDatabaseAutomaticTuningResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseAutomaticTuningResource sqlDatabaseAutomaticTuning = client.GetSqlDatabaseAutomaticTuningResource(sqlDatabaseAutomaticTuningResourceId);

// invoke the operation
SqlDatabaseAutomaticTuningData data = new SqlDatabaseAutomaticTuningData
{
    DesiredState = AutomaticTuningMode.Auto,
};
SqlDatabaseAutomaticTuningResource result = await sqlDatabaseAutomaticTuning.UpdateAsync(data);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlDatabaseAutomaticTuningData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
AutomaticTuningDisabledReason	Popis důvodu, pokud se požadovaný a skutečný stav liší.
AutomaticTuningMode	Požadovaný stav automatického ladění
AutomaticTuningOptionModeActual	Skutečný stav možnosti automatického ladění
AutomaticTuningOptionModeDesired	Požadovaný stav možnosti automatického ladění
AutomaticTuningOptions	Vlastnosti automatického ladění pro jednotlivé poradce
DatabaseAutomaticTuning	Automatické ladění na úrovni databáze
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď

AutomaticTuningDisabledReason

Výčet

Popis důvodu, pokud se požadovaný a skutečný stav liší.

Hodnota	Description
Default
Disabled
AutoConfigured
InheritedFromServer
QueryStoreOff
QueryStoreReadOnly
NotSupported

AutomaticTuningMode

Výčet

Požadovaný stav automatického ladění

Hodnota	Description
Inherit
Custom
Auto
Unspecified

AutomaticTuningOptionModeActual

Výčet

Skutečný stav možnosti automatického ladění

Hodnota	Description
Off
On

AutomaticTuningOptionModeDesired

Výčet

Požadovaný stav možnosti automatického ladění

Hodnota	Description
Off
On
Default

AutomaticTuningOptions

Objekt

Vlastnosti automatického ladění pro jednotlivé poradce

Name	Typ	Description
actualState	AutomaticTuningOptionModeActual	Skutečný stav možnosti automatického ladění
desiredState	AutomaticTuningOptionModeDesired	Požadovaný stav možnosti automatického ladění
reasonCode	integer (int32)	Kód důvodu, pokud se požadovaný a skutečný stav liší.
reasonDesc	AutomaticTuningDisabledReason	Popis důvodu, pokud se požadovaný a skutečný stav liší.

DatabaseAutomaticTuning

Objekt

Automatické ladění na úrovni databáze

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku
properties.actualState	AutomaticTuningMode	Skutečný stav automatického ladění
properties.desiredState	AutomaticTuningMode	Požadovaný stav automatického ladění
properties.options	<string,  AutomaticTuningOptions>	Definice možností automatického ladění
type	string	Typ prostředku.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.