Saved Searches - Create Or Update
特定のワークスペースの保存された検索を作成または更新します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/savedSearches/{savedSearchId}?api-version=2023-09-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
saved
|
path | True |
string |
保存された検索の ID。 |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
workspace
|
path | True |
string |
ワークスペースの名前。 正規表現パターン: |
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 |
OK 応答の定義。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
SavedSearchCreateOrUpdate
要求のサンプル
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"
}
]
}
}
応答のサンプル
{
"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
}
}
定義
名前 | 説明 |
---|---|
Saved |
保存された検索結果の値オブジェクト。 |
Tag |
保存された検索のタグ。 |
SavedSearch
保存された検索結果の値オブジェクト。
名前 | 型 | 説明 |
---|---|---|
etag |
string |
保存された検索の ETag。 既存の保存された検索をオーバーライドするには、"*" を使用するか、現在の Etag を指定します |
id |
string |
リソースの完全修飾リソース ID。 例 - /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 |
タグ値です。 |