Autonomous Tuning (Configuration) - List Sessions

Service:

PostgreSQL

Version d'API:

2025-01-01-preview

Affiche l’état de la session de réglage de la configuration.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/tuningOptions/{tuningOption}/sessions?api-version=2025-01-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	Le nom du serveur
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
tuningOption	path	True	TuningOptionEnum	Nom de l’option de réglage.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	SessionsListResult	Ok
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux Microsoft Entra OAuth2

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

TuningConfiguration_ListSessions

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/tuningOptions/configuration/sessions?api-version=2025-01-01-preview

Java

import com.azure.resourcemanager.postgresqlflexibleserver.models.TuningOptionEnum;

/**
 * Samples for TuningConfiguration ListSessions.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/examples/
     * TuningConfiguration_ListSessions.json
     */
    /**
     * Sample code: TuningConfiguration_ListSessions.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void
        tuningConfigurationListSessions(com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.tuningConfigurations().listSessions("testrg", "testserver", TuningOptionEnum.CONFIGURATION,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python tuning_configuration_list_sessions.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.tuning_configuration.list_sessions(
        resource_group_name="testrg",
        server_name="testserver",
        tuning_option="configuration",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/examples/TuningConfiguration_ListSessions.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armpostgresqlflexibleservers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresqlflexibleservers/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b1f4d539964453ce8008e4b069e59885e12ba441/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/examples/TuningConfiguration_ListSessions.json
func ExampleTuningConfigurationClient_NewListSessionsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewTuningConfigurationClient().NewListSessionsPager("testrg", "testserver", armpostgresqlflexibleservers.TuningOptionEnumConfiguration, nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SessionsListResult = armpostgresqlflexibleservers.SessionsListResult{
		// 	Value: []*armpostgresqlflexibleservers.SessionResource{
		// 		{
		// 			PostTuningAqr: to.Ptr("1.818203395454569"),
		// 			PostTuningTps: to.Ptr("2.594203762997024"),
		// 			PreTuningAqr: to.Ptr("1.9069379374999662"),
		// 			PreTuningTps: to.Ptr("2.592924534523614"),
		// 			SessionID: to.Ptr("29f70be5-74ac-498b-949c-38b0997b4290"),
		// 			SessionStartTime: to.Ptr("09/26/2024 02:13:05"),
		// 			Status: to.Ptr("completed"),
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets up the config tuning session status.
 *
 * @summary Gets up the config tuning session status.
 * x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/examples/TuningConfiguration_ListSessions.json
 */
async function tuningConfigurationListSessions() {
  const subscriptionId =
    process.env["POSTGRESQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["POSTGRESQL_RESOURCE_GROUP"] || "testrg";
  const serverName = "testserver";
  const tuningOption = "configuration";
  const credential = new DefaultAzureCredential();
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.tuningConfiguration.listSessions(
    resourceGroupName,
    serverName,
    tuningOption,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

{
  "value": [
    {
      "sessionStartTime": "2025-01-01T18:35:22.123456Z",
      "sessionId": "29f70be5-74ac-498b-949c-38b0997b4290",
      "status": "completed",
      "preTuningAqr": "1.9069379374999662",
      "postTuningAqr": "1.818203395454569",
      "preTuningTps": "2.592924534523614",
      "postTuningTps": "2.594203762997024"
    }
  ]
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
SessionResource	Propriétés de la ressource de session.
SessionsListResult	Liste des sessions de configuration de réglage.
TuningOptionEnum	Nom de l’option de réglage.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

SessionResource

Object

Propriétés de la ressource de session.

Nom	Type	Description
postTuningAqr	string	Temps d’exécution moyen d’une requête une fois le réglage terminé.
postTuningTps	string	Transactions par seconde une fois le réglage terminé.
preTuningAqr	string	Temps moyen d’exécution d’une requête avant le début du réglage.
preTuningTps	string	Transactions par seconde avant le début du réglage.
sessionId	string	Identifiant de la session de réglage.
sessionStartTime	string	Heure de début de la session de réglage.
status	string	État de la session de réglage.

SessionsListResult

Object

Liste des sessions de configuration de réglage.

Nom	Type	Description
nextLink	string	Lien utilisé pour obtenir la page suivante de résultats.
value	SessionResource[]	Liste des sessions de configuration de réglage.

TuningOptionEnum

Énumération

Nom de l’option de réglage.

Valeur	Description
configuration
index