Metadata - Post

Referência

Serviço:: Application Insights

Versão da API:: v1

Obtém informações de metadados
Obtenha as informações de metadados da aplicação, incluindo o respetivo esquema, etc.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
appId	path	True	string	ID da aplicação. Este é o ID da Aplicação no painel definições de Acesso à API no portal do Azure.

Respostas

Name	Tipo	Description
200 OK	metadataResults	Resposta com êxito
Other Status Codes	errorResponse	Um objeto de resposta de erro.

Segurança

oauth2

Ligar à API do Aplicação Azure Insights

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

metadataPost

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Name	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	Uma aplicação 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 num esquema de uma aplicação do Application Insights.
metadataTableGroup	Um grupo de tabelas.

Columns

A lista de colunas definidas na tabela

Name	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, utilizada apenas quando várias aplicações têm uma definição em conflito para a coluna
type	MetadataColumnDataType	O tipo de dados da coluna

errorDetail

Detalhes do erro.

Name	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 responsáveis pelo erro.
target	string	Indica que propriedade no pedido é responsável pelo erro.
value	string	Indica que valor em "destino" é responsável pelo erro.

errorInfo

O código e a mensagem de um erro.

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

errorResponse

Detalhes do erro.

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

metadataApplication

Uma aplicação do Application Insights.

Name	Tipo	Description
functions	string[]	A lista de funções armazenadas na aplicação Application Insights
id	string	O ID da aplicação Application Insights.
name	string	O nome da aplicação Application Insights.
region	string	A região do Azure da aplicação Application Insights.
resourceId	string	O ID de recurso do ARM da aplicação Application Insights.
tableGroups	string[]	A lista de grupos de tabelas na aplicação Application Insights
tables	string[]	A lista de tabelas personalizadas para a aplicação Application Insights.

MetadataColumnDataType

O tipo de dados da coluna

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

metadataFunction

Uma função armazenada.

Name	Tipo	Description
body	string	O corpo KQL da função.
description	string	A descrição da função.
displayName	string	O nome a apresentar da função.
id	string	O ID da função.
name	string	O nome da função, a utilizar em consultas.
parameters	string	Os parâmetros/argumentos da função, se existirem.

metadataResults

Uma resposta de metadados.

Name	Tipo	Description
applications	metadataApplication[]	A lista de aplicações do Application Insights que foram referenciadas no pedido de metadados.
functions	metadataFunction[]	A lista de funções armazenadas na aplicação.
tableGroups	metadataTableGroup[]	A lista de grupos de tabelas na aplicação.
tables	metadataTable[]	A lista de tabelas e colunas que compõem o esquema da aplicação.

metadataTable

Uma tabela de dados que participa num esquema de uma aplicação do Application Insights.

Name	Tipo	Description
columns	Columns[]	A lista de colunas definidas na tabela
description	string	A descrição da tabela
id	string	O ID da tabela
name	string	O nome da tabela
timespanColumn	string	A coluna associada ao parâmetro de consulta de período de tempo da tabela

metadataTableGroup

Um grupo de tabelas.

Name	Tipo	Description
description	string	A descrição do grupo de tabelas
displayName	string	O nome a apresentar do grupo de tabelas
id	string	O 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 áreas de trabalho do Log Analytics
tables	string[]	A lista de tabelas contidas no grupo de tabelas

Partilhar via