Set-AzOperationalInsightsSavedSearch
Updates a saved search that already exists.
Syntax
Default (Default)
Set-AzOperationalInsightsSavedSearch
[-ResourceGroupName] <String>
[-WorkspaceName] <String>
[-SavedSearchId] <String>
[-DisplayName] <String>
[-Category] <String>
[-Query] <String>
[[-Tag] <Hashtable>]
[[-Version] <Int64>]
[[-ETag] <String>]
[[-FunctionAlias] <String>]
[[-FunctionParameter] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Set-AzOperationalInsightsSavedSearch cmdlet updates a saved search that already exists.
Examples
Example 1: Sets a saved search with updated properties
Set-AzOperationalInsightsSavedSearch -ResourceGroupName "ContosoResourceGroup" -WorkspaceName "ContosoWorkspace" -SavedSearchId "ContosoSavedSearchId" -DisplayName "ContosoSavedSearchDisplayName" -Category "ContosoSavedSearchCategory" -Query "Type=Event" -Version 1 -ETag "ContosoSavedSearchEtag"
This command sets a saved search with updated properties.
Parameters
-Category
Specifies the category name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 4 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DisplayName
Specifies the display name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 3 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ETag
Specifies the ETag name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 8 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-FunctionAlias
The function alias if query serves as a function.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 9 Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-FunctionParameter
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://learn.microsoft.com/azure/kusto/query/functions/user-defined-functions .
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: FunctionParameters
Parameter sets
(All)
Position: 10 Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Query
Specifies the query name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 5 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceGroupName
Specifies the resource group name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-SavedSearchId
Specifies the saved search ID.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 2 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Tag
The saved search tags.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 6 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Version
The Set-AzOperationalInsightsSavedSearch cmdlet updates a saved search that already exists.
Parameter properties
Type: Int64
Default value: 1 Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 7 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-WorkspaceName
Specifies the workspace name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: Name
Parameter sets
(All)
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
