Managed Instances - List By Managed Instance

Service:: SQL Database

Version d’API:: 2025-01-01

Obtenez les principales requêtes consommatrices de ressources d’une instance managée.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/topqueries?api-version=2025-01-01

Avec des paramètres facultatifs:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/topqueries?api-version=2025-01-01&numberOfQueries={numberOfQueries}&databases={databases}&startTime={startTime}&endTime={endTime}&interval={interval}&aggregationFunction={aggregationFunction}&observationMetric={observationMetric}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
managedInstanceName	path	True	string	Nom de l’instance managée.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
aggregationFunction	query		AggregationFunctionType	Fonction d’agrégation à utiliser, la valeur par défaut est « sum »
databases	query		string	Liste séparée par des virgules des bases de données à inclure dans la recherche. Toutes les bases de données sont incluses si ce paramètre n’est pas spécifié.
endTime	query		string	Heure de fin de la période observée.
interval	query		QueryTimeGrainType	Étape de temps à utiliser pour résumer les valeurs de métriques. La valeur par défaut est PT1H
numberOfQueries	query		integer (int32)	Nombre de « requêtes principales » à retourner. La valeur par défaut est 5.
observationMetric	query		MetricType	Métrique à utiliser pour classer les principales requêtes. La valeur par défaut est « cpu »
startTime	query		string	Heure de début de la période observée.

Réponses

Nom	Type	Description
200 OK	TopQueriesListResult	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 d’Azure Active Directory.

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

Obtain list of instance's top resource consuming queries.

Obtain list of instance's top resource consuming queries. Full-blown request and response.

Obtain list of instance's top resource consuming queries. Minimal request and response.

Obtain list of instance's top resource consuming queries.

Exemple de requête

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/topqueries?api-version=2025-01-01&interval=PT1H&observationMetric=duration


import com.azure.resourcemanager.sql.models.MetricType;
import com.azure.resourcemanager.sql.models.QueryTimeGrainType;

/**
 * Samples for ManagedInstances ListByManagedInstance.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ManagedInstanceTopQueriesList.json
     */
    /**
     * Sample code: Obtain list of instance's top resource consuming queries.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void
        obtainListOfInstanceSTopResourceConsumingQueries(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getManagedInstances().listByManagedInstance("sqlcrudtest-7398", "sqlcrudtest-4645",
            null, null, null, null, QueryTimeGrainType.PT1H, null, MetricType.DURATION,
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python managed_instance_top_queries_list.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 = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.managed_instances.list_by_managed_instance(
        resource_group_name="sqlcrudtest-7398",
        managed_instance_name="sqlcrudtest-4645",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/ManagedInstanceTopQueriesList.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

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get top resource consuming queries of a managed instance.
 *
 * @summary get top resource consuming queries of a managed instance.
 * x-ms-original-file: 2025-01-01/ManagedInstanceTopQueriesList.json
 */
async function obtainListOfInstanceTopResourceConsumingQueries() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.managedInstances.listByManagedInstance(
    "sqlcrudtest-7398",
    "sqlcrudtest-4645",
    { interval: "PT1H", observationMetric: "duration" },
  )) {
    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

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/SQL/stable/2025-01-01/examples/ManagedInstanceTopQueriesList.json
// this example is just showing the usage of "ManagedInstances_ListByManagedInstance" 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 ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string managedInstanceName = "sqlcrudtest-4645";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// invoke the operation and iterate over the result
ManagedInstanceResourceGetTopQueriesOptions options = new ManagedInstanceResourceGetTopQueriesOptions { Interval = QueryTimeGrainType.PT1H, ObservationMetric = SqlMetricType.Duration };
await foreach (TopQueries item in managedInstance.GetTopQueriesAsync(options))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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": [
    {
      "aggregationFunction": "sum",
      "endTime": "03/05/2020 13:00:00",
      "intervalType": "P1D",
      "numberOfQueries": 5,
      "observationMetric": "cpu",
      "queries": [
        {
          "databaseName": "db1",
          "intervals": [
            {
              "executionCount": 1,
              "intervalStartTime": "03/03/2020 00:00:00",
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0015841714409722222
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 4.340277777777778E-06
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 8336
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 11306905
                }
              ]
            }
          ],
          "queryId": "25"
        },
        {
          "databaseName": "db1",
          "intervals": [
            {
              "executionCount": 1,
              "intervalStartTime": "03/03/2020 00:00:00",
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0009521432291666667
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 2.3148148148148148E-07
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 1024
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 6620020
                }
              ]
            }
          ],
          "queryId": "21"
        },
        {
          "databaseName": "db3",
          "intervals": [
            {
              "executionCount": 104,
              "intervalStartTime": "03/04/2020 00:00:00",
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0008006611689814815
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 0
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 5543088
                }
              ]
            }
          ],
          "queryId": "3"
        },
        {
          "databaseName": "db2",
          "intervals": [
            {
              "executionCount": 89,
              "intervalStartTime": "03/03/2020 00:00:00",
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0006882543402777778
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 0
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 4761877
                }
              ]
            }
          ],
          "queryId": "3"
        },
        {
          "databaseName": "db3",
          "intervals": [
            {
              "executionCount": 1,
              "intervalStartTime": "03/04/2020 00:00:00",
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0006220661168981482
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 1024
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 4454161
                }
              ]
            }
          ],
          "queryId": "22"
        }
      ],
      "startTime": "03/01/2020 00:00:00"
    }
  ]
}

