Metadata - Post

Ссылка

Служба:: Log Analytics

Версия API:: 2022-10-27_Preview

Возвращает сведения о метаданных
Получение сведений о метаданных рабочей области, включая ее схему, функции, сведения о рабочей области, категории и т. д.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
workspaceId	path	True	string	Идентификатор рабочей области. Это идентификатор рабочей области из колонки Свойства в портал Azure.

Ответы

Имя	Тип	Описание
200 OK	metadataResults	Все в порядке. Вызов API выполнен успешно, и результат метаданных находится в полезных данных ответа
Other Status Codes	errorResponse	Объект ответа об ошибке.

Безопасность

oauth2

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

metadataPost

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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"
        ]
      }
    }
  ]
}

Определения

Имя	Описание
Applications	Указание разрешений для приложений Application Insights в запросе метаданных.
Columns	Список столбцов, определенных в таблице
errorDetail	Сведения об ошибке.
errorInfo	Код и сообщение об ошибке.
errorResponse	Сведения об ошибке.
metadataApplication	Приложение Application Insights.
metadataCategory	Категория метаданных.
MetadataColumnDataType	Тип данных столбца
metadataFunction	Хранимая функция.
metadataPermissions	Сведения о разрешениях.
metadataQuery	Сохраненный запрос.
metadataResourceType	Тип ресурса в Azure.
metadataResults	Ответ метаданных.
metadataSolution	Решение Log Analytics.
metadataTable	Таблица данных, которая участвует в схеме рабочей области.
metadataWorkspace	Рабочая область Log Analytics.
Related	Связанные элементы метаданных для категории
Resources	Указание разрешений для ресурсов Azure в запросе метаданных.
Workspaces	Указание разрешений для рабочих областей в запросе метаданных.

Applications

Указание разрешений для приложений Application Insights в запросе метаданных.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса в указании разрешения.

Columns

Список столбцов, определенных в таблице

Имя	Тип	Описание
description	string	Описание столбца
isPreferredFacet	boolean	Флаг, указывающий, что этот столбец является предпочтительным аспектом
name	string	Имя столбца
source	object	указание источника столбца, используемого только в том случае, если несколько рабочих областей имеют конфликтующие определения для столбца.
type	MetadataColumnDataType	Тип данных столбца

errorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalProperties	object	Дополнительные свойства, которые могут быть предоставлены в объекте сведений об ошибке
code	string	Код ошибки.
message	string	Удобочитаемое сообщение об ошибке.
resources	string[]	Указывает ресурсы, которые были ответственны за ошибку.
target	string	Указывает, какое свойство в запросе отвечает за ошибку.
value	string	Указывает, какое значение в target отвечает за ошибку.

errorInfo

Код и сообщение об ошибке.

Имя	Тип	Описание
additionalProperties	object	Дополнительные свойства, которые можно указать в объекте сведений об ошибке
code	string	Код ошибки, доступный для чтения компьютером.
details	errorDetail[]	сведения об ошибке.
innererror	errorInfo	Код и сообщение об ошибке. Сведения о внутренней ошибке, если они существуют.
message	string	Удобочитаемое сообщение об ошибке.

errorResponse

Сведения об ошибке.

Имя	Тип	Описание
error	errorInfo	Код и сообщение об ошибке. Сведения об ошибке.

metadataApplication

Приложение Application Insights.

Имя	Тип	Описание
id	string	Идентификатор приложения Application Insights.
name	string	Имя приложения Application Insights.
region	string	Регион Azure приложения Application Insights.
related	Related	Связанные элементы метаданных для приложения Application Insights.
resourceId	string	Идентификатор ресурса ARM приложения Application Insights.

metadataCategory

Категория метаданных.

Имя	Тип	Описание
description	string	Описание категории
displayName	string	Отображаемое имя категории
id	string	Идентификатор категории
related	Related	Связанные элементы метаданных для категории

MetadataColumnDataType

Тип данных столбца

Имя	Тип	Описание
bool	string
datetime	string
decimal	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string
timespan	string

metadataFunction

Хранимая функция.

Имя	Тип	Описание
body	string	Текст KQL функции.
description	string	Описание функции.
displayName	string	Отображаемое имя функции.
id	string	Идентификатор функции.
name	string	Имя функции, используемой в запросах.
parameters	string	Параметры или аргументы функции, если таковые есть.
properties	object	Свойства функции.
related	Related	Связанные элементы метаданных для функции.
tags	object	Теги, связанные с функцией.

metadataPermissions

Сведения о разрешениях.

Имя	Тип	Описание
applications	Applications[]	Указание разрешений для приложений Application Insights в запросе метаданных.
resources	Resources[]	Указание разрешений для ресурсов Azure в запросе метаданных.
workspaces	Workspaces[]	Указание разрешений для рабочих областей в запросе метаданных.

metadataQuery

Сохраненный запрос.

