Metadata - Post

Служба:: Log Analytics

Версия API:: v1

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

POST {endpoint}/{apiVersion}/workspaces/{workspaceId}/metadata

Параметры URI

Имя	В	Обязательно	Тип	Описание
apiVersion	path	True	string	Версия сервисного API.
endpoint	path	True	string (uri)	Конечная точка сервиса Log Analytics.
workspaceId	path	True	string	Основной идентификатор рабочего пространства запроса. Это идентификатор рабочего пространства из blade Properties в портале Azure.

Ответы

Имя	Тип	Описание
200 OK	MetadataResults	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

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

OAuth2Auth

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

Области

Имя	Описание
https://api.loganalytics.io/.default

Примеры

Metadata POST request

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

HTTP

POST {endpoint}/2018-04-20/workspaces/b438b4f6-912a-46d5-9cb1-b44069212abc/metadata

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

Код состояния:: 200

{
  "categories": [
    {
      "displayName": "Workloads",
      "id": "workloads",
      "related": {
        "tables": [
          "ADAssessmentRecommendation",
          "ADReplicationResult",
          "SQLAssessmentRecommendation",
          "WorkloadMonitoringPerf"
        ]
      }
    }
  ],
  "functions": [
    {
      "name": "dwad",
      "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",
      "displayName": "dasd",
      "id": "dwad",
      "related": {
        "solutions": [
          "ADAssessment"
        ],
        "workspaces": [
          "b438b4f6-912a-46d5-9cb1-b44069212abc"
        ]
      }
    }
  ],
  "resourceTypes": [
    {
      "type": "Microsoft.Compute/VirtualMachines",
      "displayName": "Virtual machines",
      "id": "microsoft.compute/virtualmachines",
      "related": {
        "tables": [
          "ADAssessmentRecommendation"
        ]
      }
    }
  ],
  "solutions": [
    {
      "name": "ADAssessment",
      "description": "Assess the risk and health of Active Directory environments.",
      "displayName": "Active Directory Health Check",
      "id": "ADAssessment",
      "related": {
        "functions": [
          "dwad"
        ],
        "tables": [
          "ADAssessmentRecommendation"
        ],
        "workspaces": [
          "b438b4f6-912a-46d5-9cb1-b44069212abc"
        ]
      }
    }
  ],
  "tables": [
    {
      "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",
      "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"
        }
      ],
      "id": "ADAssessmentRecommendation",
      "related": {
        "categories": [
          "workloads"
        ],
        "resourceTypes": [
          "microsoft.compute/virtualmachines"
        ],
        "solutions": [
          "ADAssessment"
        ]
      },
      "timespanColumn": "TimeGenerated"
    },
    {
      "name": "custom_CL",
      "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"
        }
      ],
      "id": "custom_CL",
      "related": {
        "workspaces": [
          "b438b4f6-912a-46d5-9cb1-b44069212abc"
        ]
      },
      "timespanColumn": "TimeGenerated"
    }
  ],
  "workspaces": [
    {
      "name": "contosoretail-IT",
      "id": "b438b4f6-912a-46d5-9cb1-b44069212abc",
      "region": "eastus",
      "related": {
        "functions": [
          "dwad"
        ],
        "resourceTypes": [
          "microsoft.compute/virtualmachines"
        ],
        "solutions": [
          "ADAssessment"
        ],
        "tables": [
          "custom_CL"
        ]
      },
      "resourceId": "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-IT"
    }
  ]
}

Определения

