Database Automatic Tuning - Update

Service:

SQL Database

API-versie:

2023-08-01

Automatische afstemmingseigenschappen voor doeldatabase bijwerken.

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

URI-parameters

Name	In	Vereist	Type	Description
databaseName	path	True	string	De naam van de database.
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.

Aanvraagbody

Name	Type	Description
properties.desiredState	AutomaticTuningMode	Automatische afstemmingsstatus.
properties.options	<string,  AutomaticTuningOptions>	Definitie van opties voor automatisch afstemmen.

Antwoorden

Name	Type	Description
200 OK	DatabaseAutomaticTuning	De opgegeven instellingen voor automatisch afstemmen van de database zijn bijgewerkt.
Other Status Codes	ErrorResponse	Foutreacties: *** 400 FeatureDisabledOnSelectedEdition - Gebruiker heeft geprobeerd een functie te gebruiken die is uitgeschakeld voor de huidige database-editie. 400 InvalidIdentifier: de id bevat NULL of een ongeldig Unicode-teken. 400 SystemDatabasesNotSupported - Gebruiker heeft geprobeerd informatie over automatische afstemming op systeemdatabases op te halen. 400 DataWarehouseNotSupported - Automatisch afstemmen wordt niet ondersteund voor SQL Data Warehouse. 400 InvalidAutomaticTuningUpsertRequest : de hoofdtekst van de automatische afstemmingsaanvraag bestaat niet of heeft geen eigenschappenobject. 400 InvalidAdvisorAutoExecuteStatus - Opgegeven status voor automatisch uitvoeren voor de advisor is niet toegestaan. 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden 404 DatabaseDoesNotExist - De aangevraagde database is niet gevonden 404 SubscriptionDoesNotHaveElasticPool - De aangevraagde elastische pool is niet gevonden 404 OperationIdNotFound - De bewerking met id bestaat niet. 404 AutomaticTuningOptionNotFound - De aangevraagde optie voor automatisch afstemmen is niet gevonden. 405 NotSupported : deze functionaliteit wordt niet ondersteund. 409 Conflict - Aanvraag kan niet worden verwerkt vanwege een conflict in de aanvraag. 409 CannotCancelOperation - De beheerbewerking heeft een status die niet kan worden geannuleerd. 409 OperationCancelled - De bewerking is geannuleerd door de gebruiker. 409 Bewerking onderbroken: de bewerking op de resource kan niet worden voltooid omdat deze is onderbroken door een andere bewerking op dezelfde resource. 409 DefaultAdvisorStateNotAllowedInCustomDbMode - STANDAARD advisor-status is niet toegestaan in de AANGEPASTe modus 409 DisabledBySystem - Deze optie is uitgeschakeld door het systeem 429 SubscriptionTooManyCreateUpdateRequests - Aanvragen buiten het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources. 429 SubscriptionTooManyRequests : aanvragen buiten het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources. 500 OperationTimedOut: er is een time-out opgetreden voor de bewerking en wordt automatisch teruggedraaid. Voer de bewerking opnieuw uit. 503 ServiceTemporarilyUnavailable - Functie tijdelijk niet beschikbaar. 503 TooManyRequests : aanvragen die buiten het maximum aantal aanvragen kunnen worden verwerkt door beschikbare resources.

Voorbeelden

Updates database automatic tuning settings with all properties

Updates database automatic tuning settings with minimal properties

Updates database automatic tuning settings with all properties

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
AutomaticTuningDisabledReason	Redenbeschrijving indien gewenst en werkelijke status verschillen.
AutomaticTuningMode	Automatische afstemmingsstatus.
AutomaticTuningOptionModeActual	Automatische afstemmingsoptie werkelijke status.
AutomaticTuningOptionModeDesired	Automatische afstemmingsoptie gewenste status.
AutomaticTuningOptions	Eigenschappen voor automatisch afstemmen voor individuele adviseurs.
DatabaseAutomaticTuning	Automatisch afstemmen op databaseniveau.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie

AutomaticTuningDisabledReason

Inventarisatie

Redenbeschrijving indien gewenst en werkelijke status verschillen.

Waarde	Description
Default
Disabled
AutoConfigured
InheritedFromServer
QueryStoreOff
QueryStoreReadOnly
NotSupported

AutomaticTuningMode

Inventarisatie

Automatische afstemmingsstatus.

Waarde	Description
Inherit
Custom
Auto
Unspecified

AutomaticTuningOptionModeActual

Inventarisatie

Automatische afstemmingsoptie werkelijke status.

Waarde	Description
Off
On

AutomaticTuningOptionModeDesired

Inventarisatie

Automatische afstemmingsoptie gewenste status.

Waarde	Description
Off
On
Default

AutomaticTuningOptions

Object

Eigenschappen voor automatisch afstemmen voor individuele adviseurs.

Name	Type	Description
actualState	AutomaticTuningOptionModeActual	Automatische afstemmingsoptie werkelijke status.
desiredState	AutomaticTuningOptionModeDesired	Automatische afstemmingsoptie gewenste status.
reasonCode	integer (int32)	Redencode is indien gewenst en de werkelijke status anders.
reasonDesc	AutomaticTuningDisabledReason	Redenbeschrijving indien gewenst en werkelijke status verschillen.

DatabaseAutomaticTuning

Object

Automatisch afstemmen op databaseniveau.

Name	Type	Description
id	string	Resource-id.
name	string	Resourcenaam.
properties.actualState	AutomaticTuningMode	Automatische afstemming van de werkelijke status.
properties.desiredState	AutomaticTuningMode	Automatische afstemmingsstatus.
properties.options	<string,  AutomaticTuningOptions>	Definitie van opties voor automatisch afstemmen.
type	string	Resourcetype.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.