Saved Searches - Create Or Update

Ссылка

Служба:: Log Analytics

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

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}?api-version=2023-09-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
savedSearchId	path	True	string	Идентификатор сохраненного поиска.
subscriptionId	path	True	string	Идентификатор целевой подписки.
workspaceName	path	True	string	имя рабочей области; Шаблон регулярного выражения: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Версия API, используемая для данной операции.

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

Имя	Обязательно	Тип	Описание
properties.category	True	string	Категория сохраненного поиска. Это помогает пользователю быстрее находить сохраненный поиск.
properties.displayName	True	string	Сохраненное отображаемое имя поиска.
properties.query	True	string	Выражение запроса для сохраненного поиска.
etag		string	ETag сохраненного поиска. Чтобы переопределить существующий сохраненный поиск, используйте "*" или укажите текущий Etag.
properties.functionAlias		string	Псевдоним функции, если запрос выступает в качестве функции.
properties.functionParameters		string	Необязательные параметры функции, если запрос выступает в качестве функции. Значение должно иметь следующий формат: "param-name1:type1 = default_value1, param-name2:type2 = default_value2". Дополнительные примеры и правильный синтаксис см. в https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functionsразделе .
properties.tags		Tag[]	Теги, присоединенные к сохраненному поиску.
properties.version		integer	Номер версии языка запросов. Текущая версия — 2 и является версией по умолчанию.

Ответы

Имя	Тип	Описание
200 OK	SavedSearch	Определение ответа OK.

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Области

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

Примеры

SavedSearchCreateOrUpdate

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

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/TestRG/providers/Microsoft.OperationalInsights/workspaces/TestWS/savedSearches/00000000-0000-0000-0000-00000000000?api-version=2023-09-01

{
  "properties": {
    "category": "Saved Search Test Category",
    "displayName": "Create or Update Saved Search Test",
    "version": 2,
    "functionAlias": "heartbeat_func",
    "functionParameters": "a:int=1",
    "query": "Heartbeat | summarize Count() by Computer | take a",
    "tags": [
      {
        "name": "Group",
        "value": "Computer"
      }
    ]
  }
}

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

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

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/AtlantisDemo/savedSearches/test-new-saved-search-id-2015",
  "etag": "W/\"datetime'2017-10-02T23%3A15%3A41.0709875Z'\"",
  "properties": {
    "category": "Saved Search Test Category",
    "displayName": "Create or Update Saved Search Test",
    "functionAlias": "heartbeat_func",
    "functionParameters": "a:int=1",
    "query": "Heartbeat | summarize Count() by Computer | take a",
    "version": 2
  }
}

Определения

Имя	Описание
SavedSearch	Объект Value для сохраненных результатов поиска.
Tag	Тег сохраненного поиска.

SavedSearch

Объект Value для сохраненных результатов поиска.

Имя	Тип	Описание
etag	string	ETag сохраненного поиска. Чтобы переопределить существующий сохраненный поиск, используйте "*" или укажите текущий Etag.
id	string	Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса.
properties.category	string	Категория сохраненного поиска. Это помогает пользователю быстрее находить сохраненный поиск.
properties.displayName	string	Сохраненное отображаемое имя поиска.
properties.functionAlias	string	Псевдоним функции, если запрос выступает в качестве функции.
properties.functionParameters	string	Необязательные параметры функции, если запрос выступает в качестве функции. Значение должно иметь следующий формат: "param-name1:type1 = default_value1, param-name2:type2 = default_value2". Дополнительные примеры и правильный синтаксис см. в https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functionsразделе .
properties.query	string	Выражение запроса для сохраненного поиска.
properties.tags	Tag[]	Теги, присоединенные к сохраненному поиску.
properties.version	integer	Номер версии языка запросов. Текущая версия — 2 и является версией по умолчанию.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

Tag

Тег сохраненного поиска.

Имя	Тип	Описание
name	string	Имя тега.
value	string	Значение тега.

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