Syntaxe du filtre d’API REST Azure Monitor

  • Article

De nombreuses API Azure Monitor prennent un paramètre, {filter-expression}, que vous pouvez utiliser pour filtrer ou limiter le jeu de données qui est collecté.

Utilisation du filtre « * » dans la demande de plusieurs ressources

Important

Le * dans un filtre pour plusieurs ressources n’est pas un caractère générique. Il s’agit d’une chaîne littérale utilisée pour demander plusieurs ressources. Est * utilisé pour demander plusieurs ressources dans une même série chronologique.

Dans l’exemple ci-dessous $filter=Microsoft.ResourceId eq '*' , indique à l’API de retourner une série chronologique distincte par ressource de machine virtuelle dans l’abonnement et la région. Sans le filtre, l’API retournerait une seule série chronologique agrégeant le processeur moyen pour toutes les machines virtuelles. La série chronologique de chaque ressource est différenciée par la valeur de métadonnées Microsoft.ResourceId sur chaque entrée de série chronologique.

Si vous utilisez $filter=Microsoft.ResourceId eq '*' et qu’il n’y a pas de ressources, dans ce cas, les machines virtuelles dans la série chronologique spécifiée, la série timeseries:[] chronologique vide est retournée, car il n’y a aucun résultat pour le jeu de dimension demandé qui inclut ResourceId
La même requête sans le filtre retourne une seule série chronologique retournant un processeur moyen agrégé = 0 pour toutes les machines virtuelles, car il s’agit de la somme sur toutes les dimensions demandées.

GET https://management.azure.com/subscriptions/12345678-abcd-98765432-abcdef012345/providers/microsoft.Insights/metrics?timespan=2023-06-25T22:20:00.000Z/2023-06-26T22:25:00.000Z&interval=PT5M&metricnames=Percentage CPU&aggregation=average&api-version=2021-05-01&region=eastus&metricNamespace=microsoft.compute/virtualmachines&$filter=Microsoft.ResourceId eq '*'

Exemple utilisant $filter

Voici les chaînes d’expression possibles que vous pouvez passer en tant que {filter-expression}. Aucune autre syntaxe n'est autorisée.

  • Liste des événements pour un groupe de ressources

    $filter=eventTimestamp ge <Start Time> and eventTimestamp le <End Time> and eventChannels eq 'Admin, Operation' and resourceGroupName eq '<ResourceGroupName>'

    Exemple :

    $filter=eventTimestamp ge 2014-12-29T22 :00 :37Z et eventTimestamp le 2014-12-29T23 :36 :37Z et eventChannels eq 'Administration, Operation' and resourceGroupName eq 'CloudLab'

  • Liste des événements pour une ressource

    $filter=eventTimestamp ge <Start Time> and eventTimestamp le <End Time> and eventChannels eq 'Admin, Operation' and resourceUri eq '<ResourceURI>'

    Exemple :

    $filter=eventTimestamp ge 2014-12-29T22 :00 :37Z et eventTimestamp le 2014-12-29T23 :36 :37Z et eventChannels eq 'Administration, Operation' and resourceUri eq '/subscriptions/089bd33f-d4ec-47fe-8ba5-0753aa5c5b33/resourcegroups/CloudLab/providers/Microsoft.Web/sites/mytestweb004'

  • Liste des événements pour un abonnement Azure

    $filter=eventTimestamp ge <Start Time> and eventTimestamp le <End Time> and eventChannels eq 'Admin, Operation'

    Exemple :

    $filter=eventTimestamp ge 2014-12-29T22 :00 :37Z et eventTimestamp le 2014-12-29T23 :36 :37Z et eventChannels eq 'Administration, Operation'

  • Liste des événements pour un fournisseur de ressource Azure

    $filter=eventTimestamp ge <Start Time> and eventTimestamp le <End Time> and eventChannels eq 'Admin, Operation' and resourceProvider eq '<ResourceProviderName>'

    Exemple :

    $filter=eventTimestamp ge 2014-12-29T22 :00 :37Z et eventTimestamp le 2014-12-29T23 :36 :37Z et eventChannels eq 'Administration, Operation' and resourceProvider eq 'Microsoft.Web'

  • Répertorier les événements d’un ID de corrélation

    api-version=2014-04-01&$filter=eventTimestamp ge 2014-07-16T04:36:37.6407898Z and eventTimestamp le 2014-07-20T04:36:37.6407898Z and eventChannels eq 'Admin, Operation' and correlationId eq '<CorrelationID>'

    Exemple : api-version=2014-04-01&$filter=eventTimestamp ge 2014-12-29T22 :00 :37Z et eventTimestamp le 2014-12-29T23 :36 :37Z et eventChannels eq 'Administration, Operation' and correlationId eq '07c85493-5e87-4efd-9200-0c64d904d878'