Metadata - Get

Referenz

Dienst:: Application Insights

API-Version:: v1

Ruft Metadateninformationen ab.
Rufen Sie die Metadateninformationen für die App ab, einschließlich ihres Schemas usw.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
appId	path	True	string	ID der Anwendung. Dies ist die Anwendungs-ID auf dem Blatt API-Zugriffseinstellungen im Azure-Portal.

Antworten

Name	Typ	Beschreibung
200 OK	metadataResults	Erfolgreiche Antwort
Other Status Codes	errorResponse	Ein Fehlerantwortobjekt.

Sicherheit

oauth2

Herstellen einer Verbindung mit Azure-Anwendung Insights-API

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

metadataGet

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
Columns	Die Liste der spalten, die in der Tabelle definiert sind
errorDetail	Fehlerdetails.
errorInfo	Der Code und die Meldung für einen Fehler.
errorResponse	Fehlerdetails.
metadataApplication	Eine Application Insights-Anwendung.
MetadataColumnDataType	Der Datentyp der Spalte
metadataFunction	Eine gespeicherte Funktion.
metadataResults	Eine Metadatenantwort.
metadataTable	Eine Datentabelle, die an einem Schema einer Application Insights-App teilnimmt.
metadataTableGroup	Eine Gruppe von Tabellen.

Columns

Die Liste der spalten, die in der Tabelle definiert sind

Name	Typ	Beschreibung
description	string	Die Beschreibung der Spalte
isPreferredFacet	boolean	Ein Flag, das angibt, dass diese Spalte ein bevorzugtes Facet ist.
name	string	Der Name der Spalte
source	object	Ein Hinweis auf die Quelle der Spalte, die nur verwendet wird, wenn mehrere Apps über eine in Konflikt stehende Definition für die Spalte verfügen.
type	MetadataColumnDataType	Der Datentyp der Spalte

errorDetail

Fehlerdetails.

Name	Typ	Beschreibung
additionalProperties	object
code	string	Der Fehlercode.
message	string	Eine lesbare Fehlermeldung.
resources	string[]	Gibt Ressourcen an, die für den Fehler verantwortlich waren.
target	string	Gibt an, welche Eigenschaft in der Anforderung für den Fehler verantwortlich ist.
value	string	Gibt an, welcher Wert in "target" für den Fehler verantwortlich ist.

errorInfo

Der Code und die Meldung für einen Fehler.

Name	Typ	Beschreibung
additionalProperties	object
code	string	Ein computerlesbarer Fehlercode.
details	errorDetail[]	Fehlerdetails.
innererror	errorInfo	Der Code und die Meldung für einen Fehler. Innere Fehlerdetails, sofern vorhanden.
message	string	Eine lesbare Fehlermeldung.

errorResponse

Fehlerdetails.

Name	Typ	Beschreibung
error	errorInfo	Der Code und die Meldung für einen Fehler. Die Fehlerdetails.

metadataApplication

Eine Application Insights-Anwendung.

Name	Typ	Beschreibung
functions	string[]	Die Liste der gespeicherten Funktionen in der Application Insights-App
id	string	Die ID der Application Insights-App.
name	string	Der Name der Application Insights-App.
region	string	Die Azure-Region der Application Insights-App.
resourceId	string	Die ARM-Ressourcen-ID der Application Insights-App.
tableGroups	string[]	Die Liste der Tabellengruppen in der Application Insights-App
tables	string[]	Die Liste der benutzerdefinierten Tabellen für die Application Insights-App.

MetadataColumnDataType

Der Datentyp der Spalte

Name	Typ	Beschreibung
bool	string
datetime	string
dynamic	string
int	string
long	string
real	string
string	string

metadataFunction

Eine gespeicherte Funktion.

Name	Typ	Beschreibung
body	string	Der KQL-Text der Funktion.
description	string	Die Beschreibung der Funktion.
displayName	string	Der Anzeigename der Funktion.
id	string	Die ID der Funktion.
name	string	Der Name der Funktion, die in Abfragen verwendet werden soll.
parameters	string	Die Parameter/Argumente der Funktion, falls vorhanden.

metadataResults

Eine Metadatenantwort.

Name	Typ	Beschreibung
applications	metadataApplication[]	Die Liste der Application Insights-Apps, auf die in der Metadatenanforderung verwiesen wurde.
functions	metadataFunction[]	Die Liste der in der App gespeicherten Funktionen.
tableGroups	metadataTableGroup[]	Die Liste der Tabellengruppen in der App.
tables	metadataTable[]	Die Liste der Tabellen und Spalten, aus denen das Schema der App besteht.

metadataTable

Eine Datentabelle, die an einem Schema einer Application Insights-App teilnimmt.

Name	Typ	Beschreibung
columns	Columns[]	Die Liste der spalten, die in der Tabelle definiert sind
description	string	Die Beschreibung der Tabelle
id	string	Die ID der Tabelle
name	string	Der Name der Tabelle.
timespanColumn	string	Die Spalte, die dem abfrageparameter timespan für die Tabelle zugeordnet ist

metadataTableGroup

Eine Gruppe von Tabellen.

Name	Typ	Beschreibung
description	string	Beschreibung der Tabellengruppe
displayName	string	Der Anzeigename der Tabellengruppe
id	string	Die ID der Tabellengruppe
name	string	Der Name der Tabellengruppe
source	string	Die Quelle der Tabellengruppe kann entweder KI oder OMS für Log Analytics-Arbeitsbereiche sein.
tables	string[]	Die Liste der tabellen in der Tabellengruppe enthaltenen Tabellen

Freigeben über