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 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。 名稱不區分大小寫。
savedSearchId	path	True	string	已儲存搜尋的標識碼。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
workspaceName	path	True	string	工作區的名稱。 Regex 模式: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
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，預設值為 。

回應

名稱	類型	Description
200 OK	SavedSearch	確定回應定義。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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
  }
}

定義

名稱	Description
SavedSearch	儲存搜尋結果的值物件。
Tag	已儲存搜尋的標籤。

SavedSearch

儲存搜尋結果的值物件。

名稱	類型	Description
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

已儲存搜尋的標籤。

名稱	類型	Description
name	string	標記名稱。
value	string	標籤值。