Obtain list of instance's top resource consuming queries. Full-blown request and response.

Exemple de requête

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/topqueries?api-version=2025-01-01&databases=db1,db2&startTime=2020-03-10T12:00:00Z&endTime=2020-03-12T12:00:00Z&interval=P1D&observationMetric=cpu


import com.azure.resourcemanager.sql.models.MetricType;
import com.azure.resourcemanager.sql.models.QueryTimeGrainType;

/**
 * Samples for ManagedInstances ListByManagedInstance.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ManagedInstanceTopQueriesListMax.json
     */
    /**
     * Sample code: Obtain list of instance's top resource consuming queries. Full-blown request and response.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void obtainListOfInstanceSTopResourceConsumingQueriesFullBlownRequestAndResponse(
        com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getManagedInstances().listByManagedInstance("sqlcrudtest-7398", "sqlcrudtest-4645",
            null, "db1,db2", "2020-03-10T12:00:00Z", "2020-03-12T12:00:00Z", QueryTimeGrainType.P1D, null,
            MetricType.CPU, 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python managed_instance_top_queries_list_max.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 = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.managed_instances.list_by_managed_instance(
        resource_group_name="sqlcrudtest-7398",
        managed_instance_name="sqlcrudtest-4645",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/ManagedInstanceTopQueriesListMax.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

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get top resource consuming queries of a managed instance.
 *
 * @summary get top resource consuming queries of a managed instance.
 * x-ms-original-file: 2025-01-01/ManagedInstanceTopQueriesListMax.json
 */
