Metadata - Get

Referência

Serviço:: Log Analytics

Versão da API:: 2022-10-27_Preview

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

GET https://api.loganalytics.io/v1/workspaces/{workspaceId}/metadata

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string	ID do workspace. Essa é a ID do Workspace da folha Propriedades no portal do Azure.

Respostas

Nome	Tipo	Description
200 OK	metadataResults	OK. A chamada à API foi bem-sucedida e o resultado dos metadados está no conteúdo da resposta
Other Status Codes	errorResponse	Um objeto de resposta de erro.

Segurança

oauth2

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

metadataGet

Solicitação de exemplo

HTTP

GET https://api.loganalytics.io/v1/workspaces/b438b4f6-912a-46d5-9cb1-b44069212abc/metadata

Resposta de exemplo

Código de status:: 200

{
  "tables": [
    {
      "id": "ADAssessmentRecommendation",
      "name": "ADAssessmentRecommendation",
      "description": "Recommendations generated by AD assessments that are started through a scheduled task. When you schedule the assessment it runs by default every 7 days and upload the data into Azure Log Analytics",
      "timespanColumn": "TimeGenerated",
      "columns": [
        {
          "name": "SourceSystem",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "AssessmentId",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "RecommendationId",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Recommendation",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Description",
          "type": "string"
        },
        {
          "name": "RecommendationResult",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "TimeGenerated",
          "type": "datetime"
        },
        {
          "name": "FocusAreaId",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "FocusArea",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "ActionAreaId",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "ActionArea",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "RecommendationWeight",
          "type": "real"
        },
        {
          "name": "Computer",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "AffectedObjectType",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "AffectedObjectName",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Forest",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Domain",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "DomainController",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Technology",
          "type": "string"
        },
        {
          "name": "CustomData",
          "type": "string"
        },
        {
          "name": "TargetCount",
          "type": "int"
        },
        {
          "name": "IsRollup",
          "type": "bool",
          "isPreferredFacet": true
        },
        {
          "name": "IsCopied",
          "type": "bool",
          "isPreferredFacet": true
        },
        {
          "name": "RecommendationPeriod",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "Type",
          "type": "string"
        },
        {
          "name": "_ResourceId",
          "type": "string"
        }
      ],
      "related": {
        "categories": [
          "workloads"
        ],
        "solutions": [
          "ADAssessment"
        ],
        "resourceTypes": [
          "microsoft.compute/virtualmachines"
        ]
      }
    },
    {
      "id": "custom_CL",
      "name": "custom_CL",
      "timespanColumn": "TimeGenerated",
      "columns": [
        {
          "name": "SourceSystem",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "ManagementGroupName",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "TimeGenerated",
          "type": "datetime",
          "isPreferredFacet": true
        },
        {
          "name": "Computer",
          "type": "string",
          "isPreferredFacet": true
        },
        {
          "name": "RawData",
          "type": "string"
        },
        {
          "name": "Type",
          "type": "string"
        },
        {
          "name": "_ResourceId",
          "type": "string"
        }
      ],
      "related": {
        "workspaces": [
          "b438b4f6-912a-46d5-9cb1-b44069212abc"
        ]
      }
    }
  ],
  "solutions": [
    {
      "id": "ADAssessment",
      "name": "ADAssessment",
      "displayName": "Active Directory Health Check",
      "description": "Assess the risk and health of Active Directory environments.",
      "related": {
        "tables": [
          "ADAssessmentRecommendation"
        ],
        "functions": [
          "dwad"
        ],
        "workspaces": [
          "b438b4f6-912a-46d5-9cb1-b44069212abc"
        ]
      }
    }
  ],
  "functions": [
    {
      "id": "dwad",
      "name": "dwad",
      "displayName": "dasd",
      "body": "Heartbeat\r\n| where ResourceGroup != \"rg-SAP-DEVQA-005\" and ResourceGroup != \"rg-SAP-DEVQA-006\" and Computer contains \"\"\r\n| limit 500000\r\n| sort by Computer asc\r\n| distinct Computer\r\n",
      "related": {
        "solutions": [
          "ADAssessment"
        ],
        "workspaces": [
          "b438b4f6-912a-46d5-9cb1-b44069212abc"
        ]
      }
    }
  ],
  "resourceTypes": [
    {
      "id": "microsoft.compute/virtualmachines",
      "type": "Microsoft.Compute/VirtualMachines",
      "displayName": "Virtual machines",
      "related": {
        "tables": [
          "ADAssessmentRecommendation"
        ]
      }
    }
  ],
  "workspaces": [
    {
      "id": "b438b4f6-912a-46d5-9cb1-b44069212abc",
      "resourceId": "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-IT",
      "name": "contosoretail-IT",
      "region": "eastus",
      "related": {
        "resourceTypes": [
          "microsoft.compute/virtualmachines"
        ],
        "tables": [
          "custom_CL"
        ],
        "solutions": [
          "ADAssessment"
        ],
        "functions": [
          "dwad"
        ]
      }
    }
  ],
  "categories": [
    {
      "id": "workloads",
      "displayName": "Workloads",
      "related": {
        "tables": [
          "ADAssessmentRecommendation",
          "ADReplicationResult",
          "SQLAssessmentRecommendation",
          "WorkloadMonitoringPerf"
        ]
      }
    }
  ]
}

