Set-AzOperationalInsightsSavedSearch
Updates a saved search that already exists.
Syntax
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.
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisplayName
Specifies the display name.
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ETag
Specifies the ETag name.
| Type: | String |
| Position: | 8 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FunctionAlias
The function alias if query serves as a function.
| Type: | String |
| Position: | 9 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String |
| Aliases: | FunctionParameters |
| Position: | 10 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Query
Specifies the query name.
| Type: | String |
| Position: | 5 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the resource group name.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SavedSearchId
Specifies the saved search ID.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Tag
The saved search tags.
| Type: | Hashtable |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Version
| Type: | Int64 |
| Position: | 7 |
| Default value: | 1 |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WorkspaceName
Specifies the workspace name.
| Type: | String |
| Aliases: | Name |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |