Saved Searches - Create Or Update

Referência

Serviço:: Log Analytics

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

Cria ou atualiza uma pesquisa salva para um determinado workspace.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
savedSearchId	path	True	string	A ID da pesquisa salva.
subscriptionId	path	True	string	A ID da assinatura de destino.
workspaceName	path	True	string	O nome do workspace. 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 ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.category	True	string	A categoria da pesquisa salva. Isso ajuda o usuário a encontrar uma pesquisa salva mais rapidamente.
properties.displayName	True	string	Nome de exibição de pesquisa salvo.
properties.query	True	string	A expressão de consulta para a pesquisa salva.
etag		string	A ETag da pesquisa salva. Para substituir uma pesquisa salva existente, use "*" ou especifique a Etag atual
properties.functionAlias		string	O alias da 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, consulte https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
properties.tags		Tag[]	As marcas anexadas à pesquisa salva.
properties.version		integer	O número de versão da linguagem de consulta. A versão atual é 2 e é o padrão.

Respostas

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

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

SavedSearchCreateOrUpdate

Solicitação de exemplo

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 de exemplo

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

Nome	Description
SavedSearch	Objeto Value para resultados de pesquisa salvos.
Tag	Uma marca de uma pesquisa salva.

SavedSearch

Objeto Value para resultados de pesquisa salvos.

Nome	Tipo	Description
etag	string	A ETag da pesquisa salva. Para substituir uma pesquisa salva existente, use "*" ou especifique a Etag atual
id	string	ID de recurso totalmente qualificada 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 salva. Isso ajuda o usuário a encontrar uma pesquisa salva mais rapidamente.
properties.displayName	string	Nome de exibição de pesquisa salvo.
properties.functionAlias	string	O alias da 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, consulte https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
properties.query	string	A expressão de consulta para a pesquisa salva.
properties.tags	Tag[]	As marcas anexadas à pesquisa salva.
properties.version	integer	O número de versão da linguagem de consulta. A versão atual é 2 e é o padrão.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

Tag

Uma marca de uma pesquisa salva.

Nome	Tipo	Description
name	string	O nome da marcação.
value	string	O valor da marcação.

Compartilhar via