Имя	Описание
ColumnDataType	Тип данных столбца.
ErrorDetail	Сведения об ошибке.
ErrorInfo	Код и сообщение об ошибке.
ErrorResponse	Содержит сведения, когда код ответа указывает на ошибку.
MetadataApplication	Приложения Application Insights, которые входили в запрос метаданных и к которым пользователь имеет доступ.
MetadataApplicationRelated	Связанные метаданные для приложения Application Insights.
MetadataCategory	Категории используются для группировки других метаданных.
MetadataCategoryRelated	Связанные метаданные для категории
MetadataFunction	Функции — это хранящиеся запросы Кусто, которые можно задать как часть запросов с помощью их имени.
MetadataFunctionRelated	Связанные элементы метаданных для функции.
MetadataPermissions	Информация о разрешении для вызова метаданных включает приложения/рабочие пространства/ресурсы, к которым пользователю не было доступа.
MetadataPermissionsApplicationsItem	Указание разрешения для приложений Application Insights в запросе метаданных.
MetadataPermissionsResourcesItem	Указание разрешения для ресурсов Azure в запросе метаданных.
MetadataPermissionsWorkspacesItem	Указание разрешения рабочих пространств в запросе метаданных.
MetadataQuery	Запросы — это хранимые части KQL вместе со списком соответствующих метаданных.
MetadataQueryRelated	Связанные метаданные для запроса.
MetadataResourceType	Метаданные о типах ресурсов Azure, содержащие соответствующие таблицы, функции и т.д.
MetadataResourceTypeRelated	Связанные элементы метаданных для типа ресурса
MetadataResults	Ответ метаданных приложения, включая доступные таблицы и т.д.
MetadataSolution	Решения могут группировать таблицы и функции, связанные с определённым предложением Azure Log Analytics.
MetadataSolutionRelated	Связанные элементы метаданных для решения Log Analytics
MetadataTable	Таблицы являются частью схемы рабочего пространства и содержат список столбцов и ссылки на другие релевантные элементы метаданных.
MetadataTableColumnsItem	Столбец в таблице метаданных.
MetadataTableRelated	Связанные элементы метаданных для таблицы
MetadataWorkspace	Рабочие пространства Log Analytics, которые входили в запрос метаданных и к которым пользователь имеет доступ.
MetadataWorkspaceRelated	Связанные метаданные для рабочего пространства Log Analytics.

ColumnDataType

Перечисление

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

Значение	Описание
bool	тип данных Boolean
datetime	Тип данных DateTime
dynamic	Динамический тип данных
int	Целочисленные типы данных
long	Длинный целочисленный тип данных
real	Тип данных с реальной/плавающей запятой
string	строковый тип данных
guid	Тип данных GUID
decimal	Тип десятичных данных
timespan	Тип данных временного промежутка

ErrorDetail

Объект

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

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

ErrorInfo

Объект

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

Имя	Тип	Описание
additionalProperties		Дополнительные свойства, которые могут быть указаны на объекте информации об ошибке
code	string	Машиночитаемый код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
innererror	ErrorInfo	Детали внутренних ошибок, если они есть.
message	string	Удобочитаемое сообщение об ошибке.

ErrorResponse

Объект

Содержит сведения, когда код ответа указывает на ошибку.

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

MetadataApplication

Объект

Приложения Application Insights, которые входили в запрос метаданных и к которым пользователь имеет доступ.

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

MetadataApplicationRelated

Объект

Связанные метаданные для приложения Application Insights.

Имя	Тип	Описание
functions	string[]	Связанные функции приложения Application Insights.
tables	string[]	Связанные таблицы для приложения Application Insights.

MetadataCategory

Объект

Категории используются для группировки других метаданных.

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

MetadataCategoryRelated

Объект

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

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

MetadataFunction

Объект

Функции — это хранящиеся запросы Кусто, которые можно задать как часть запросов с помощью их имени.

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

MetadataFunctionRelated

Объект

Связанные элементы метаданных для функции.

Имя	Тип	Описание
categories	string[]	Связанные категории для функции.
resourceTypes	string[]	Связанные типы ресурсов для функции.
solutions	string[]	Связанные решения Log Analytics для функции.
tables	string[]	Связанные таблицы для функции.
workspaces	string[]	Связанные рабочие пространства для этой функции.

MetadataPermissions

Объект

Информация о разрешении для вызова метаданных включает приложения/рабочие пространства/ресурсы, к которым пользователю не было доступа.

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

MetadataPermissionsApplicationsItem

Объект

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

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

MetadataPermissionsResourcesItem

Объект

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

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

MetadataPermissionsWorkspacesItem

Объект

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

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

MetadataQuery

Объект

Запросы — это хранимые части KQL вместе со списком соответствующих метаданных.

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

MetadataQueryRelated

Объект

Связанные метаданные для запроса.

Имя	Тип	Описание
categories	string[]	Связанные категории запроса.
resourceTypes	string[]	Связанные типы ресурсов для запроса.
solutions	string[]	Связанные решения Log Analytics для запроса.
tables	string[]	Связанные таблицы для запроса.

MetadataResourceType

Объект

Метаданные о типах ресурсов Azure, содержащие соответствующие таблицы, функции и т.д.

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