Definições

Nome	Description
Applications	A indicação de permissão para os aplicativos do Application Insights na solicitação de metadados.
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.
metadataCategory	Uma categoria de metadados.
MetadataColumnDataType	O tipo de dados da coluna
metadataFunction	Uma função armazenada.
metadataPermissions	Informações de permissão.
metadataQuery	Uma consulta armazenada.
metadataResourceType	Um tipo de recurso no Azure.
metadataResults	Uma resposta de metadados.
metadataSolution	Uma solução do Log Analytics.
metadataTable	Uma tabela de dados que participa de um esquema de workspace.
metadataWorkspace	Um espaço de trabalho do Log Analytics.
Related	Os itens de metadados relacionados para a categoria
Resources	A indicação de permissão para os recursos do Azure na solicitação de metadados.
Workspaces	A indicação de permissão para os workspaces na solicitação de metadados.

Applications

A indicação de permissão para os aplicativos do Application Insights na solicitação de metadados.

Nome	Tipo	Description
resourceId	string	A ID do recurso na indicação de permissão.

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 workspaces 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	Propriedades adicionais que podem ser fornecidas no objeto de detalhes do erro
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	Propriedades adicionais que podem ser fornecidas no objeto de informações de erro
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
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.
related	Related	Os itens de metadados relacionados para o aplicativo Application Insights.
resourceId	string	A ID do recurso arm do aplicativo Application Insights.

metadataCategory

Uma categoria de metadados.

Nome	Tipo	Description
description	string	A descrição da categoria
displayName	string	O nome de exibição da categoria
id	string	A ID da categoria
related	Related	Os itens de metadados relacionados para a categoria

MetadataColumnDataType

O tipo de dados da coluna

Nome	Tipo	Description
bool	string
datetime	string
decimal	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string
timespan	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.
properties	object	As propriedades da função.
related	Related	Os itens de metadados relacionados para a função.
tags	object	As marcas associadas à função .

metadataPermissions

Informações de permissão.

Nome	Tipo	Description
applications	Applications[]	A indicação de permissão para os aplicativos do Application Insights na solicitação de metadados.
resources	Resources[]	A indicação de permissão para os recursos do Azure na solicitação de metadados.
workspaces	Workspaces[]	A indicação de permissão para os workspaces na solicitação de metadados.

metadataQuery

Uma consulta armazenada.

Nome	Tipo	Description
body	string	O corpo KQL da consulta.
description	string	A descrição da consulta.
displayName	string	O nome de exibição da consulta.
id	string	A ID da consulta.
labels	string[]	Os rótulos definidos pelo usuário associados à consulta.
properties	object	As propriedades da consulta.
related	Related	Os itens de metadados relacionados para a consulta.
tags	object	As marcas associadas à consulta.

metadataResourceType

Um tipo de recurso no Azure.

