Server Automatic Tuning - Get

Serviço:: SQL Database

Versão da API:: 2023-08-01

Recupera as opções de ajuste automático do servidor.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID da assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Respostas

Nome	Tipo	Description
200 OK	ServerAutomaticTuning	Propriedades de ajuste automático do servidor recuperadas com êxito.
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 FeatureDisabledOnSelectedEdition – O usuário tentou usar um recurso que está desabilitado na edição atual do banco de dados. 400 InvalidIdentifier - O identificador contém NULL ou um caractere unicode inválido. 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado 404 DatabaseDoesNotExist – O banco de dados solicitado não foi encontrado 404 SubscriptionDoesNotHaveElasticPool – O pool elástico solicitado não foi encontrado 404 OperationIdNotFound – A operação com id não existe. 405 NotSupported – Não há suporte para essa funcionalidade. Conflito 409 – A solicitação não pôde ser processada devido ao conflito na solicitação. 409 CannotCancelOperation – A operação de gerenciamento está em um estado que não pode ser cancelado. 409 OperationCancelled – A operação foi cancelada pelo usuário. 409 OperationInterrupted – A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso. 429 SubscriptionTooManyCreateUpdateRequests – Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis. 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 500 OperationTimedOut – A operação atingiu o tempo limite e foi revertida automaticamente. Tente novamente a operação. 503 ServiceTemporarilyUnavailable – Recurso temporariamente indisponível. 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

Nome

Tipo

Description

200 OK

ServerAutomaticTuning

Propriedades de ajuste automático do servidor recuperadas com êxito.

Other Status Codes

ErrorResponse

Respostas de erro: ***

400 FeatureDisabledOnSelectedEdition – O usuário tentou usar um recurso que está desabilitado na edição atual do banco de dados.
400 InvalidIdentifier - O identificador contém NULL ou um caractere unicode inválido.
404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado
404 DatabaseDoesNotExist – O banco de dados solicitado não foi encontrado
404 SubscriptionDoesNotHaveElasticPool – O pool elástico solicitado não foi encontrado
404 OperationIdNotFound – A operação com id não existe.
405 NotSupported – Não há suporte para essa funcionalidade.
Conflito 409 – A solicitação não pôde ser processada devido ao conflito na solicitação.
409 CannotCancelOperation – A operação de gerenciamento está em um estado que não pode ser cancelado.
409 OperationCancelled – A operação foi cancelada pelo usuário.
409 OperationInterrupted – A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso.
429 SubscriptionTooManyCreateUpdateRequests – Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis.
429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.
500 OperationTimedOut – A operação atingiu o tempo limite e foi revertida automaticamente. Tente novamente a operação.
503 ServiceTemporarilyUnavailable – Recurso temporariamente indisponível.
503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

Exemplos

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

Resposta de exemplo

Código de status:: 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"
      }
    }
  }
}

Definições

Nome	Description
AutomaticTuningOptionModeActual	Estado real da opção de ajuste automático.
AutomaticTuningOptionModeDesired	Estado desejado da opção de ajuste automático.
AutomaticTuningServerMode	Ajuste automático do estado desejado.
AutomaticTuningServerOptions	Propriedades de ajuste automático para assistentes individuais.
AutomaticTuningServerReason	Descrição do motivo, se desejado e estado real são diferentes.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ServerAutomaticTuning	Ajuste automático no nível do servidor.

AutomaticTuningOptionModeActual

Enumeração

Estado real da opção de ajuste automático.

Valor	Description
Off
On

AutomaticTuningOptionModeDesired

Enumeração

Estado desejado da opção de ajuste automático.

Valor	Description
Off
On
Default

AutomaticTuningServerMode

Enumeração

Ajuste automático do estado desejado.

Valor	Description
Custom
Auto
Unspecified

AutomaticTuningServerOptions

Objeto

Propriedades de ajuste automático para assistentes individuais.

Nome	Tipo	Description
actualState	AutomaticTuningOptionModeActual	Estado real da opção de ajuste automático.
desiredState	AutomaticTuningOptionModeDesired	Estado desejado da opção de ajuste automático.
reasonCode	integer (int32)	Código de motivo se desejado e estado real são diferentes.
reasonDesc	AutomaticTuningServerReason	Descrição do motivo, se desejado e estado real são diferentes.

AutomaticTuningServerReason

Enumeração

Descrição do motivo, se desejado e estado real são diferentes.

Valor	Description
Default
Disabled
AutoConfigured

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.