Metadata - Get

Référence

Service:: Application Insights

Version d'API:: v1

Obtient des informations de métadonnées
Récupérer les informations de métadonnées de l’application, y compris son schéma, etc.

GET https://api.applicationinsights.io/v1/apps/{appId}/metadata

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
appId	path	True	string	ID de l’application. Il s’agit de l’ID d’application du panneau Des paramètres d’accès à l’API dans le Portail Azure.

Réponses

Nom	Type	Description
200 OK	metadataResults	Réponse correcte
Other Status Codes	errorResponse	Objet de réponse d’erreur.

Sécurité

oauth2

Se connecter à l’API Azure Application Insights

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Étendues

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

Exemples

metadataGet

Exemple de requête

HTTP

GET https://api.applicationinsights.io/v1/apps/cf58dcfd-0683-487c-bc84-048789bca8e5/metadata

Exemple de réponse

Code d’état:: 200

{
  "tables": [
    {
      "id": "t/requests",
      "name": "requests",
      "timespanColumn": "timestamp",
      "columns": [
        {
          "name": "timestamp",
          "type": "datetime"
        },
        {
          "name": "id",
          "type": "string"
        },
        {
          "name": "source",
          "type": "string"
        },
        {
          "name": "name",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "url",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "success",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "resultCode",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "duration",
          "type": "real"
        },
        {
          "name": "performanceBucket",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "itemType",
          "type": "string"
        },
        {
          "name": "customDimensions",
          "type": "dynamic",
          "isPreferredFacet": true
        },
        {
          "name": "customMeasurements",
          "type": "dynamic"
        },
        {
          "name": "operation_Name",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "operation_Id",
          "type": "string"
        },
        {
          "name": "operation_ParentId",
          "type": "string"
        },
        {
          "name": "operation_SyntheticSource",
          "type": "string"
        },
        {
          "name": "session_Id",
          "type": "string"
        },
        {
          "name": "user_Id",
          "type": "string"
        },
        {
          "name": "user_AuthenticatedId",
          "type": "string"
        },
        {
          "name": "user_AccountId",
          "type": "string"
        },
        {
          "name": "application_Version",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "client_Type",
          "type": "string"
        },
        {
          "name": "client_Model",
          "type": "string"
        },
        {
          "name": "client_OS",
          "type": "string"
        },
        {
          "name": "client_IP",
          "type": "string"
        },
        {
          "name": "client_City",
          "type": "string"
        },
        {
          "name": "client_StateOrProvince",
          "type": "string"
        },
        {
          "name": "client_CountryOrRegion",
          "type": "string"
        },
        {
          "name": "client_Browser",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "cloud_RoleName",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "cloud_RoleInstance",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "appId",
          "type": "string"
        },
        {
          "name": "appName",
          "type": "string"
        },
        {
          "name": "iKey",
          "type": "string"
        },
        {
          "name": "sdkVersion",
          "type": "string"
        },
        {
          "name": "itemId",
          "type": "string"
        },
        {
          "name": "itemCount",
          "type": "int"
        }
      ]
    }
  ],
  "tableGroups": [
    {
      "id": "ai/StandardSchema",
      "name": "StandardSchema",
      "source": "ai",
      "tables": [
        "t/requests"
      ]
    }
  ],
  "applications": [
    {
      "id": "cf58dcfd-0683-487c-bc84-048789bca8e5",
      "name": "FabrikamProd",
      "resourceId": "/subscriptions/72993b69-db12-44fc-9a66-9c2005c30513/resourceGroups/Fabrikam/providers/microsoft.insights/components/FabrikamProd",
      "tables": [],
      "region": "southcentralus",
      "tableGroups": [
        "ai/StandardSchema"
      ]
    }
  ]
}

Définitions

Nom	Description
Columns	Liste des colonnes définies sur la table
errorDetail	Détails de l’erreur.
errorInfo	Code et message d’une erreur.
errorResponse	Détails de l’erreur.
metadataApplication	Application Insights.
MetadataColumnDataType	Type de données de la colonne
metadataFunction	Fonction stockée.
metadataResults	Réponse aux métadonnées.
metadataTable	Table de données qui participe à un schéma d’une application Application Insights.
metadataTableGroup	Groupe de tables.

Columns

Liste des colonnes définies sur la table

Nom	Type	Description
description	string	Description de la colonne
isPreferredFacet	boolean	Indicateur indiquant que cette colonne est une facette préférée
name	string	Nom de la colonne
source	object	indication de la source de la colonne, utilisée uniquement lorsque plusieurs applications ont une définition en conflit pour la colonne
type	MetadataColumnDataType	Type de données de la colonne

errorDetail

Détails de l’erreur.

Nom	Type	Description
additionalProperties	object
code	string	Code de l’erreur.
message	string	Message d’erreur lisible par l’homme.
resources	string[]	Indique les ressources responsables de l’erreur.
target	string	Indique la propriété de la requête 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
code	string	Code d’erreur lisible par machine.
details	errorDetail[]	détails de l’erreur.
innererror	errorInfo	Code et message d’une erreur. Détails internes de l’erreur s’ils existent.
message	string	Message d’erreur lisible par l’homme.

errorResponse

Détails de l’erreur.

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

metadataApplication

Application Insights.

Nom	Type	Description
functions	string[]	Liste des fonctions stockées sur l’application Application Insights
id	string	ID de l’application Application Insights.
name	string	Nom de l’application Application Insights.
region	string	Région Azure de l’application Application Insights.
resourceId	string	ID de ressource ARM de l’application Application Insights.
tableGroups	string[]	Liste des groupes de tables sur l’application Application Insights
tables	string[]	Liste des tables personnalisées pour l’application Application Insights.

MetadataColumnDataType

Type de données de la colonne

Nom	Type	Description
bool	string
datetime	string
dynamic	string
int	string
long	string
real	string
string	string

metadataFunction

Fonction stockée.

Nom	Type	Description
body	string	Corps KQL de la fonction.
description	string	Description de la fonction.
displayName	string	Nom d’affichage de la fonction.
id	string	ID de la fonction.
name	string	Nom de la fonction, à utiliser dans les requêtes.
parameters	string	Paramètres/arguments de la fonction, le cas échéant.

metadataResults

Réponse aux métadonnées.

Nom	Type	Description
applications	metadataApplication[]	Liste des applications Application Insights référencées dans la demande de métadonnées.
functions	metadataFunction[]	Liste des fonctions stockées sur l’application.
tableGroups	metadataTableGroup[]	Liste des groupes de tables sur l’application.
tables	metadataTable[]	Liste des tables et colonnes qui composent le schéma de l’application.

metadataTable

Table de données qui participe à un schéma d’une application Application Insights.

Nom	Type	Description
columns	Columns[]	Liste des colonnes définies sur la table
description	string	Description de la table
id	string	ID de la table
name	string	Le nom de la table
timespanColumn	string	Colonne associée au paramètre de requête d’intervalle de temps pour la table

metadataTableGroup

Groupe de tables.

Nom	Type	Description
description	string	Description du groupe de tables
displayName	string	Nom d’affichage du groupe de tables
id	string	ID du groupe de tables
name	string	Nom du groupe de tables
source	string	La source du groupe de tables peut être IA ou OMS pour les espaces de travail Log Analytics
tables	string[]	Liste des tables contenues dans le groupe de tables

Partager via