Database Automatic Tuning - Get

Dienst:: SQL Database

API-Version:: 2023-08-01

Ruft die automatische Optimierung einer Datenbank ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
serverName	path	True	string	Der Name des Servers.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	DatabaseAutomaticTuning	Die Eigenschaften für die automatische Optimierung der Datenbank wurden erfolgreich abgerufen.
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 FeatureDisabledOnSelectedEdition – Der Benutzer hat versucht, ein Feature zu verwenden, das in der aktuellen Datenbankedition deaktiviert ist. 400 InvalidIdentifier – Der Bezeichner enthält NULL oder ein ungültiges Unicode-Zeichen. 400 SystemDatabasesNotSupported – Der Benutzer hat versucht, automatische Optimierungsinformationen für Systemdatenbanken zu erhalten. 400 DataWarehouseNotSupported – Automatische Optimierung wird für SQL Data Warehouse nicht unterstützt. 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden. 404 DatabaseDoesNotExist - Die angeforderte Datenbank wurde nicht gefunden. 404 SubscriptionDoesNotHaveElasticPool - Der angeforderte elastische Pool wurde nicht gefunden. 404 OperationIdNotFound – Der Vorgang mit der ID ist nicht vorhanden. 405 NotSupported – Diese Funktionalität wird nicht unterstützt. 409 Konflikt – Die Anforderung konnte aufgrund eines Konflikts in der Anforderung nicht verarbeitet werden. 409 CannotCancelOperation – Der Verwaltungsvorgang befindet sich in einem Zustand, der nicht abgebrochen werden kann. 409 OperationCancelled – Der Vorgang wurde vom Benutzer abgebrochen. 409 OperationInterrupted – Der Vorgang für die Ressource konnte nicht abgeschlossen werden, weil er durch einen anderen Vorgang in derselben Ressource unterbrochen wurde. 429 SubscriptionTooManyCreateUpdateRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 429 SubscriptionTooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können. 500 OperationTimedOut – Timeout des Vorgangs und automatisches Zurücksetzen. Versuchen Sie den Vorgang erneut. 503 ServiceTemporarilyUnavailable - Feature vorübergehend nicht verfügbar. 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

Name

Typ

Beschreibung

200 OK

DatabaseAutomaticTuning

Die Eigenschaften für die automatische Optimierung der Datenbank wurden erfolgreich abgerufen.

Other Status Codes

ErrorResponse

Fehlerantworten: ***

400 FeatureDisabledOnSelectedEdition – Der Benutzer hat versucht, ein Feature zu verwenden, das in der aktuellen Datenbankedition deaktiviert ist.
400 InvalidIdentifier – Der Bezeichner enthält NULL oder ein ungültiges Unicode-Zeichen.
400 SystemDatabasesNotSupported – Der Benutzer hat versucht, automatische Optimierungsinformationen für Systemdatenbanken zu erhalten.
400 DataWarehouseNotSupported – Automatische Optimierung wird für SQL Data Warehouse nicht unterstützt.
404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden.
404 DatabaseDoesNotExist - Die angeforderte Datenbank wurde nicht gefunden.
404 SubscriptionDoesNotHaveElasticPool - Der angeforderte elastische Pool wurde nicht gefunden.
404 OperationIdNotFound – Der Vorgang mit der ID ist nicht vorhanden.
405 NotSupported – Diese Funktionalität wird nicht unterstützt.
409 Konflikt – Die Anforderung konnte aufgrund eines Konflikts in der Anforderung nicht verarbeitet werden.
409 CannotCancelOperation – Der Verwaltungsvorgang befindet sich in einem Zustand, der nicht abgebrochen werden kann.
409 OperationCancelled – Der Vorgang wurde vom Benutzer abgebrochen.
409 OperationInterrupted – Der Vorgang für die Ressource konnte nicht abgeschlossen werden, weil er durch einen anderen Vorgang in derselben Ressource unterbrochen wurde.
429 SubscriptionTooManyCreateUpdateRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.
429 SubscriptionTooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.
500 OperationTimedOut – Timeout des Vorgangs und automatisches Zurücksetzen. Versuchen Sie den Vorgang erneut.
503 ServiceTemporarilyUnavailable - Feature vorübergehend nicht verfügbar.
503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

Get a database's automatic tuning settings

GET 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

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/DatabaseAutomaticTuningGet.json
// this example is just showing the usage of "DatabaseAutomaticTuning_Get" 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
SqlDatabaseAutomaticTuningResource result = await sqlDatabaseAutomaticTuning.GetAsync();

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
AutomaticTuningDisabledReason	Die Beschreibung des Grundes bei Bedarf und der tatsächliche Zustand unterscheiden sich.
AutomaticTuningMode	Gewünschter Zustand der automatischen Optimierung.
AutomaticTuningOptionModeActual	Ist-Zustand der Automatischen Optimierungsoption.
AutomaticTuningOptionModeDesired	Gewünschter Zustand der automatischen Optimierungsoption.
AutomaticTuningOptions	Automatische Optimierungseigenschaften für einzelne Berater.
DatabaseAutomaticTuning	Automatische Optimierung auf Datenbankebene.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort

AutomaticTuningDisabledReason

Enumeration

Die Beschreibung des Grundes bei Bedarf und der tatsächliche Zustand unterscheiden sich.

Wert	Beschreibung
Default
Disabled
AutoConfigured
InheritedFromServer
QueryStoreOff
QueryStoreReadOnly
NotSupported

AutomaticTuningMode

Enumeration

Gewünschter Zustand der automatischen Optimierung.

Wert	Beschreibung
Inherit
Custom
Auto
Unspecified

AutomaticTuningOptionModeActual

Enumeration

Ist-Zustand der Automatischen Optimierungsoption.

Wert	Beschreibung
Off
On

AutomaticTuningOptionModeDesired

Enumeration

Gewünschter Zustand der automatischen Optimierungsoption.

Wert	Beschreibung
Off
On
Default

AutomaticTuningOptions

Objekt

Automatische Optimierungseigenschaften für einzelne Berater.

Name	Typ	Beschreibung
actualState	AutomaticTuningOptionModeActual	Ist-Zustand der Automatischen Optimierungsoption.
desiredState	AutomaticTuningOptionModeDesired	Gewünschter Zustand der automatischen Optimierungsoption.
reasonCode	integer (int32)	Der Grundcode ist bei Bedarf und tatsächlicher Zustand unterschiedlich.
reasonDesc	AutomaticTuningDisabledReason	Die Beschreibung des Grundes bei Bedarf und der tatsächliche Zustand unterscheiden sich.