async function obtainListOfInstanceTopResourceConsumingQueriesFullBlownRequestAndResponse() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.managedInstances.listByManagedInstance(
    "sqlcrudtest-7398",
    "sqlcrudtest-4645",
    {
      databases: "db1,db2",
      startTime: "2020-03-10T12:00:00Z",
      endTime: "2020-03-12T12:00:00Z",
      interval: "P1D",
      observationMetric: "cpu",
    },
  )) {
    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

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/SQL/stable/2025-01-01/examples/ManagedInstanceTopQueriesListMax.json
// this example is just showing the usage of "ManagedInstances_ListByManagedInstance" 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 ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string managedInstanceName = "sqlcrudtest-4645";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// invoke the operation and iterate over the result
ManagedInstanceResourceGetTopQueriesOptions options = new ManagedInstanceResourceGetTopQueriesOptions { Databases = "db1,db2", StartTime = "2020-03-10T12:00:00Z", EndTime = "2020-03-12T12:00:00Z", Interval = QueryTimeGrainType.P1D, ObservationMetric = SqlMetricType.Cpu };
await foreach (TopQueries item in managedInstance.GetTopQueriesAsync(options))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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": [
    {
      "aggregationFunction": "sum",
      "endTime": "03/12/2020 13:00:00",
      "intervalType": "P1D",
      "numberOfQueries": 5,
      "observationMetric": "cpu",
      "queries": [
        {
          "databaseName": "db1",
          "intervals": [
            {
              "executionCount": 1,
              "intervalStartTime": "03/11/2020 00:00:00",
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0015934667245370371
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 4.224537037037037E-06
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 8336
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 11091296
                }
              ]
            }
          ],
          "queryId": "28"
        },
        {
          "databaseName": "db1",
          "intervals": [
            {
              "executionCount": 1,
              "intervalStartTime": "03/11/2020 00:00:00",
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0009522783564814815
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 1.7361111111111112E-07
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 1024
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 6625562
                }
              ]
            }
          ],
          "queryId": "24"
        },
        {
          "databaseName": "db1",
          "intervals": [
            {
              "executionCount": 82,
              "intervalStartTime": "03/11/2020 00:00:00",
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0007183139467592593
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 0
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 4970199
                }
              ]
            }
          ],
          "queryId": "3"
        },
        {
          "databaseName": "db1",
          "intervals": [
            {
              "executionCount": 1,
              "intervalStartTime": "03/11/2020 00:00:00",
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0006494454571759259
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 5.034722222222222E-06
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 1024
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 4530668
                }
              ]
            }
          ],
          "queryId": "29"
        },
        {
          "databaseName": "db2",
          "intervals": [
            {
              "executionCount": 1,
              "intervalStartTime": "03/11/2020 00:00:00",
              "metrics": [
                {
                  "name": "cpu",
                  "displayName": "Cpu",
                  "unit": "percentage",
                  "value": 0.0006275368923611112
                },
                {
                  "name": "io",
                  "displayName": "Physical Io Reads",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "logIo",
                  "displayName": "Log Writes",
                  "unit": "percentage",
                  "value": 0
                },
                {
                  "name": "memory",
                  "displayName": "Memory consumption",
                  "unit": "KB",
                  "value": 1024
                },
                {
                  "name": "duration",
                  "displayName": "Query duration",
                  "unit": "microseconds",
                  "value": 4349943
                }
              ]
            }
          ],
          "queryId": "25"
        }
      ],
      "startTime": "03/10/2020 00:00:00"
    }
  ]
}

Obtain list of instance's top resource consuming queries. Minimal request and response.

Exemple de requête

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/topqueries?api-version=2025-01-01


/**
 * Samples for ManagedInstances ListByManagedInstance.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ManagedInstanceTopQueriesListMin.json
     */
    /**
     * Sample code: Obtain list of instance's top resource consuming queries. Minimal request and response.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void obtainListOfInstanceSTopResourceConsumingQueriesMinimalRequestAndResponse(
        com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getManagedInstances().listByManagedInstance("sqlcrudtest-7398", "sqlcrudtest-4645",
            null, null, null, null, null, null, null, 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python managed_instance_top_queries_list_min.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 = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.managed_instances.list_by_managed_instance(
        resource_group_name="sqlcrudtest-7398",
        managed_instance_name="sqlcrudtest-4645",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/ManagedInstanceTopQueriesListMin.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

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get top resource consuming queries of a managed instance.
 *
 * @summary get top resource consuming queries of a managed instance.
 * x-ms-original-file: 2025-01-01/ManagedInstanceTopQueriesListMin.json
 */
async function obtainListOfInstanceTopResourceConsumingQueriesMinimalRequestAndResponse() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.managedInstances.listByManagedInstance(
    "sqlcrudtest-7398",
    "sqlcrudtest-4645",
  )) {
    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

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/SQL/stable/2025-01-01/examples/ManagedInstanceTopQueriesListMin.json
// this example is just showing the usage of "ManagedInstances_ListByManagedInstance" 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 ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string managedInstanceName = "sqlcrudtest-4645";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// invoke the operation and iterate over the result
ManagedInstanceResourceGetTopQueriesOptions options = new ManagedInstanceResourceGetTopQueriesOptions();
await foreach (TopQueries item in managedInstance.GetTopQueriesAsync(options))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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": [
    {
      "aggregationFunction": "sum",
      "endTime": "03/11/2020 12:24:07",
      "intervalType": "PT1H",
      "numberOfQueries": 5,
      "observationMetric": "cpu",
      "queries": [],
      "startTime": "03/10/2020 12:00:00"
    }
  ]
}

Définitions

