Saved Searches - Create Or Update

Référence

Service:: Log Analytics

Version d'API:: 2023-09-01

Crée ou met à jour une recherche enregistrée pour un espace de travail donné.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
savedSearchId	path	True	string	ID de la recherche enregistrée.
subscriptionId	path	True	string	ID de l’abonnement cible.
workspaceName	path	True	string	Nom de l’espace de travail. Modèle d’expression régulière: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.category	True	string	Catégorie de la recherche enregistrée. Cela permet à l’utilisateur de trouver une recherche enregistrée plus rapidement.
properties.displayName	True	string	Nom d’affichage de la recherche enregistrée.
properties.query	True	string	Expression de requête pour la recherche enregistrée.
etag		string	ETag de la recherche enregistrée. Pour remplacer une recherche enregistrée existante, utilisez « * » ou spécifiez l’Etag actuel
properties.functionAlias		string	Alias de fonction si la requête sert de fonction.
properties.functionParameters		string	Paramètres de fonction facultatifs si la requête sert de fonction. La valeur doit être au format suivant : 'param-name1 :type1 = default_value1, param-name2 :type2 = default_value2'. Pour obtenir d’autres exemples et la syntaxe appropriée, reportez-vous à https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
properties.tags		Tag[]	Balises attachées à la recherche enregistrée.
properties.version		integer	Numéro de version du langage de requête. La version actuelle est 2 et est la valeur par défaut.

Réponses

Nom	Type	Description
200 OK	SavedSearch	Définition de réponse OK.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

SavedSearchCreateOrUpdate

Exemple de requête

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

Exemple de réponse

Code d’état:: 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
  }
}

Définitions

Nom	Description
SavedSearch	Objet Value pour les résultats de recherche enregistrés.
Tag	Balise d’une recherche enregistrée.

SavedSearch

Objet Value pour les résultats de recherche enregistrés.

Nom	Type	Description
etag	string	ETag de la recherche enregistrée. Pour remplacer une recherche enregistrée existante, utilisez « * » ou spécifiez l’Etag actuel
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nom de la ressource.
properties.category	string	Catégorie de la recherche enregistrée. Cela permet à l’utilisateur de trouver une recherche enregistrée plus rapidement.
properties.displayName	string	Nom d’affichage de la recherche enregistrée.
properties.functionAlias	string	Alias de fonction si la requête sert de fonction.
properties.functionParameters	string	Paramètres de fonction facultatifs si la requête sert de fonction. La valeur doit être au format suivant : 'param-name1 :type1 = default_value1, param-name2 :type2 = default_value2'. Pour obtenir d’autres exemples et la syntaxe appropriée, reportez-vous à https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
properties.query	string	Expression de requête pour la recherche enregistrée.
properties.tags	Tag[]	Balises attachées à la recherche enregistrée.
properties.version	integer	Numéro de version du langage de requête. La version actuelle est 2 et est la valeur par défaut.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

Tag

Balise d’une recherche enregistrée.

Nom	Type	Description
name	string	Nom de la balise.
value	string	Valeur de la balise.

Partager via