Database Automatic Tuning - Update

Servicio:

SQL Database

Versión de la API:

2023-08-01

Actualice las propiedades de ajuste automático de la base de datos de destino.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	Nombre de la base de datos.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
serverName	path	True	string	Nombre del servidor.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.desiredState	AutomaticTuningMode	Estado deseado de ajuste automático.
properties.options	<string,  AutomaticTuningOptions>	Definición de opciones de ajuste automático.

Respuestas

Nombre	Tipo	Description
200 OK	DatabaseAutomaticTuning	Se ha actualizado correctamente la configuración de ajuste automático de la base de datos especificada.
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 FeatureDisabledOnSelectedEdition: el usuario intentó usar una característica que está deshabilitada en la edición actual de la base de datos. 400 InvalidIdentifier: el identificador contiene NULL o un carácter unicode no válido. 400 SystemDatabasesNotSupported: el usuario intentó obtener información de ajuste automático en las bases de datos del sistema. 400 DataWarehouseNotSupported: no se admite el ajuste automático para SQL Data Warehouse. 400 InvalidAutomaticTuningUpsertRequest: el cuerpo de la solicitud de ajuste automático de actualizaciones no existe o no tiene ningún objeto de propiedades. 400 InvalidAdvisorAutoExecuteStatus: no se permite el estado de ejecución automática especificado para el asesor. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 DatabaseDoesNotExist: no se encontró la base de datos solicitada. 404 SubscriptionDoesNotHaveElasticPool: no se encontró el grupo elástico solicitado. 404 OperationIdNotFound: la operación con id. no existe. 404 AutomaticTuningOptionNotFound: no se encontró la opción de ajuste automático solicitada. 405 NotSupported: esta funcionalidad no se admite. 409 Conflicto: no se pudo procesar la solicitud debido a un conflicto en la solicitud. 409 CannotCancelOperation: la operación de administración está en un estado que no se puede cancelar. 409 OperationCancelled: el usuario canceló la operación. 409 OperationInterrupted: no se pudo completar la operación en el recurso porque se interrumpió otra operación en el mismo recurso. 409 DefaultAdvisorStateNotAllowedInCustomDbMode: el estado del asesor DEFAULT no está permitido en modo PERSONALIZADO 409 DisabledBySystem: esta opción está deshabilitada por el sistema. 429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles. 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 500 OperationTimedOut: la operación agota el tiempo de espera y se revierte automáticamente. Vuelva a intentar la operación. 503 ServiceTemporarilyUnavailable: característica no disponible temporalmente. 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.

Ejemplos

Updates database automatic tuning settings with all properties

Updates database automatic tuning settings with minimal properties

Updates database automatic tuning settings with all properties

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
AutomaticTuningDisabledReason	Descripción del motivo si el estado deseado y real son diferentes.
AutomaticTuningMode	Estado deseado de ajuste automático.
AutomaticTuningOptionModeActual	Estado real de la opción de ajuste automático.
AutomaticTuningOptionModeDesired	Estado deseado de la opción de ajuste automático.
AutomaticTuningOptions	Propiedades de ajuste automático para asesores individuales.
DatabaseAutomaticTuning	Ajuste automático de nivel de base de datos.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

AutomaticTuningDisabledReason

Enumeración

Descripción del motivo si el estado deseado y real son diferentes.

Valor	Description
Default
Disabled
AutoConfigured
InheritedFromServer
QueryStoreOff
QueryStoreReadOnly
NotSupported

AutomaticTuningMode

Enumeración

Estado deseado de ajuste automático.

Valor	Description
Inherit
Custom
Auto
Unspecified

AutomaticTuningOptionModeActual

Enumeración

Estado real de la opción de ajuste automático.

Valor	Description
Off
On

AutomaticTuningOptionModeDesired

Enumeración

Estado deseado de la opción de ajuste automático.

Valor	Description
Off
On
Default

AutomaticTuningOptions

Object

Propiedades de ajuste automático para asesores individuales.

Nombre	Tipo	Description
actualState	AutomaticTuningOptionModeActual	Estado real de la opción de ajuste automático.
desiredState	AutomaticTuningOptionModeDesired	Estado deseado de la opción de ajuste automático.
reasonCode	integer (int32)	Código de motivo si el estado deseado y real son diferentes.
reasonDesc	AutomaticTuningDisabledReason	Descripción del motivo si el estado deseado y real son diferentes.

DatabaseAutomaticTuning

Object

Ajuste automático de nivel de base de datos.

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.actualState	AutomaticTuningMode	Estado real del ajuste automático.
properties.desiredState	AutomaticTuningMode	Estado deseado de ajuste automático.
properties.options	<string,  AutomaticTuningOptions>	Definición de opciones de ajuste automático.
type	string	Tipo de recurso.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.