Имя	Тип	Описание
body	string	Текст KQL запроса.
description	string	Описание запроса.
displayName	string	Отображаемое имя запроса.
id	string	Идентификатор запроса.
labels	string[]	Определяемые пользователем метки, связанные с запросом.
properties	object	Свойства запроса.
related	Related	Связанные элементы метаданных для запроса.
tags	object	Теги, связанные с запросом.

metadataResourceType

Тип ресурса в Azure.

Имя	Тип	Описание
description	string	Описание типа ресурса
displayName	string	Отображаемое имя типа ресурса
id	string	Идентификатор типа ресурса
labels	string[]	Определяемые пользователем метки типа ресурса
properties	object	Свойства типа ресурса
related	Related	Связанные элементы метаданных для типа ресурса
tags	object	Теги, связанные с типом ресурса
type	string	Тип ресурса

metadataResults

Ответ метаданных.

Имя	Тип	Описание
applications	metadataApplication[]	Список приложений Application Insights, на которые были указаны ссылки в запросе метаданных.
categories	metadataCategory[]	Список категорий, на которые ссылается этот ответ метаданных.
functions	metadataFunction[]	Список функций, хранящихся в рабочей области или представленных решениями и т. д.
permissions	metadataPermissions[]	Список правил разрешений, которые повлияли на запрос метаданных.
queries	metadataQuery[]	Список сохраненных запросов, хранящихся в рабочей области или представленных решениями, типами ресурсов и т. д.
resourceTypes	metadataResourceType[]	Список типов ресурсов, на которые ссылается этот ответ метаданных.
resources	metadataResource[]	Список ресурсов Azure, на которые были указаны ссылки в запросе метаданных.
solutions	metadataSolution[]	Список решений Log Analytics, установленных в рабочей области.
tables	metadataTable[]	Список таблиц и столбцов, составляющих схему рабочей области.
workspaces	metadataWorkspace[]	Список рабочих областей Log Analytics, на которые были указаны ссылки в запросе метаданных.

metadataSolution

Решение Log Analytics.

Имя	Тип	Описание
description	string	Описание решения Log Analytics
displayName	string	Отображаемое имя решения Log Analytics
id	string	Идентификатор решения Log Analytics
name	string	Имя решения Log Analytics
properties	object	Свойства решения Log Analytics
related	Related	Связанные элементы метаданных для решения Log Analytics
tags	object	Теги, связанные с решением Log Analytics

metadataTable

Таблица данных, которая участвует в схеме рабочей области.

Имя	Тип	Описание
columns	Columns[]	Список столбцов, определенных в таблице
description	string	Описание таблицы
id	string	Идентификатор таблицы
labels	string[]	Определяемые пользователем метки таблицы
name	string	Имя таблицы.
properties	object	Свойства таблицы
related	Related	Связанные элементы метаданных для таблицы
tags	object	Теги, связанные с таблицей
timespanColumn	string	Столбец, связанный с параметром запроса timespan для таблицы

metadataWorkspace

Рабочая область Log Analytics.

Имя	Тип	Описание
id	string	Идентификатор рабочей области Log Analytics.
name	string	Имя рабочей области Log Analytics.
region	string	Регион Azure рабочей области Log Analytics.
related	Related	Связанные элементы метаданных для рабочей области Log Analytics.
resourceId	string	Идентификатор ресурса ARM рабочей области Log Analytics.

Связанные элементы метаданных для категории

Имя	Тип	Описание
functions	string[]	Функции, связанные с категорией
queries	string[]	Сохраненные запросы, связанные с категорией
resourceTypes	string[]	Типы ресурсов, связанные с категорией
solutions	string[]	Решения Log Analytics, связанные с категорией
tables	string[]	Таблицы, связанные с категорией

Resources

Указание разрешений для ресурсов Azure в запросе метаданных.

Имя	Тип	Описание
denyTables	string[]	Список таблиц, которым было отказано в доступе к идентификатору ресурса.
resourceId	string	Идентификатор ресурса в указании разрешения.

Workspaces

Указание разрешений для рабочих областей в запросе метаданных.

Имя	Тип	Описание
denyTables	string[]	Список таблиц, которым было отказано в доступе к идентификатору ресурса.
resourceId	string	Идентификатор ресурса в указании разрешения.

Поделиться через

Metadata - Post

Параметры URI

Ответы

Безопасность

oauth2

Области

Примеры

metadataPost

Образец запроса

Пример ответа

Определения

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Resources

Workspaces

Дополнительные ресурсы

Поделиться через

Metadata - Post

Параметры URI

Ответы

Безопасность

oauth2

Области

Примеры

metadataPost

Образец запроса

Пример ответа

Определения

Applications

Columns

errorDetail

errorInfo

errorResponse

metadataApplication

metadataCategory

MetadataColumnDataType

metadataFunction

metadataPermissions

metadataQuery

metadataResourceType

metadataResults

metadataSolution

metadataTable

metadataWorkspace

Related

Resources

Workspaces

Дополнительные ресурсы