Syntaxe du filtre d’API REST Azure Monitor

De nombreuses API Azure Monitor prennent un paramètre, {filter-expression}, que vous pouvez utiliser pour filtrer ou contraindre l’ensemble des données collectées.

Utilisation du filtre '*' dans la demande de plusieurs ressources

Important

Le 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. Le * est utilisé pour demander plusieurs ressources dans une seule série chronologique.

Dans l’exemple ci-dessous $filter=Microsoft.ResourceId eq '*' , l’API 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 des machines virtuelles dans la série chronologique spécifiée, la série timeseries:[] chronologique vide est renvoyée car il n’y a pas de résultats pour l’ensemble de dimension demandé qui inclut ResourceId
La même requête sans le filtre renverra une seule série chronologique renvoyant une moyenne agrégée de CPU = 0 pour toutes les machines virtuelles, car il s’agit de la somme de 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 d’utilisation $filter

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

• Répertorier les événements d’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 'Admin, Operation' et resourceGroupName eq 'CloudLab'

• Répertorier les événements d’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 'Admin, Operation' et resourceUri eq '/subscriptions/089bd33f-d4ec-47fe-8ba5-0753aa5c5b33/resourcegroups/CloudLab/providers/Microsoft.Web/sites/mytestweb004'

• Répertorier les événements d’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 'Admin, Operation'

• Répertorier les événements d’un fournisseur de ressources 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 'Admin, Operation' et 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 'Admin, Operation' et correlationId eq '07c85493-5e87-4efd-9200-0c64d904d878'