Saved Searches - Create Or Update

Referência

Serviço:: Log Analytics

Versão da API:: 2023-09-01

Cria ou atualiza uma pesquisa guardada para uma determinada área de trabalho.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
savedSearchId	path	True	string	O ID da pesquisa guardada.
subscriptionId	path	True	string	O ID da subscrição de destino.
workspaceName	path	True	string	O nome da área de trabalho. Padrão Regex: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.category	True	string	A categoria da pesquisa guardada. Isto ajuda o utilizador a encontrar uma pesquisa guardada mais rapidamente.
properties.displayName	True	string	Nome a apresentar da pesquisa guardado.
properties.query	True	string	A expressão de consulta da pesquisa guardada.
etag		string	O ETag da pesquisa guardada. Para substituir uma pesquisa guardada existente, utilize "*" ou especifique o Etag atual
properties.functionAlias		string	O alias de função se a consulta servir como uma função.
properties.functionParameters		string	Os parâmetros de função opcionais se a consulta servir como uma função. O valor deve estar no seguinte formato: "param-name1:type1 = default_value1, param-name2:type2 = default_value2". Para obter mais exemplos e sintaxe adequada, veja https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
properties.tags		Tag[]	As etiquetas anexadas à pesquisa guardada.
properties.version		integer	O número da versão da linguagem de consulta. A versão atual é 2 e é a predefinição.

Respostas

Name	Tipo	Description
200 OK	SavedSearch	Definição de resposta OK.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

SavedSearchCreateOrUpdate

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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
  }
}

Definições

Name	Description
SavedSearch	Objeto de valor para resultados de pesquisa guardados.
Tag	Uma etiqueta de uma pesquisa guardada.

SavedSearch

Objeto de valor para resultados de pesquisa guardados.

Name	Tipo	Description
etag	string	O ETag da pesquisa guardada. Para substituir uma pesquisa guardada existente, utilize "*" ou especifique o Etag atual
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.category	string	A categoria da pesquisa guardada. Isto ajuda o utilizador a encontrar uma pesquisa guardada mais rapidamente.
properties.displayName	string	Nome a apresentar da pesquisa guardado.
properties.functionAlias	string	O alias de função se a consulta servir como uma função.
properties.functionParameters	string	Os parâmetros de função opcionais se a consulta servir como uma função. O valor deve estar no seguinte formato: "param-name1:type1 = default_value1, param-name2:type2 = default_value2". Para obter mais exemplos e sintaxe adequada, veja https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
properties.query	string	A expressão de consulta da pesquisa guardada.
properties.tags	Tag[]	As etiquetas anexadas à pesquisa guardada.
properties.version	integer	O número da versão da linguagem de consulta. A versão atual é 2 e é a predefinição.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

Tag

Uma etiqueta de uma pesquisa guardada.

Name	Tipo	Description
name	string	O nome da etiqueta.
value	string	O valor da etiqueta.

Partilhar via