Nome	Tipo	Description
description	string	A descrição do tipo de recurso
displayName	string	O nome de exibição do tipo de recurso
id	string	A ID do tipo de recurso
labels	string[]	Os rótulos definidos pelo usuário do tipo de recurso
properties	object	As propriedades do tipo de recurso
related	Related	Os itens de metadados relacionados para o tipo de recurso
tags	object	As marcas associadas ao tipo de recurso
type	string	O tipo do tipo de recurso

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.
categories	metadataCategory[]	A lista de categorias que são referenciadas nesta resposta de metadados.
functions	metadataFunction[]	A lista de funções armazenadas no workspace ou introduzidas por soluções etc.
permissions	metadataPermissions[]	A lista de regras de permissão que afetaram a solicitação de metadados.
queries	metadataQuery[]	A lista de consultas salvas armazenadas no workspace ou introduzidas por soluções, tipos de recursos etc.
resourceTypes	metadataResourceType[]	A lista de tipos de recursos referenciados nesta resposta de metadados.
resources	metadataResource[]	A lista de recursos do Azure que foram referenciados na solicitação de metadados.
solutions	metadataSolution[]	A lista de soluções do Log Analytics instaladas no workspace.
tables	metadataTable[]	A lista de tabelas e colunas que compõem o esquema do workspace.
workspaces	metadataWorkspace[]	A lista de workspaces do Log Analytics que foram referenciados na solicitação de metadados.

metadataSolution

Uma solução do Log Analytics.

Nome	Tipo	Description
description	string	A descrição da solução do Log Analytics
displayName	string	O nome de exibição da solução do Log Analytics
id	string	A ID da solução do Log Analytics
name	string	O nome da solução do Log Analytics
properties	object	As propriedades da solução do Log Analytics
related	Related	Os itens de metadados relacionados para a solução do Log Analytics
tags	object	As marcas associadas à solução do Log Analytics

metadataTable

Uma tabela de dados que participa de um esquema de workspace.

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
labels	string[]	Os rótulos definidos pelo usuário da tabela
name	string	O nome da tabela
properties	object	As propriedades da tabela
related	Related	Os itens de metadados relacionados para a tabela
tags	object	As marcas associadas à tabela
timespanColumn	string	A coluna associada ao parâmetro de consulta timespan para a tabela

metadataWorkspace

Um espaço de trabalho do Log Analytics.

Nome	Tipo	Description
id	string	A ID do workspace do Log Analytics.
name	string	O nome do workspace do Log Analytics.
region	string	A região do Azure do workspace do Log Analytics.
related	Related	Os itens de metadados relacionados para o workspace do Log Analytics.
resourceId	string	A ID do recurso arm do workspace do Log Analytics.

Os itens de metadados relacionados para a categoria

Nome	Tipo	Description
functions	string[]	As funções relacionadas à categoria
queries	string[]	As consultas salvas relacionadas à categoria
resourceTypes	string[]	Os tipos de recursos relacionados à categoria
solutions	string[]	As soluções do Log Analytics relacionadas à categoria
tables	string[]	As tabelas relacionadas à categoria

Resources

A indicação de permissão para os recursos do Azure na solicitação de metadados.

Nome	Tipo	Description
denyTables	string[]	A lista de tabelas que tiveram acesso negado para a ID do recurso.
resourceId	string	A ID do recurso na indicação de permissão.

Workspaces

A indicação de permissão para os workspaces na solicitação de metadados.

Nome	Tipo	Description
denyTables	string[]	A lista de tabelas que tiveram acesso negado para a ID do recurso.
resourceId	string	A ID do recurso na indicação de permissão.

Compartilhar via

Metadata - Get

Parâmetros de URI

Respostas

Segurança

oauth2

Escopos

Exemplos

metadataGet

Solicitação de exemplo

Resposta de exemplo

Definições

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Resources

Workspaces

Recursos adicionais

Compartilhar via

Metadata - Get

Parâmetros de URI

Respostas

Segurança

oauth2

Escopos

Exemplos

metadataGet

Solicitação de exemplo

Resposta de exemplo

Definições

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Related

Resources

Workspaces

Recursos adicionais