Query Pack Queries - Search

Служба:: Monitor

Версия API:: 2019-09-01

Выполните поиск по списку запросов, определенных в Log Analytics QueryPack в соответствии с заданными свойствами поиска.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries/search?api-version=2019-09-01

С использованием необязательных параметров:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries/search?api-version=2019-09-01&$top={$top}&includeBody={includeBody}&$skipToken={$skipToken}

Параметры URI

Имя	В	Обязательно	Тип	Описание
queryPackName	path	True	string	Имя ресурса Log Analytics QueryPack.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.
$skipToken	query		string	Токен в кодировке Base64, используемый для получения следующей страницы элементов. Значение по умолчанию равно NULL.
$top	query		integer (int64)	Максимальное количество элементов, возвращаемых на странице.
includeBody	query		boolean	Флаг, указывающий, следует ли возвращать текст каждого применимого запроса. Если значение false, возвращаются только сведения о запросе.

Текст запроса

Имя	Тип	Описание
related	Related	Связанные элементы метаданных для функции.
tags	object	Теги, связанные с запросом.

Ответы

Имя	Тип	Описание
200 OK	LogAnalyticsQueryPackQueryListResult	Список, содержащий 0 или более запросов, содержащихся в Log Analytics QueryPack.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

QuerySearch

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

HTTP

POST https://management.azure.com/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/Microsoft.OperationalInsights/queryPacks/my-querypack/queries/search?api-version=2019-09-01&$top=3&includeBody=True

{
  "related": {
    "categories": [
      "other",
      "analytics"
    ]
  },
  "tags": {
    "my-label": [
      "label1"
    ]
  }
}

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

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

