Share via

SavedSearch interface

  • Reference
Package:
@azure/arm-operationalinsights

Value object for saved search results.

Extends
ProxyResource

Properties

category

The category of the saved search. This helps the user to find a saved search faster.
displayName

Saved search display name.
etag

The ETag of the saved search. To override an existing saved search, use "*" or specify the current Etag
functionAlias

The function alias if query serves as a function.
functionParameters

The optional function parameters if query serves as a function. Value should be in the following format: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. For more examples and proper syntax please refer to https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.
query

The query expression for the saved search.
tags

The tags attached to the saved search.
version

The version number of the query language. The current version is 2 and is the default.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

category

The category of the saved search. This helps the user to find a saved search faster.

category: string

Property Value

string

displayName

Saved search display name.

displayName: string

Property Value

string

etag

The ETag of the saved search. To override an existing saved search, use "*" or specify the current Etag

etag?: string

Property Value

string

functionAlias

The function alias if query serves as a function.

functionAlias?: string

Property Value

string

functionParameters

The optional function parameters if query serves as a function. Value should be in the following format: 'param-name1:type1 = default_value1, param-name2:type2 = default_value2'. For more examples and proper syntax please refer to https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.

functionParameters?: string

Property Value

string

query

The query expression for the saved search.

query: string

Property Value

string

tags

The tags attached to the saved search.

tags?: Tag[]

Property Value

Tag[]

version

The version number of the query language. The current version is 2 and is the default.

version?: number

Property Value

number

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type