Metadata - Get

Referência

Serviço:: Application Insights

Versão da API:: v1

Obtém informações de metadados
Recupere as informações de metadados para o aplicativo, incluindo seu esquema, etc.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
appId	path	True	string	ID do aplicativo. Esta é a ID do Aplicativo da folha Configurações de acesso à API no portal do Azure.

Respostas

Nome	Tipo	Description
200 OK	metadataResults	Resposta bem-sucedida
Other Status Codes	errorResponse	Um objeto de resposta de erro.

Segurança

oauth2

Conectar-se à API do Aplicativo Azure Insights

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

metadataGet

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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"
      ]
    }
  ]
}

Definições

Nome	Description
Columns	A lista de colunas definidas na tabela
errorDetail	Detalhes do erro.
errorInfo	O código e a mensagem de um erro.
errorResponse	Detalhes do erro.
metadataApplication	Um aplicativo do Application Insights.
MetadataColumnDataType	O tipo de dados da coluna
metadataFunction	Uma função armazenada.
metadataResults	Uma resposta de metadados.
metadataTable	Uma tabela de dados que participa de um esquema de um aplicativo do Application Insights.
metadataTableGroup	Um grupo de tabelas.

Columns

A lista de colunas definidas na tabela

Nome	Tipo	Description
description	string	A descrição da coluna
isPreferredFacet	boolean	Um sinalizador que indica que esta coluna é uma faceta preferencial
name	string	O nome da coluna
source	object	uma indicação da origem da coluna, usada somente quando vários aplicativos têm uma definição conflitante para a coluna
type	MetadataColumnDataType	O tipo de dados da coluna

errorDetail

Detalhes do erro.

Nome	Tipo	Description
additionalProperties	object
code	string	O código do erro.
message	string	Uma mensagem de erro legível por humanos.
resources	string[]	Indica os recursos que foram responsáveis pelo erro.
target	string	Indica qual propriedade na solicitação é responsável pelo erro.
value	string	Indica qual valor em 'target' é responsável pelo erro.

errorInfo

O código e a mensagem de um erro.

Nome	Tipo	Description
additionalProperties	object
code	string	Um código de erro legível do computador.
details	errorDetail[]	detalhes do erro.
innererror	errorInfo	O código e a mensagem de um erro. Detalhes do erro interno se eles existirem.
message	string	Uma mensagem de erro legível por humanos.

errorResponse

Detalhes do erro.

Nome	Tipo	Description
error	errorInfo	O código e a mensagem de um erro. Os detalhes do erro.

metadataApplication

Um aplicativo do Application Insights.

Nome	Tipo	Description
functions	string[]	A lista de funções armazenadas no aplicativo Application Insights
id	string	A ID do aplicativo Application Insights.
name	string	O nome do aplicativo Application Insights.
region	string	A região do Azure do aplicativo Application Insights.
resourceId	string	A ID do recurso arm do aplicativo Application Insights.
tableGroups	string[]	A lista de grupos de tabelas no aplicativo Application Insights
tables	string[]	A lista de tabelas personalizadas para o aplicativo Application Insights.

MetadataColumnDataType

O tipo de dados da coluna

Nome	Tipo	Description
bool	string
datetime	string
dynamic	string
int	string
long	string
real	string
string	string

metadataFunction

Uma função armazenada.

Nome	Tipo	Description
body	string	O corpo KQL da função.
description	string	A descrição da função.
displayName	string	O nome de exibição da função.
id	string	A ID da função.
name	string	O nome da função, a ser usado em consultas.
parameters	string	Os parâmetros/argumentos da função, se houver.

metadataResults

Uma resposta de metadados.

Nome	Tipo	Description
applications	metadataApplication[]	A lista de aplicativos do Application Insights que foram referenciados na solicitação de metadados.
functions	metadataFunction[]	A lista de funções armazenadas no aplicativo.
tableGroups	metadataTableGroup[]	A lista de grupos de tabelas no aplicativo.
tables	metadataTable[]	A lista de tabelas e colunas que compõem o esquema do aplicativo.

metadataTable

Uma tabela de dados que participa de um esquema de um aplicativo do Application Insights.

Nome	Tipo	Description
columns	Columns[]	A lista de colunas definidas na tabela
description	string	A descrição da tabela
id	string	A ID da tabela
name	string	O nome da tabela
timespanColumn	string	A coluna associada ao parâmetro de consulta timespan para a tabela

metadataTableGroup

Um grupo de tabelas.

Nome	Tipo	Description
description	string	A descrição do grupo de tabelas
displayName	string	O nome de exibição do grupo de tabelas
id	string	A ID do grupo de tabelas
name	string	O nome do grupo de tabelas
source	string	A origem do grupo de tabelas pode ser IA ou OMS para workspaces do Log Analytics
tables	string[]	A lista de tabelas contidas no grupo de tabelas

Compartilhar via