Metadata - Get

Referens

Tjänst:: Application Insights

API-version:: v1

Hämtar metadatainformation
Hämta metadatainformationen för appen, inklusive dess schema osv.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
appId	path	True	string	ID för programmet. Det här är Program-ID från bladet API-åtkomstinställningar i Azure Portal.

Svar

Name	Typ	Description
200 OK	metadataResults	Lyckat svar
Other Status Codes	errorResponse	Ett felsvarsobjekt.

Säkerhet

oauth2

Ansluta till Azure Application Insights API

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

metadataGet

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
Columns	Listan över kolumner som definierats i tabellen
errorDetail	Felinformation.
errorInfo	Koden och meddelandet för ett fel.
errorResponse	Felinformation.
metadataApplication	Ett Application Insights-program.
MetadataColumnDataType	Kolumnens datatyp
metadataFunction	En lagrad funktion.
metadataResults	Ett metadatasvar.
metadataTable	En datatabell som deltar i ett schema för en Application Insights-app.
metadataTableGroup	En grupp med tabeller.

Columns

Listan över kolumner som definierats i tabellen

Name	Typ	Description
description	string	Beskrivningen av kolumnen
isPreferredFacet	boolean	En flagga som anger att den här kolumnen är en föredragen fasettering
name	string	Namnet på kolumnen
source	object	en indikation på kolumnens källa, som endast används när flera appar har motstridiga definitioner för kolumnen
type	MetadataColumnDataType	Kolumnens datatyp

errorDetail

Felinformation.

Name	Typ	Description
additionalProperties	object
code	string	Felkoden.
message	string	Ett felmeddelande som kan läsas av människor.
resources	string[]	Anger resurser som var ansvariga för felet.
target	string	Anger vilken egenskap i begäran som ansvarar för felet.
value	string	Anger vilket värde i "mål" som ansvarar för felet.

errorInfo

Koden och meddelandet för ett fel.

Name	Typ	Description
additionalProperties	object
code	string	En felkod som kan läsas av datorn.
details	errorDetail[]	felinformation.
innererror	errorInfo	Koden och meddelandet för ett fel. Inre felinformation om de finns.
message	string	Ett felmeddelande som kan läsas av människor.

errorResponse

Felinformation.

Name	Typ	Description
error	errorInfo	Koden och meddelandet för ett fel. Felinformationen.

metadataApplication

Ett Application Insights-program.

Name	Typ	Description
functions	string[]	Listan över lagrade funktioner i Application Insights-appen
id	string	ID för Application Insights-appen.
name	string	Namnet på Application Insights-appen.
region	string	Azure-regionen för Application Insights-appen.
resourceId	string	ARM-resurs-ID för Application Insights-appen.
tableGroups	string[]	Listan över tabellgrupper i Application Insights-appen
tables	string[]	Listan över anpassade tabeller för Application Insights-appen.

MetadataColumnDataType

Kolumnens datatyp

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

metadataFunction

En lagrad funktion.

Name	Typ	Description
body	string	KQL-brödtexten i funktionen.
description	string	Beskrivningen av funktionen.
displayName	string	Funktionens visningsnamn.
id	string	ID för funktionen.
name	string	Namnet på funktionen som ska användas i frågor.
parameters	string	Parametrarna/argumenten för funktionen, om det finns några.

metadataResults

Ett metadatasvar.

Name	Typ	Description
applications	metadataApplication[]	Listan över Application Insights-appar som refererades till i metadatabegäran.
functions	metadataFunction[]	Listan över funktioner som lagras i appen.
tableGroups	metadataTableGroup[]	Listan över grupper av tabeller i appen.
tables	metadataTable[]	Listan över tabeller och kolumner som utgör appens schema.

metadataTable

En datatabell som deltar i ett schema för en Application Insights-app.

Name	Typ	Description
columns	Columns[]	Listan över kolumner som definierats i tabellen
description	string	Beskrivningen av tabellen
id	string	Tabellens ID
name	string	Namnet på tabellen
timespanColumn	string	Kolumnen som är associerad med frågeparametern för tidsintervallet för tabellen

metadataTableGroup

En grupp med tabeller.

Name	Typ	Description
description	string	Beskrivningen av tabellgruppen
displayName	string	Tabellgruppens visningsnamn
id	string	ID för tabellgruppen
name	string	Namnet på tabellgruppen
source	string	Källan för tabellgruppen kan vara antingen AI eller OMS för Log Analytics-arbetsytor
tables	string[]	Listan över tabeller som finns i tabellgruppen

Dela via