{
  "value": [
    {
      "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/microsoft.operationalinsights/queryPacks/my-querypack/queries/4337bb16-d6fe-4ff7-97cf-59df25941476",
      "name": "4337bb16-d6fe-4ff7-97cf-59df25941476",
      "type": "microsoft.operationalinsights/queryPacks/queries",
      "systemData": {
        "createdBy": "string",
        "createdByType": "application",
        "createdAt": "2020-02-03T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "application",
        "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
      },
      "properties": {
        "id": "4337bb16-d6fe-4ff7-97cf-59df25941476",
        "timeCreated": "2019-08-15T10:29:56.1030254Z",
        "author": "1809f206-263a-46f7-942d-4572c156b7e7",
        "timeModified": "2019-08-15T10:29:56.1030254Z",
        "displayName": "Heartbeat_1",
        "description": "Thie query takes 10 entries of heartbeat 0",
        "body": "Heartbeat | take 1",
        "related": {
          "categories": [
            "other"
          ]
        },
        "tags": {
          "my-label": [
            "label1"
          ],
          "my-other-label": [
            "label2"
          ]
        }
      }
    },
    {
      "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/microsoft.operationalinsights/queryPacks/my-querypack/queries/bf015bf7-be70-49c2-8d52-4cce85c42ef1",
      "name": "bf015bf7-be70-49c2-8d52-4cce85c42ef1",
      "type": "microsoft.operationalinsights/queryPacks/queries",
      "systemData": {
        "createdBy": "string",
        "createdByType": "application",
        "createdAt": "2020-02-03T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "application",
        "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
      },
      "properties": {
        "id": "bf015bf7-be70-49c2-8d52-4cce85c42ef1",
        "timeCreated": "2019-08-15T10:30:26.7943629Z",
        "author": "1809f206-263a-46f7-942d-4572c156b7e7",
        "timeModified": "2019-08-15T10:30:26.7943629Z",
        "displayName": "Heartbeat_2",
        "description": "Thie query takes 10 entries of heartbeat 1",
        "body": "Heartbeat | take 1",
        "related": {
          "categories": [
            "analytics"
          ]
        },
        "tags": {
          "my-label": [
            "label1"
          ],
          "my-other-label": [
            "label2"
          ]
        }
      }
    },
    {
      "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/microsoft.operationalinsights/queryPacks/my-querypack/queries/8d91c6ca-9c56-49c6-b3ae-112a68871acd",
      "name": "8d91c6ca-9c56-49c6-b3ae-112a68871acd",
      "type": "microsoft.operationalinsights/queryPacks/queries",
      "systemData": {
        "createdBy": "string",
        "createdByType": "application",
        "createdAt": "2020-02-03T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "application",
        "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
      },
      "properties": {
        "id": "8d91c6ca-9c56-49c6-b3ae-112a68871acd",
        "timeCreated": "2019-08-15T10:30:29.4505584Z",
        "author": "1809f206-263a-46f7-942d-4572c156b7e7",
        "timeModified": "2019-08-15T10:30:29.4505584Z",
        "displayName": "Heartbeat_3",
        "description": "Thie query takes 10 entries of heartbeat 2",
        "body": "Heartbeat | take 1",
        "related": {
          "categories": [
            "other",
            "analytics"
          ]
        },
        "tags": {
          "my-label": [
            "label1"
          ],
          "my-other-label": [
            "label2"
          ]
        }
      }
    }
  ],
  "nextLink": null
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
IdentityType	Тип удостоверения, создающего или изменяющего ресурсы
LogAnalyticsQueryPackQuery	Определение QueryPack-Query Log Analytics.
LogAnalyticsQueryPackQueryListResult	Описывает список ресурсов Log Analytics QueryPack-Query.
LogAnalyticsQueryPackQuerySearchProperties	Свойства, определяющие свойства поиска Log Analytics QueryPack-Query.
Related	Связанные элементы метаданных для функции.
SystemData	Чтение только системных данных

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

IdentityType

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

Тип удостоверения, создающего или изменяющего ресурсы

Значение	Описание
user
application
managedIdentity
key

LogAnalyticsQueryPackQuery

Object

Определение QueryPack-Query Log Analytics.

Имя	Тип	Описание
id	string	Идентификатор ресурса Azure
name	string	Имя ресурса Azure
properties.author	string	Идентификатор объекта пользователя, создающего запрос.
properties.body	string	Текст запроса.
properties.description	string	Описание запроса.
properties.displayName	string	Уникальное отображаемое имя запроса в пакете запросов.
properties.id	string	Уникальный идентификатор приложения. Это поле нельзя изменить.
properties.properties	object	Дополнительные свойства, которые можно задать для запроса.
properties.related	Related	Связанные элементы метаданных для функции.
properties.tags	object	Теги, связанные с запросом.
properties.timeCreated	string (date-time)	Дата создания запроса Log Analytics в формате ISO 8601.
properties.timeModified	string (date-time)	Дата последнего изменения запроса Log Analytics в формате ISO 8601.
systemData	SystemData	Чтение только системных данных
type	string	Тип ресурса Azure

LogAnalyticsQueryPackQueryListResult

Object

Описывает список ресурсов Log Analytics QueryPack-Query.

Имя	Тип	Описание
nextLink	string	URI для получения следующего набора определений QueryPack Log Analytics, если слишком много QueryPack-Queries, где возвращается в результирующем наборе.
value	LogAnalyticsQueryPackQuery[]	Список определений запросов Log Analytics QueryPack.

LogAnalyticsQueryPackQuerySearchProperties

Object

Свойства, определяющие свойства поиска Log Analytics QueryPack-Query.

Имя	Тип	Описание
related	Related	Связанные элементы метаданных для функции.
tags	object	Теги, связанные с запросом.

Object

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

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

SystemData

Object

Чтение только системных данных

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC)
createdBy	string	Идентификатор удостоверения, создавшего ресурс
createdByType	IdentityType	Тип удостоверения, создавшего ресурс
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор удостоверения, который последний раз изменил ресурс
lastModifiedByType	IdentityType	Тип удостоверения, который последний раз изменил ресурс

Query Pack Queries - Search

Параметры URI

Текст запроса

Ответы

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

azure_auth

Области

Примеры

QuerySearch

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

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

Определения

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityType

LogAnalyticsQueryPackQuery

LogAnalyticsQueryPackQueryListResult

LogAnalyticsQueryPackQuerySearchProperties

Related

SystemData