Server Automatic Tuning - Get

Tjänst:: SQL Database

API-version:: 2023-08-01

Hämtar alternativ för automatisk justering av servern.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string	Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.

Svar

Name	Typ	Description
200 OK	ServerAutomaticTuning	Egenskaper för automatisk justering av servern har hämtats.
Other Status Codes	ErrorResponse	Felsvar: *** 400 FeatureDisabledOnSelectedEdition – Användaren försökte använda en funktion som är inaktiverad i den aktuella databasutgåvan. 400 InvalidIdentifier – Identifieraren innehåller NULL eller ett ogiltigt unicode-tecken. 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte 404 DatabaseDoesNotExist – Den begärda databasen hittades inte 404 SubscriptionDoesNotHaveElasticPool – Den begärda elastiska poolen hittades inte 404 OperationIdNotFound – Åtgärden med ID finns inte. 405 Stöds inte – den här funktionen stöds inte. 409 Konflikt – Begäran kunde inte bearbetas på grund av en konflikt i begäran. 409 CannotCancelOperation – hanteringsåtgärden är i ett tillstånd som inte kan avbrytas. 409 OperationCancelled – Åtgärden har avbrutits av användaren. 409 Åtgärd avbröts – Det gick inte att slutföra åtgärden på resursen eftersom den avbröts av en annan åtgärd på samma resurs. 429 SubscriptionTooManyCreateUpdateRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser. 429 SubscriptionTooManyRequests – Begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser. 500 OperationTimedOut – Tidsgränsen för åtgärden uppnåddes och återställdes automatiskt. Försök igen. 503 ServiceTemporarilyUnavailable – Funktionen är inte tillgänglig för tillfället. 503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Name

Typ

Description

200 OK

ServerAutomaticTuning

Egenskaper för automatisk justering av servern har hämtats.

Other Status Codes

ErrorResponse

Felsvar: ***

400 FeatureDisabledOnSelectedEdition – Användaren försökte använda en funktion som är inaktiverad i den aktuella databasutgåvan.
400 InvalidIdentifier – Identifieraren innehåller NULL eller ett ogiltigt unicode-tecken.
404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte
404 DatabaseDoesNotExist – Den begärda databasen hittades inte
404 SubscriptionDoesNotHaveElasticPool – Den begärda elastiska poolen hittades inte
404 OperationIdNotFound – Åtgärden med ID finns inte.
405 Stöds inte – den här funktionen stöds inte.
409 Konflikt – Begäran kunde inte bearbetas på grund av en konflikt i begäran.
409 CannotCancelOperation – hanteringsåtgärden är i ett tillstånd som inte kan avbrytas.
409 OperationCancelled – Åtgärden har avbrutits av användaren.
409 Åtgärd avbröts – Det gick inte att slutföra åtgärden på resursen eftersom den avbröts av en annan åtgärd på samma resurs.
429 SubscriptionTooManyCreateUpdateRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.
429 SubscriptionTooManyRequests – Begäranden utöver maxbegäranden som kan bearbetas av tillgängliga resurser.
500 OperationTimedOut – Tidsgränsen för åtgärden uppnåddes och återställdes automatiskt. Försök igen.
503 ServiceTemporarilyUnavailable – Funktionen är inte tillgänglig för tillfället.
503 TooManyRequests – Begäranden utöver maximalt antal begäranden som kan bearbetas av tillgängliga resurser.

Exempel

Get a server's automatic tuning settings

GET https://management.azure.com/subscriptions/c3aa9078-0000-0000-0000-e36f151182d7/resourceGroups/default-sql-onebox/providers/Microsoft.Sql/servers/testsvr11/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/ServerAutomaticTuningGet.json
// this example is just showing the usage of "ServerAutomaticTuning_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://free.blessedness.top/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 SqlServerAutomaticTuningResource created on azure
// for more information of creating SqlServerAutomaticTuningResource, please refer to the document of SqlServerAutomaticTuningResource
string subscriptionId = "c3aa9078-0000-0000-0000-e36f151182d7";
string resourceGroupName = "default-sql-onebox";
string serverName = "testsvr11";
ResourceIdentifier sqlServerAutomaticTuningResourceId = SqlServerAutomaticTuningResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerAutomaticTuningResource sqlServerAutomaticTuning = client.GetSqlServerAutomaticTuningResource(sqlServerAutomaticTuningResourceId);

// invoke the operation
SqlServerAutomaticTuningResource result = await sqlServerAutomaticTuning.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
SqlServerAutomaticTuningData 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

Exempelsvar

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

Definitioner

Name	Description
AutomaticTuningOptionModeActual	Verkligt tillstånd för automatisk justeringsalternativ.
AutomaticTuningOptionModeDesired	Önskat tillstånd för alternativ för automatisk justering.
AutomaticTuningServerMode	Automatiskt justera önskat tillstånd.
AutomaticTuningServerOptions	Egenskaper för automatisk justering för enskilda rådgivare.
AutomaticTuningServerReason	Orsaksbeskrivning om önskat och faktiskt tillstånd skiljer sig.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ServerAutomaticTuning	Automatisk justering på servernivå.

AutomaticTuningOptionModeActual

Uppräkning

Verkligt tillstånd för automatisk justeringsalternativ.

Värde	Description
Off
On

AutomaticTuningOptionModeDesired

Uppräkning

Önskat tillstånd för alternativ för automatisk justering.

Värde	Description
Off
On
Default

AutomaticTuningServerMode

Uppräkning

Automatiskt justera önskat tillstånd.

Värde	Description
Custom
Auto
Unspecified

AutomaticTuningServerOptions

Objekt

Egenskaper för automatisk justering för enskilda rådgivare.

Name	Typ	Description
actualState	AutomaticTuningOptionModeActual	Verkligt tillstånd för automatisk justeringsalternativ.
desiredState	AutomaticTuningOptionModeDesired	Önskat tillstånd för alternativ för automatisk justering.
reasonCode	integer (int32)	Orsakskod om önskat och faktiskt tillstånd skiljer sig.
reasonDesc	AutomaticTuningServerReason	Orsaksbeskrivning om önskat och faktiskt tillstånd skiljer sig.

AutomaticTuningServerReason

Uppräkning

Orsaksbeskrivning om önskat och faktiskt tillstånd skiljer sig.

Värde	Description
Default
Disabled
AutoConfigured

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.