Saved Searches - Create Or Update

Referencia

Servicio:: Log Analytics

Versión de la API:: 2023-09-01

Crea o actualiza una búsqueda guardada para un área de trabajo determinada.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
savedSearchId	path	True	string	Identificador de la búsqueda guardada.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
workspaceName	path	True	string	El nombre del área de trabajo. Patrón de Regex: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.category	True	string	Categoría de la búsqueda guardada. Esto ayuda al usuario a encontrar una búsqueda guardada más rápido.
properties.displayName	True	string	Nombre para mostrar de búsqueda guardado.
properties.query	True	string	Expresión de consulta para la búsqueda guardada.
etag		string	ETag de la búsqueda guardada. Para invalidar una búsqueda guardada existente, use "*" o especifique la Etag actual.
properties.functionAlias		string	Alias de función si la consulta actúa como una función.
properties.functionParameters		string	Parámetros de función opcionales si la consulta actúa como una función. El valor debe tener el siguiente formato: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. Para obtener más ejemplos y la sintaxis adecuada, consulte https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
properties.tags		Tag[]	Etiquetas adjuntas a la búsqueda guardada.
properties.version		integer	Número de versión del lenguaje de consulta. La versión actual es 2 y es la predeterminada.

Respuestas

Nombre	Tipo	Description
200 OK	SavedSearch	Definición de respuesta correcta.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

SavedSearchCreateOrUpdate

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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
  }
}

Definiciones

Nombre	Description
SavedSearch	Objeto value para los resultados de búsqueda guardados.
Tag	Etiqueta de una búsqueda guardada.

SavedSearch

Objeto value para los resultados de búsqueda guardados.

Nombre	Tipo	Description
etag	string	ETag de la búsqueda guardada. Para invalidar una búsqueda guardada existente, use "*" o especifique la Etag actual.
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.category	string	Categoría de la búsqueda guardada. Esto ayuda al usuario a encontrar una búsqueda guardada más rápido.
properties.displayName	string	Nombre para mostrar de búsqueda guardado.
properties.functionAlias	string	Alias de función si la consulta actúa como una función.
properties.functionParameters	string	Parámetros de función opcionales si la consulta actúa como una función. El valor debe tener el siguiente formato: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. Para obtener más ejemplos y la sintaxis adecuada, consulte https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
properties.query	string	Expresión de consulta para la búsqueda guardada.
properties.tags	Tag[]	Etiquetas adjuntas a la búsqueda guardada.
properties.version	integer	Número de versión del lenguaje de consulta. La versión actual es 2 y es la predeterminada.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

Tag

Etiqueta de una búsqueda guardada.

Nombre	Tipo	Description
name	string	El nombre de la etiqueta.
value	string	Valor de etiqueta.

Compartir a través de