Nom	Description
AggregationFunctionType	Fonction d’agrégation à utiliser, la valeur par défaut est « sum »
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
MetricType	Métrique à utiliser pour classer les principales requêtes. La valeur par défaut est « cpu »
QueryMetricInterval	Propriétés d’un intervalle de métriques de requête.
QueryMetricProperties	Propriétés d’une métrique topquery dans un intervalle.
QueryMetricUnitType	Unité de la métrique.
QueryStatisticsProperties	Propriétés d’une statistique d’exécution de requête.
QueryTimeGrainType	Type d’intervalle (longueur).
TopQueries
TopQueriesListResult	Liste des principales requêtes consommatrices de ressources sur une instance managée

AggregationFunctionType

Énumération

Fonction d’agrégation à utiliser, la valeur par défaut est « sum »

Valeur	Description
avg	avg
min	min
max	max
stdev	stdev
sum	sum

ErrorAdditionalInfo

Objet

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

Objet

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

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

MetricType

Énumération

Métrique à utiliser pour classer les principales requêtes. La valeur par défaut est « cpu »

Valeur	Description
cpu	cpu
io	Io
logIo	logIo
duration	durée
dtu	dtu

QueryMetricInterval

Objet

Propriétés d’un intervalle de métriques de requête.

Nom	Type	Description
executionCount	integer (int64)	Nombre d’exécutions d’une requête dans cet intervalle.
intervalStartTime	string	Heure de début de l’intervalle de métrique (format ISO-8601).
intervalType	QueryTimeGrainType	Type d’intervalle (longueur).
metrics	QueryMetricProperties[]	Liste des objets de métrique pour cet intervalle

QueryMetricProperties

Objet

Propriétés d’une métrique topquery dans un intervalle.

Nom	Type	Description
avg	number (double)	Valeur de métrique lorsque la fonction d’agrégation avg() est utilisée au cours de l’intervalle.
displayName	string	Nom approprié de l’interface utilisateur pour la métrique.
max	number (double)	Valeur de métrique lorsque la fonction d’agrégation max() est utilisée au cours de l’intervalle.
min	number (double)	Valeur de métrique lorsque la fonction d’agrégation min() est utilisée au cours de l’intervalle.
name	string	Informations de nom pour la métrique.
stdev	number (double)	Valeur de métrique lorsque la fonction d’agrégation stdev est utilisée au cours de l’intervalle.
sum	number (double)	Valeur de métrique lorsque la fonction d’agrégation sum() est utilisée sur l’intervalle.
unit	QueryMetricUnitType	Unité de la métrique.
value	number (double)	Valeur de la métrique.

QueryMetricUnitType

Énumération

Unité de la métrique.

Valeur	Description
percentage	pourcentage
KB	Ko
microseconds	Microsecondes
count	count

QueryStatisticsProperties

Objet

Propriétés d’une statistique d’exécution de requête.

Nom	Type	Description
databaseName	string	Nom de la base de données dans laquelle cette requête a été exécutée.
endTime	string	Heure de fin de la métrique (format ISO-8601).
intervals	QueryMetricInterval[]	Liste des intervalles avec les données de métrique appropriées
queryId	string	ID de requête unique (unique dans une base de données).
startTime	string	Heure de début de la métrique (format ISO-8601).

QueryTimeGrainType

Énumération

Type d’intervalle (longueur).

Valeur	Description
PT1H	PT1H
P1D	P1D

TopQueries

Objet

Nom	Type	Description
aggregationFunction	string	Fonction d’agrégation utilisée pour calculer les métriques de requête.
endTime	string	Heure de fin de la métrique (format ISO-8601).
intervalType	QueryTimeGrainType	Type d’intervalle (longueur).
numberOfQueries	integer (int32)	Nombre de requêtes principales demandées.
observationMetric	string	Métrique utilisée pour classer les requêtes.
queries	QueryStatisticsProperties[]	Liste des principales requêtes consommatrices de ressources avec les données de métrique appropriées
startTime	string	Heure de début de la métrique (format ISO-8601).

TopQueriesListResult

Objet

Liste des principales requêtes consommatrices de ressources sur une instance managée

Nom	Type	Description
nextLink	string (uri)	Lien vers la page suivante des éléments
value	TopQueries[]	Les éléments TopQueries sur cette page