Saved Searches - Create Or Update

Referenz

Dienst:: Log Analytics

API-Version:: 2023-09-01

Erstellt oder aktualisiert eine gespeicherte Suche für einen bestimmten Arbeitsbereich.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
savedSearchId	path	True	string	Die ID der gespeicherten Suche.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
workspaceName	path	True	string	Den Namen des Arbeitsbereichs RegEx-Muster: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.category	True	string	Die Kategorie der gespeicherten Suche. Dies hilft dem Benutzer, eine gespeicherte Suche schneller zu finden.
properties.displayName	True	string	Anzeigename der gespeicherten Suche.
properties.query	True	string	Der Abfrageausdruck für die gespeicherte Suche.
etag		string	Das ETag der gespeicherten Suche. Verwenden Sie "*" oder geben Sie das aktuelle Etag an, um eine vorhandene gespeicherte Suche zu überschreiben.
properties.functionAlias		string	Der Funktionsalias, wenn die Abfrage als Funktion dient.
properties.functionParameters		string	Die optionalen Funktionsparameter, wenn die Abfrage als Funktion dient. Der Wert sollte das folgende Format aufweisen: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. Weitere Beispiele und die richtige Syntax finden Sie unter https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
properties.tags		Tag[]	Die Tags, die der gespeicherten Suche angefügt sind.
properties.version		integer	Die Versionsnummer der Abfragesprache. Die aktuelle Version ist 2 und ist die Standardeinstellung.

Antworten

Name	Typ	Beschreibung
200 OK	SavedSearch	Ok-Antwortdefinition.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

SavedSearchCreateOrUpdate

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
SavedSearch	Wertobjekt für gespeicherte Suchergebnisse.
Tag	Ein Tag einer gespeicherten Suche.

SavedSearch

Wertobjekt für gespeicherte Suchergebnisse.

Name	Typ	Beschreibung
etag	string	Das ETag der gespeicherten Suche. Verwenden Sie "*" oder geben Sie das aktuelle Etag an, um eine vorhandene gespeicherte Suche zu überschreiben.
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.category	string	Die Kategorie der gespeicherten Suche. Dies hilft dem Benutzer, eine gespeicherte Suche schneller zu finden.
properties.displayName	string	Anzeigename der gespeicherten Suche.
properties.functionAlias	string	Der Funktionsalias, wenn die Abfrage als Funktion dient.
properties.functionParameters	string	Die optionalen Funktionsparameter, wenn die Abfrage als Funktion dient. Der Wert sollte das folgende Format aufweisen: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. Weitere Beispiele und die richtige Syntax finden Sie unter https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
properties.query	string	Der Abfrageausdruck für die gespeicherte Suche.
properties.tags	Tag[]	Die Tags, die der gespeicherten Suche angefügt sind.
properties.version	integer	Die Versionsnummer der Abfragesprache. Die aktuelle Version ist 2 und ist die Standardeinstellung.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

Tag

Ein Tag einer gespeicherten Suche.

Name	Typ	Beschreibung
name	string	Der Tagname.
value	string	Der Tagwert.

Freigeben über