MetadataResourceTypeRelated

Объект

Связанные элементы метаданных для типа ресурса

Имя	Тип	Описание
categories	string[]	Категории, связанные с типом ресурса
functions	string[]	Функции, связанные с типом ресурса
queries	string[]	Запросы, связанные с типом ресурса
resources	string[]	Ресурсы Azure, связанные с типом ресурса
tables	string[]	Таблицы, относящиеся к типу ресурса
workspaces	string[]	Рабочие пространства Log Analytics, связанные с типом ресурса

MetadataResults

Объект

Ответ метаданных приложения, включая доступные таблицы и т.д.

Имя	Тип	Описание
applications	MetadataApplication[]	Список приложений Application Insights, на которые ссылались в запросе метаданных.
categories	MetadataCategory[]	Список категорий, на которые ссылаются в этом ответе метаданных.
functions	MetadataFunction[]	Список функций, хранящихся в рабочем пространстве или введённых решениями и т.д.
permissions	MetadataPermissions[]	Список правил разрешений, повлиявших на запрос метаданных.
queries	MetadataQuery[]	Список сохранённых запросов, хранящихся в рабочем пространстве или вводящихся решениями, типами ресурсов и т.д.
resourceTypes	MetadataResourceType[]	Список типов ресурсов, на которые ссылаются в этом ответе метаданных.
resources	string[]	Список ресурсов Azure, на которые ссылались в запросе метаданных.
solutions	MetadataSolution[]	Список решений Log Analytics, установленных в рабочем пространстве.
tables	MetadataTable[]	Список таблиц и столбцов, составляющих схему рабочего пространства.
workspaces	MetadataWorkspace[]	Список рабочих пространств Log Analytics, на которые ссылались в запросе метаданных.

MetadataSolution

Объект

Решения могут группировать таблицы и функции, связанные с определённым предложением Azure Log Analytics.

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

MetadataSolutionRelated

Объект

Связанные элементы метаданных для решения Log Analytics

Имя	Тип	Описание
categories	string[]	Категории, связанные с решением Log Analytics
functions	string[]	Функции, связанные с решением Log Analytics
queries	string[]	Сохранённые запросы, связанные с решением Log Analytics
tables	string[]	Таблицы, связанные с решением Log Analytics
workspaces	string[]	Рабочие пространства, на которые ссылаются в запросе метаданных, связанные с решением Log Analytics

MetadataTable

Объект

Таблицы являются частью схемы рабочего пространства и содержат список столбцов и ссылки на другие релевантные элементы метаданных.

Имя	Тип	Описание
columns	MetadataTableColumnsItem[]	Список столбцов, определённых в таблице
description	string	Описание таблицы
id	string	ID таблицы
labels	string[]	Пользовательские метки таблицы
name	string	Название таблицы
properties		Свойства таблицы
related	MetadataTableRelated	Связанные элементы метаданных для таблицы
tags	object	Теги, связанные с таблицей
timespanColumn	string	Столбец, связанный с параметром запроса временного интервала для таблицы

MetadataTableColumnsItem

Объект

Столбец в таблице метаданных.

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

MetadataTableRelated

Объект

Связанные элементы метаданных для таблицы

Имя	Тип	Описание
categories	string[]	Связанные категории для таблицы
functions	string[]	Связанные функции таблицы
queries	string[]	Связанные сохранённые запросы для таблицы
resourceTypes	string[]	Связанные типы ресурсов для таблицы
solutions	string[]	Связанные решения Log Analytics для таблицы
workspaces	string[]	Связанные рабочие пространства Log Analytics для таблицы

MetadataWorkspace

Объект

Рабочие пространства Log Analytics, которые входили в запрос метаданных и к которым пользователь имеет доступ.

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

MetadataWorkspaceRelated

Объект

Связанные метаданные для рабочего пространства Log Analytics.

Имя	Тип	Описание
functions	string[]	Связанные функции для рабочего пространства Log Analytics.
resourceTypes	string[]	Связанные типы ресурсов для рабочего пространства Log Analytics.
resources	string[]	Связанные ресурсы Azure для рабочего пространства Log Analytics.
solutions	string[]	Связанные решения Log Analytics для рабочего пространства Log Analytics.
tables	string[]	Связанные таблицы для рабочего пространства Log Analytics.