Saved Searches - Create Or Update

Referens

Tjänst:: Log Analytics

API-version:: 2023-09-01

Skapar eller uppdaterar en sparad sökning efter en viss arbetsyta.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
savedSearchId	path	True	string	ID:t för den sparade sökningen.
subscriptionId	path	True	string	ID för målprenumerationen.
workspaceName	path	True	string	Namnet på arbetsytan. Reguljärt uttrycksmönster: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.category	True	string	Kategorin för den sparade sökningen. Detta hjälper användaren att hitta en sparad sökning snabbare.
properties.displayName	True	string	Sparat sökvisningsnamn.
properties.query	True	string	Frågeuttrycket för den sparade sökningen.
etag		string	ETag för den sparade sökningen. Om du vill åsidosätta en befintlig sparad sökning använder du "*" eller anger aktuell Etag
properties.functionAlias		string	Funktionsaliaset om frågan fungerar som en funktion.
properties.functionParameters		string	De valfria funktionsparametrarna om frågan fungerar som en funktion. Värdet ska ha följande format: "param-name1:type1 = default_value1, param-name2:type2 = default_value2". Fler exempel och korrekt syntax finns i https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
properties.tags		Tag[]	Taggarna som är kopplade till den sparade sökningen.
properties.version		integer	Frågespråkets versionsnummer. Den aktuella versionen är 2 och är standard.

Svar

Name	Typ	Description
200 OK	SavedSearch	OK svarsdefinition.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

SavedSearchCreateOrUpdate

Exempelbegäran

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"
      }
    ]
  }
}

Exempelsvar

Statuskod:: 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
  }
}

Definitioner

Name	Description
SavedSearch	Värdeobjekt för sparade sökresultat.
Tag	En tagg för en sparad sökning.

SavedSearch

Värdeobjekt för sparade sökresultat.

Name	Typ	Description
etag	string	ETag för den sparade sökningen. Om du vill åsidosätta en befintlig sparad sökning använder du "*" eller anger aktuell Etag
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.category	string	Kategorin för den sparade sökningen. Detta hjälper användaren att hitta en sparad sökning snabbare.
properties.displayName	string	Sparat sökvisningsnamn.
properties.functionAlias	string	Funktionsaliaset om frågan fungerar som en funktion.
properties.functionParameters	string	De valfria funktionsparametrarna om frågan fungerar som en funktion. Värdet ska ha följande format: "param-name1:type1 = default_value1, param-name2:type2 = default_value2". Fler exempel och korrekt syntax finns i https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
properties.query	string	Frågeuttrycket för den sparade sökningen.
properties.tags	Tag[]	Taggarna som är kopplade till den sparade sökningen.
properties.version	integer	Frågespråkets versionsnummer. Den aktuella versionen är 2 och är standard.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

Tag

En tagg för en sparad sökning.

Name	Typ	Description
name	string	Taggnamnet.
value	string	Taggvärdet.

Dela via