Query - Resource Execute

Référence

Service:: Log Analytics

Version d'API:: 2022-10-27_Preview

Exécuter une requête Analytics à l’aide de l’ID de ressource
Exécute une requête Analytics pour les données dans le contexte d’une ressource. Voici un exemple d’utilisation de POST avec une requête Analytics.

POST https://api.loganalytics.io/v1/{resourceId}/query

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceId	path	True	string	Identificateur de la ressource.

En-tête de la demande

Nom	Obligatoire	Type	Description
Prefer		string	facultatif. L’en-tête prefer pour définir le délai d’expiration du serveur, les statistiques de requête et les informations de visualisation.

Corps de la demande

Nom	Obligatoire	Type	Description
query	True	string	Requête à exécuter.
timespan		string	facultatif. Intervalle de temps sur lequel interroger les données. Il s’agit d’une valeur de période ISO8601. Ce délai est appliqué en plus de ceux spécifiés dans l’expression de requête.
workspaces		string[]	Liste des espaces de travail inclus dans la requête.

Réponses

Nom	Type	Description
200 OK	queryResults	OK. L’appel d’API a réussi et le résultat de la requête Analytics se trouve dans la charge utile de réponse
Other Status Codes	errorResponse	Objet de réponse d’erreur.

Sécurité

oauth2

Flux OAuth2 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

simple-query

Exemple de requête

HTTP

POST https://api.loganalytics.io/v1//subscriptions/fffa080af-c2d8-40ad-9cce-e1a450bawb57/resourceGroups/test-resourcegroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/query

{
  "query": "StorageBlobLogs | summarize count() by OperationName | top 10 by count_ desc",
  "timespan": "PT24H"
}

Exemple de réponse

Code d’état:: 200

{
  "tables": [
    {
      "name": "PrimaryResult",
      "columns": [
        {
          "name": "OperationName",
          "type": "string"
        },
        {
          "name": "count_",
          "type": "long"
        }
      ],
      "rows": [
        [
          "operation1",
          "10"
        ]
      ]
    }
  ]
}

Définitions

Nom	Description
column	Colonne de table.
errorDetail	Détails de l’erreur.
errorInfo	Code et message d’une erreur.
errorResponse	Détails de l’erreur.
logsColumnType	Type de données de cette colonne.
queryBody	Requête Analytics. En savoir plus sur la syntaxe de requête Analytics
queryResults	Réponse à une requête.
Render	Données de visualisation au format JSON.
Statistics	Statistiques représentées au format JSON.
table	Table de réponse de requête.

column

Colonne de table.

Nom	Type	Description
name	string	Nom de cette colonne.
type	logsColumnType	Type de données de cette colonne.

errorDetail

Détails de l’erreur.

Nom	Type	Description
additionalProperties	object	Propriétés supplémentaires pouvant être fournies sur l’objet détails de l’erreur
code	string	Code de l’erreur.
message	string	Message d’erreur lisible par l’utilisateur.
resources	string[]	Indique les ressources responsables de l’erreur.
target	string	Indique quelle propriété dans la requête est responsable de l’erreur.
value	string	Indique la valeur dans « target » qui est responsable de l’erreur.

errorInfo

Code et message d’une erreur.

Nom	Type	Description
additionalProperties	object	Propriétés supplémentaires pouvant être fournies sur l’objet d’informations d’erreur
code	string	Code d’erreur lisible par la machine.
details	errorDetail[]	détails de l’erreur.
innererror	errorInfo	Code et message d’une erreur. Détails de l’erreur interne s’ils existent.
message	string	Message d’erreur lisible par l’utilisateur.

errorResponse

Détails de l’erreur.

Nom	Type	Description
error	errorInfo	Code et message d’une erreur. Détails de l’erreur.

logsColumnType

Type de données de cette colonne.

Nom	Type	Description
bool	string
datetime	string
decimal	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string
timespan	string

queryBody

Requête Analytics. En savoir plus sur la syntaxe de requête Analytics

Nom	Type	Description
query	string	Requête à exécuter.
timespan	string	facultatif. Intervalle de temps sur lequel interroger les données. Il s’agit d’une valeur de période ISO8601. Ce délai est appliqué en plus de ceux spécifiés dans l’expression de requête.
workspaces	string[]	Liste des espaces de travail inclus dans la requête.

queryResults

Réponse à une requête.

Nom	Type	Description
error	errorInfo	Code et message d’une erreur.
render	Render	Données de visualisation au format JSON.
statistics	Statistics	Statistiques représentées au format JSON.
tables	table[]	Liste des tables, colonnes et lignes.

Render

Données de visualisation au format JSON.

Statistics

Statistiques représentées au format JSON.

table

Table de réponse de requête.

Nom	Type	Description
columns	column[]	Liste des colonnes de cette table.
name	string	Nom de la table.
rows	object[]	Lignes résultantes de cette requête.

Partager via